Package org.goplanit.output.adapter

Interface OdOutputTypeAdapter

All Superinterfaces:

OutputTypeAdapter

All Known Implementing Classes:

OdOutputTypeAdapterImpl, TraditionalStaticAssignmentOdOutputTypeAdapter

public interface OdOutputTypeAdapter
extends OutputTypeAdapter

Interface defining the methods required for an Origin-Destination output adapter

Author:

gman6028, markr

Method Summary

Modifier and Type	Method	Description
static Optional<String>	getDestinationZoneExternalId(OdDataIterator<?> odIterator)	Returns the external Id of the destination zone for the current OD
static Optional<Long>	getDestinationZoneId(OdDataIterator<?> odIterator)	Returns the Id of the destination zone for the current cell in the OD destination
static Optional<String>	getDestinationZoneXmlId(OdDataIterator<?> odIterator)	Returns the XML Id of the destination zone for the current OD destination
Optional<?>	getOdOutputPropertyValue(OutputProperty outputProperty, OdDataIterator<?> odIterator, Mode mode, TimePeriod timePeriod)	Returns the specified output property values for the current cell in the OD Matrix Iterator
Optional<OdSkimMatrix>	getOdSkimMatrix(OdSkimSubOutputType odSkimOutputType, Mode mode)	Retrieve an OD skim matrix for a specified OD skim output type and mode
static <T> Optional<T>	getOdValue(OdDataIterator<T> odIterator)	Returns the Od value
static Optional<String>	getOriginZoneExternalId(OdDataIterator<?> odIterator)	Returns the origin zone external Id for the current cell in the OD origin
static Optional<Long>	getOriginZoneId(OdDataIterator<?> odIterator)	Returns the origin zone Id for the current cell in the OD origin
static Optional<String>	getOriginZoneXmlId(OdDataIterator<?> odIterator)	Returns the origin zone XML Id for the current cell in the OD origin

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

getIterationIndexForSubOutputType, getOutputType

Method Detail

getDestinationZoneExternalId

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

Returns the external Id of the destination zone for the current OD

Parameters:

odIterator - OdIterator object containing the required data

Returns:

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

Throws:

PlanItException - thrown if there is an error

getDestinationZoneXmlId

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

Returns the XML Id of the destination zone for the current OD destination

Parameters:

odIterator - OdIterator object containing the required data

Returns:

the XML Id of the destination zone for the current OD destination

Throws:

PlanItException - thrown if there is an error

getDestinationZoneId

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

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

Parameters:

odIterator - OdIterator object containing the required data

Returns:

the Id of the destination zone for the current cell OD destination

Throws:

PlanItException - thrown if there is an error

getOriginZoneExternalId

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

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

Parameters:

odIterator - OdIterator object containing the required data

Returns:

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

Throws:

PlanItException - thrown if there is an error

getOriginZoneXmlId

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

Returns the origin zone XML Id for the current cell in the OD origin

Parameters:

odIterator - OdIterator object containing the required data

Returns:

the origin zone XML Id for the current cell in the OD skim matrix

Throws:

PlanItException - thrown if there is an error

getOriginZoneId

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

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

Parameters:

odIterator - OdIterator object containing the required data

Returns:

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

Throws:

PlanItException - thrown if there is an error

getOdValue

static <T> Optional<T> getOdValue(OdDataIterator<T> odIterator)
                           throws PlanItException

Returns the Od value

Type Parameters:

T - type of the return value to expect

Parameters:

odIterator - OdIterator object containing the current value

Returns:

the OD travel cost for the current cell in the OD skim matrix

Throws:

PlanItException - thrown if there is an error

getOdSkimMatrix

Optional<OdSkimMatrix> getOdSkimMatrix(OdSkimSubOutputType odSkimOutputType,
                                       Mode mode)

Retrieve an OD skim matrix for a specified OD skim output type and mode

Parameters:

odSkimOutputType - the specified OD skim output type

mode - the specified mode

Returns:

the OD skim matrix

getOdOutputPropertyValue

Optional<?> getOdOutputPropertyValue(OutputProperty outputProperty,
                                     OdDataIterator<?> odIterator,
                                     Mode mode,
                                     TimePeriod timePeriod)

Returns the specified output property values for the current cell in the OD Matrix Iterator

Parameters:

outputProperty - the specified output property

odIterator - the iterator through the current OD data

mode - the current mode

timePeriod - the current time period

Returns:

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