Package org.goplanit.io.converter.service

Class PlanitRoutedServicesReader

java.lang.Object

org.goplanit.converter.BaseReaderImpl<RoutedServices>

org.goplanit.io.converter.service.PlanitRoutedServicesReader

All Implemented Interfaces:

ConverterEntity, ConverterReader<RoutedServices>, RoutedServicesReader

public class PlanitRoutedServicesReader
extends BaseReaderImpl<RoutedServices>
implements RoutedServicesReader

Implementation of a routed service reader in the PLANit XML native format

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROUTED_SERVICES_XSD_FILE	Default XSD files used to validate input XML files against, TODO: move to properties file

Fields inherited from class org.goplanit.converter.BaseReaderImpl

sourceIdTracker

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PlanitRoutedServicesReader(String inputPathDirectory, String xmlFileExtension, RoutedServices routedServices)	Constructor
protected	PlanitRoutedServicesReader(PlanitRoutedServicesReaderSettings settings, RoutedServices routedServices)	Constructor where settings and routed services to populate are directly provided
protected	PlanitRoutedServicesReader(IdGroupingToken idToken, ServiceNetwork parentServiceNetwork, PlanitRoutedServicesReaderSettings settings)	Constructor where settings are directly provided such that input information can be extracted from it
protected	PlanitRoutedServicesReader(org.goplanit.xml.generated.XMLElementRoutedServices populatedXmlRawRoutedServices, PlanitRoutedServicesReaderSettings settings, RoutedServices routedServices)	Constructor where file has already been parsed and we only need to convert from raw XML objects to PLANit memory model
protected	PlanitRoutedServicesReader(org.goplanit.xml.generated.XMLElementRoutedServices populatedXmlRawRoutedServices, RoutedServices routedServices)	Constructor where file has already been parsed and we only need to convert from raw XML objects to PLANit memory model

Method Summary

Modifier and Type	Method	Description
PlanitRoutedServicesReaderSettings	getSettings()	any settings to configure the reader can be configured by collecting these settings
RoutedServices	read()	parse the network based on the configuration of the implementing class to yield a PLANit network
void	reset()	reset the reader to allow for marking unnecessary resources for garbage collection

Methods inherited from class org.goplanit.converter.BaseReaderImpl

getBySourceId, getSourceIdContainer, initialiseSourceIdMap, initialiseSourceIdMap, registerBySourceId, registerBySourceId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.converter.service.RoutedServicesReader

getTypeDescription

Field Detail

ROUTED_SERVICES_XSD_FILE

public static final String ROUTED_SERVICES_XSD_FILE

Default XSD files used to validate input XML files against, TODO: move to properties file

See Also:

Constant Field Values

Constructor Detail

PlanitRoutedServicesReader

protected PlanitRoutedServicesReader(IdGroupingToken idToken,
                                     ServiceNetwork parentServiceNetwork,
                                     PlanitRoutedServicesReaderSettings settings)
                              throws PlanItException

Constructor where settings are directly provided such that input information can be extracted from it

Parameters:

idToken - to use for the service network to populate

parentServiceNetwork - to use

settings - to use

Throws:

PlanItException - thrown if error

PlanitRoutedServicesReader

protected PlanitRoutedServicesReader(PlanitRoutedServicesReaderSettings settings,
                                     RoutedServices routedServices)

Constructor where settings and routed services to populate are directly provided

Parameters:

settings - to use

routedServices - to populate

PlanitRoutedServicesReader

protected PlanitRoutedServicesReader(org.goplanit.xml.generated.XMLElementRoutedServices populatedXmlRawRoutedServices,
                                     RoutedServices routedServices)

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

Parameters:

populatedXmlRawRoutedServices - to extract from

routedServices - to populate

PlanitRoutedServicesReader

protected PlanitRoutedServicesReader(org.goplanit.xml.generated.XMLElementRoutedServices populatedXmlRawRoutedServices,
                                     PlanitRoutedServicesReaderSettings settings,
                                     RoutedServices routedServices)

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

Parameters:

populatedXmlRawRoutedServices - to extract from

settings - to use

routedServices - to populate

PlanitRoutedServicesReader

protected PlanitRoutedServicesReader(String inputPathDirectory,
                                     String xmlFileExtension,
                                     RoutedServices routedServices)

Constructor

Parameters:

inputPathDirectory - to use

xmlFileExtension - to use

routedServices - to populate

Method Detail

read

public RoutedServices read()

parse the network based on the configuration of the implementing class to yield a PLANit network

Specified by:

read in interface ConverterReader<RoutedServices>

Returns:

parsed network

getSettings

public PlanitRoutedServicesReaderSettings getSettings()

any settings to configure the reader can be configured by collecting these settings

Specified by:

getSettings in interface ConverterReader<RoutedServices>

Returns:

the settings to configrue the reader

reset

public void reset()

reset the reader to allow for marking unnecessary resources for garbage collection

Specified by:

reset in interface ConverterEntity

Overrides:

reset in class BaseReaderImpl<RoutedServices>