Package org.goplanit.io.converter.intermodal

Class PlanitIntermodalReaderFactory

java.lang.Object

org.goplanit.io.converter.intermodal.PlanitIntermodalReaderFactory

public class PlanitIntermodalReaderFactory
extends Object

Factory class for creating zoning reader in the native PLANit format

Author:

markr

Constructor Summary

Constructors

Constructor	Description
PlanitIntermodalReaderFactory()

Method Summary

Modifier and Type	Method	Description
static PlanitIntermodalReader	create()	Factory method based on all defaults.
static PlanitIntermodalReader	create(String pathDirectory, String xmlFileExtension, MacroscopicNetwork network, Zoning zoning)	Factory method
static PlanitIntermodalReader	create(PlanitIntermodalReaderSettings intermodalSettings)	Factory method absed on passed in network and zoning reader settings
static PlanitIntermodalReader	create(org.goplanit.xml.generated.XMLElementMacroscopicNetwork xmlRawNetwork, org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning, MacroscopicNetwork network, Zoning zoning)	constructor 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

PlanitIntermodalReaderFactory

public PlanitIntermodalReaderFactory()

Method Detail

create

public static PlanitIntermodalReader create()
                                     throws PlanItException

Factory method based on all defaults. IT is expected that the user will set the necessary settings via the exposed settings

Returns:

created reader

Throws:

PlanItException - thrown if error

create

public static PlanitIntermodalReader create(PlanitIntermodalReaderSettings intermodalSettings)
                                     throws PlanItException

Factory method absed on passed in network and zoning reader settings

Parameters:

intermodalSettings - to use

Returns:

created reader

Throws:

PlanItException - thrown if error

create

public static PlanitIntermodalReader create(String pathDirectory,
                                            String xmlFileExtension,
                                            MacroscopicNetwork 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 reader

Throws:

PlanItException - thrown if error

create

public static PlanitIntermodalReader create(org.goplanit.xml.generated.XMLElementMacroscopicNetwork xmlRawNetwork,
                                            org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning,
                                            MacroscopicNetwork network,
                                            Zoning zoning)
                                     throws PlanItException

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

Parameters:

xmlRawNetwork - to extract from

xmlRawZoning - to extract from

network - to extract references from (if any)

zoning - to populate

Returns:

created reader

Throws:

PlanItException - thrown if error