Package org.goplanit.output.adapter

Interface PathOutputTypeAdapter

All Superinterfaces:

OutputTypeAdapter

All Known Implementing Classes:

PathOutputTypeAdapterImpl, TraditionalStaticPathOutputTypeAdapter

public interface PathOutputTypeAdapter
extends OutputTypeAdapter

Output type adapter interface for paths

Author:

gman6028

Method Summary

Modifier and Type	Method	Description
static Optional<String>	getDestinationZoneExternalId(OdDataIterator<?> odPathIterator)	Returns the external Id of the destination zone for the current cell in the OD path matrix
static Optional<Long>	getDestinationZoneId(OdDataIterator<?> odPathIterator)	Returns the Id of the destination zone for the current cell in the OD path matrix
static Optional<String>	getDestinationZoneXmlId(OdDataIterator<?> odPathIterator)	Returns the Xml Id of the destination zone for the current cell in the OD path matrix
Optional<OdPathMatrix>	getOdPathMatrix(Mode mode)	Retrieve an OD path matrix object for a specified mode
static Optional<String>	getOriginZoneExternalId(OdDataIterator<?> odPathIterator)	Returns the origin zone external Id for the current cell in the OD path matrix
static Optional<Long>	getOriginZoneId(OdDataIterator<?> odPathIterator)	Returns the origin zone Id for the current cell in the OD path matrix
static Optional<String>	getOriginZoneXmlId(OdDataIterator<?> odPathIterator)	Returns the Xml Id of the origin zone for the current cell in the OD path matrix
static Optional<String>	getPathAsString(OdDataIterator<? extends ManagedDirectedPath> odPathIterator, PathOutputIdentificationType pathOutputType)	Returns the path as a String of comma-separated Id values
static Optional<Long>	getPathId(OdDataIterator<? extends ManagedDirectedPath> odPathIterator)	Return the Id of the current path If there is no path between the current origin and destination zones, this returns -1
Optional<?>	getPathOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<? extends ManagedDirectedPath> odPathIterator, Mode mode, TimePeriod timePeriod, PathOutputIdentificationType pathOutputType)	Returns the specified output property values for the current cell in the ODPathIterator

Methods inherited from interface org.goplanit.output.adapter.OutputTypeAdapter

getIterationIndexForSubOutputType, getOutputType

Method Detail

getDestinationZoneExternalId

static Optional<String> getDestinationZoneExternalId(OdDataIterator<?> odPathIterator)
                                              throws PlanItException

Returns the external Id of the destination zone for the current cell in the OD path matrix

Parameters:

odPathIterator - ODPathIterator object containing the required data

Returns:

the external Id of the destination zone for the current cell in the OD path matrix

Throws:

PlanItException - thrown if there is an error

getDestinationZoneXmlId

static Optional<String> getDestinationZoneXmlId(OdDataIterator<?> odPathIterator)
                                         throws PlanItException

Returns the Xml Id of the destination zone for the current cell in the OD path matrix

Parameters:

odPathIterator - ODPathIterator object containing the required data

Returns:

the xml Id of the destination zone for the current cell in the OD path matrix

Throws:

PlanItException - thrown if there is an error

getDestinationZoneId

static Optional<Long> getDestinationZoneId(OdDataIterator<?> odPathIterator)
                                    throws PlanItException

Returns the Id of the destination zone for the current cell in the OD path matrix

Parameters:

odPathIterator - ODPathIterator object containing the required data

Returns:

the Id of the destination zone for the current cell in the OD path matrix

Throws:

PlanItException - thrown if there is an error

getOriginZoneExternalId

static Optional<String> getOriginZoneExternalId(OdDataIterator<?> odPathIterator)
                                         throws PlanItException

Returns the origin zone external Id for the current cell in the OD path matrix

Parameters:

odPathIterator - ODPathIterator object containing the required data

Returns:

the origin zone external Id for the current cell in the OD path matrix

Throws:

PlanItException - thrown if there is an error

getOriginZoneXmlId

static Optional<String> getOriginZoneXmlId(OdDataIterator<?> odPathIterator)
                                    throws PlanItException

Returns the Xml Id of the origin zone for the current cell in the OD path matrix

Parameters:

odPathIterator - ODPathIterator object containing the required data

Returns:

the xml Id of the origin zone for the current cell in the OD path matrix

Throws:

PlanItException - thrown if there is an error

getOriginZoneId

static Optional<Long> getOriginZoneId(OdDataIterator<?> odPathIterator)
                               throws PlanItException

Returns the origin zone Id for the current cell in the OD path matrix

Parameters:

odPathIterator - ODPathIterator object containing the required data

Returns:

the origin zone Id for the current cell in the OD path matrix

Throws:

PlanItException - thrown if there is an error

getPathAsString

static Optional<String> getPathAsString(OdDataIterator<? extends ManagedDirectedPath> odPathIterator,
                                        PathOutputIdentificationType pathOutputType)

Returns the path as a String of comma-separated Id values

Parameters:

odPathIterator - ODPathIterator object containing the required data

pathOutputType - the type of objects being used in the path

Returns:

the OD path as a String of comma-separated node external Id values

getPathId

static Optional<Long> getPathId(OdDataIterator<? extends ManagedDirectedPath> odPathIterator)

Return the Id of the current path If there is no path between the current origin and destination zones, this returns -1

Parameters:

odPathIterator - ODPathIterator object containing the required data

Returns:

the id of the current path, or -1 if no path exists

getOdPathMatrix

Optional<OdPathMatrix> getOdPathMatrix(Mode mode)

Retrieve an OD path matrix object for a specified mode

Parameters:

mode - the specified mode

Returns:

the OD path object

getPathOutputPropertyValue

Optional<?> getPathOutputPropertyValue(OutputProperty outputProperty,
                                       OdDataIterator<? extends ManagedDirectedPath> odPathIterator,
                                       Mode mode,
                                       TimePeriod timePeriod,
                                       PathOutputIdentificationType pathOutputType)

Returns the specified output property values for the current cell in the ODPathIterator

Parameters:

outputProperty - the specified output property

odPathIterator - the iterator through the current ODPath object

mode - the current mode

timePeriod - the current time period

pathOutputType - the type of objects in the path list

Returns:

the value of the specified property (or an Exception if an error has occurred)