Package org.goplanit.io.converter.zoning

Class PlanitZoningReaderFactory

java.lang.Object

org.goplanit.io.converter.zoning.PlanitZoningReaderFactory

public class PlanitZoningReaderFactory
extends Object

Factory class for creating zoning reader in the native PLANit format

Author:

markr

Constructor Summary

Constructors

Constructor	Description
PlanitZoningReaderFactory()

Method Summary

Modifier and Type	Method	Description
static PlanitZoningReader	create()	Factory method wit all default, expected that user configures the settings afterwards to reach minimum requirements for successful parsing (input dir especially)
static PlanitZoningReader	create(String pathDirectory, String xmlFileExtension, TransportLayerNetwork<?,?> network, Zoning zoning)	Factory method
static PlanitZoningReader	create(PlanitZoningReaderSettings zoningSettings, TransportLayerNetwork<?,?> referenceNetwork, Zoning zoningToPopulate)	Factory method
static PlanitZoningReader	create(org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning, TransportLayerNetwork<?,?> network, Zoning zoning)	Factory method where file has already been parsed and we only need to convert from raw XML objects to PLANit memory model

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlanitZoningReaderFactory

public PlanitZoningReaderFactory()

Method Detail

create

public static PlanitZoningReader create()
                                 throws PlanItException

Factory method wit all default, expected that user configures the settings afterwards to reach minimum requirements for successful parsing (input dir especially)

Returns:

created PLANit zoning reader

Throws:

PlanItException - thrown if error

create

public static PlanitZoningReader create(String pathDirectory,
                                        String xmlFileExtension,
                                        TransportLayerNetwork<?,?> network,
                                        Zoning zoning)
                                 throws PlanItException

Factory method

Parameters:

pathDirectory - to use

xmlFileExtension - to use

network - to extract references from (if any)

zoning - to populate

Returns:

created PLANit zoning reader

Throws:

PlanItException - thrown if error

create

public static PlanitZoningReader create(PlanitZoningReaderSettings zoningSettings,
                                        TransportLayerNetwork<?,?> referenceNetwork,
                                        Zoning zoningToPopulate)

Factory method

Parameters:

zoningSettings - to use

referenceNetwork - to use

zoningToPopulate - to use

Returns:

created PLANit zoning reader

create

public static PlanitZoningReader create(org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning,
                                        TransportLayerNetwork<?,?> network,
                                        Zoning zoning)
                                 throws PlanItException

Factory method where file has already been parsed and we only need to convert from raw XML objects to PLANit memory model

Parameters:

xmlRawZoning - to extract from

network - to extract references from (if any)

zoning - to populate

Returns:

created PLANit zoning reader

Throws:

PlanItException - thrown if error