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 intermodal 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)	Factory method based on defaults with custom set path directory.
static PlanitIntermodalReader	create(String pathDirectory, String xmlFileExtension, MacroscopicNetwork network, Zoning zoning)	Factory method for intermodal reader( without services)
static PlanitIntermodalReader	create(String pathDirectory, String xmlFileExtension, MacroscopicNetwork network, Zoning zoning, ServiceNetwork serviceNetwork, RoutedServices routedServices)	Factory method
static PlanitIntermodalReader	create(PlanitIntermodalReaderSettings intermodalSettings)	Factory method based on passed in network and zoning reader settings
static PlanitIntermodalReader	create(IdGroupingToken idGroupingToken)	Factory method based on all defaults.
static PlanitIntermodalReader	create(IdGroupingToken idGroupingToken, PlanitIntermodalReaderSettings intermodalSettings)	Factory method based on settings.
static PlanitIntermodalReader	create(org.goplanit.xml.generated.XMLElementMacroscopicNetwork xmlRawNetwork, org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning, org.goplanit.xml.generated.XMLElementServiceNetwork xmlRawServiceNetwork, org.goplanit.xml.generated.XMLElementRoutedServices xmlRawRoutedServices, MacroscopicNetwork network, Zoning zoning, ServiceNetwork serviceNetwork, RoutedServices routedServices)	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()

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

Returns:

created reader

create

public static PlanitIntermodalReader create(String pathDirectory)

Factory method based on defaults with custom set path directory. IT is expected that the user will set the necessary settings via the exposed settings

Parameters:

pathDirectory - to use

Returns:

created reader

create

public static PlanitIntermodalReader create(IdGroupingToken idGroupingToken)

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

Parameters:

idGroupingToken - to use for creating ids

Returns:

created reader

create

public static PlanitIntermodalReader create(PlanitIntermodalReaderSettings intermodalSettings)

Factory method based on passed in network and zoning reader settings

Parameters:

intermodalSettings - to use

Returns:

created reader

create

public static PlanitIntermodalReader create(IdGroupingToken idGroupingToken,
                                            PlanitIntermodalReaderSettings intermodalSettings)

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

Parameters:

idGroupingToken - to use for creating ids

intermodalSettings - settings to use

Returns:

created reader

create

public static PlanitIntermodalReader create(String pathDirectory,
                                            String xmlFileExtension,
                                            MacroscopicNetwork network,
                                            Zoning zoning)

Factory method for intermodal reader( without services)

Parameters:

pathDirectory - to use

xmlFileExtension - to use

network - to extract references from (if any)

zoning - to populate

Returns:

created reader

create

public static PlanitIntermodalReader create(String pathDirectory,
                                            String xmlFileExtension,
                                            MacroscopicNetwork network,
                                            Zoning zoning,
                                            ServiceNetwork serviceNetwork,
                                            RoutedServices routedServices)

Factory method

Parameters:

pathDirectory - to use

xmlFileExtension - to use

network - to extract references from (if any)

zoning - to populate

serviceNetwork - to populate

routedServices - to populate

Returns:

created reader

create

public static PlanitIntermodalReader create(org.goplanit.xml.generated.XMLElementMacroscopicNetwork xmlRawNetwork,
                                            org.goplanit.xml.generated.XMLElementMacroscopicZoning xmlRawZoning,
                                            org.goplanit.xml.generated.XMLElementServiceNetwork xmlRawServiceNetwork,
                                            org.goplanit.xml.generated.XMLElementRoutedServices xmlRawRoutedServices,
                                            MacroscopicNetwork network,
                                            Zoning zoning,
                                            ServiceNetwork serviceNetwork,
                                            RoutedServices routedServices)

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

xmlRawServiceNetwork - to extract from

xmlRawRoutedServices - to extract from

network - to extract references from (if any)

zoning - to populate

serviceNetwork - to populate

routedServices - to populate

Returns:

created reader