Package org.planit.io.zoning

Class PlanitZoningReader

java.lang.Object

org.planit.io.xml.util.PlanitXmlReader<org.planit.xml.generated.XMLElementMacroscopicZoning>

org.planit.io.zoning.PlanitZoningReader

public class PlanitZoningReader
extends PlanitXmlReader<org.planit.xml.generated.XMLElementMacroscopicZoning>

Class to parse zoning from native XML format

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
protected PlanitZoningReaderSettings	settings	settings for the zoning reader
protected Zoning	zoning	the zoning to populate

Constructor Summary

Constructors

Constructor	Description
PlanitZoningReader(String pathDirectory, String xmlFileExtension, Zoning zoning)	constructor
PlanitZoningReader(org.planit.xml.generated.XMLElementMacroscopicZoning xmlMacroscopicZoning, Zoning zoning)	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
PlanitZoningReaderSettings	getSettings()	settings for this reader
protected void	populateIntermodal(Modes modes, Map<String,MacroscopicLinkSegment> linkSegmentsByXmlId)	parse the intermodal zones, i.e., platforms, stops, stations, etc.
protected void	populateODZones(Map<String,Node> nodesByXmlIds)	parse the OD zones from Xml element into Planit memory
Zoning	read(InfrastructureNetwork network, Map<String,Node> nodesByXmlId, Map<String,MacroscopicLinkSegment> linkSegmentsByXmlId)	read the zoning from disk
protected void	setZoning(Zoning zoning)	set the zoning to populate

Methods inherited from class org.planit.io.xml.util.PlanitXmlReader

clearXmlContent, getXmlRootElement, initialiseAndParseXmlRootElement

Methods inherited from class java.lang.Object

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

Field Detail

settings

protected final PlanitZoningReaderSettings settings

settings for the zoning reader

zoning

protected Zoning zoning

the zoning to populate

Constructor Detail

PlanitZoningReader

public PlanitZoningReader(String pathDirectory,
                          String xmlFileExtension,
                          Zoning zoning)
                   throws PlanItException

constructor

Parameters:

pathDirectory - to use

xmlFileExtension - to use

zoning - to populate

Throws:

PlanItException - thrown if error

PlanitZoningReader

public PlanitZoningReader(org.planit.xml.generated.XMLElementMacroscopicZoning xmlMacroscopicZoning,
                          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:

xmlMacroscopicZoning - to extract from

zoning - to populate

Throws:

PlanItException - thrown if error

Method Detail

setZoning

protected void setZoning(Zoning zoning)

set the zoning to populate

Parameters:

zoning - to populate

populateODZones

protected void populateODZones(Map<String,Node> nodesByXmlIds)
                        throws PlanItException

parse the OD zones from Xml element into Planit memory

Parameters:

nodesByXmlIds - nodes indexed by xml id to use

Throws:

PlanItException - thrown if error

populateIntermodal

protected void populateIntermodal(Modes modes,
                                  Map<String,MacroscopicLinkSegment> linkSegmentsByXmlId)
                           throws PlanItException

parse the intermodal zones, i.e., platforms, stops, stations, etc. from Xml element into Planit memory

Parameters:

modes - that can be referred to

linkSegmentsByXmlId - to identify mapping between (transfer) connectoids and network

Throws:

PlanItException - thrown if error

read

public Zoning read(InfrastructureNetwork network,
                   Map<String,Node> nodesByXmlId,
                   Map<String,MacroscopicLinkSegment> linkSegmentsByXmlId)
            throws PlanItException

read the zoning from disk

Parameters:

network - this zoning is compatible with

nodesByXmlId - to identify mapping between OD zones and network (via nodes)

linkSegmentsByXmlId - to identify mapping between (transfer) connectoids and network

Returns:

zoning parsed

Throws:

PlanItException - thrown if error

getSettings

public PlanitZoningReaderSettings getSettings()

settings for this reader

Returns:

settings