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(String pathDirectory, String xmlFileExtension, LayeredNetwork<?,?> network, Zoning zoning)	Factory method
static PlanitZoningReader	create(String pathDirectory, LayeredNetwork<?,?> network)	Factory method
static PlanitZoningReader	create(NetworkReader networkReader)	Factory method where all contextual information is to be set afterwards via settings and network is to be obtained from provided reader.
static PlanitZoningReader	create(PlanitZoningReaderSettings settings, NetworkReader networkReader)	Factory method where all contextual information is derived from settings and network is to be obtained from provided reader.
static PlanitZoningReader	create(PlanitZoningReaderSettings zoningSettings, LayeredNetwork<?,?> referenceNetwork)	Factory method
static PlanitZoningReader	create(PlanitZoningReaderSettings zoningSettings, LayeredNetwork<?,?> referenceNetwork, Zoning zoningToPopulate)	Factory method
static PlanitZoningReader	create(org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning, PlanitZoningReaderSettings zoningSettings, LayeredNetwork<?,?> 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
static PlanitZoningReader	create(org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning, LayeredNetwork<?,?> 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(String pathDirectory,
                                        LayeredNetwork<?,?> network)

Factory method

Parameters:

pathDirectory - to use

network - to extract references from (if any)

Returns:

created PLANit zoning reader

create

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

Factory method

Parameters:

pathDirectory - to use

xmlFileExtension - to use

network - to extract references from (if any)

zoning - to populate

Returns:

created PLANit zoning reader

create

public static PlanitZoningReader create(PlanitZoningReaderSettings zoningSettings,
                                        LayeredNetwork<?,?> referenceNetwork)

Factory method

Parameters:

zoningSettings - to use

referenceNetwork - to use

Returns:

created PLANit zoning reader

create

public static PlanitZoningReader create(PlanitZoningReaderSettings zoningSettings,
                                        LayeredNetwork<?,?> 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,
                                        LayeredNetwork<?,?> 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

Parameters:

xmlRawZoning - to extract from

network - to extract references from (if any)

zoning - to populate

Returns:

created PLANit zoning reader

create

public static PlanitZoningReader create(org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning,
                                        PlanitZoningReaderSettings zoningSettings,
                                        LayeredNetwork<?,?> 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

Parameters:

xmlRawZoning - to extract from

zoningSettings - to use

network - to extract references from (if any)

zoning - to populate

Returns:

created PLANit zoning reader

create

public static PlanitZoningReader create(NetworkReader networkReader)

Factory method where all contextual information is to be set afterwards via settings and network is to be obtained from provided reader.

Parameters:

networkReader - to extract reference network from

Returns:

created PLANit zoning reader

create

public static PlanitZoningReader create(PlanitZoningReaderSettings settings,
                                        NetworkReader networkReader)

Factory method where all contextual information is derived from settings and network is to be obtained from provided reader.

Parameters:

settings - to use

networkReader - to extract reference network from

Returns:

created PLANit zoning reader