Package org.goplanit.output.adapter

Interface UntypedLinkOutputTypeAdapter<T extends LinkSegment>

All Superinterfaces:

OutputTypeAdapter

All Known Subinterfaces:

MacroscopicLinkOutputTypeAdapter

All Known Implementing Classes:

MacroscopicLinkOutputTypeAdapterImpl, PhysicalLinkOutputTypeAdapterImpl, StaticLtmLinkOutputTypeAdapter, TraditionalStaticAssignmentLinkOutputTypeAdapter, UntypedLinkOutputTypeAdapterImpl

public interface UntypedLinkOutputTypeAdapter<T extends LinkSegment>
extends OutputTypeAdapter

Interface defining the methods required for a link output adapter

Author:

gman6028, markr

Method Summary

Modifier and Type	Method	Description
default Optional<String>	getDownstreamNodeExternalId(T linkSegment)	Returns the external Id of the downstream node
default Optional<Long>	getDownstreamNodeId(T linkSegment)	Returns the Id of the downstream node
default Optional<String>	getDownstreamNodeLocation(T linkSegment)	Returns the location of the downstream node
default Optional<String>	getDownstreamNodeXmlId(T linkSegment)	Returns the XML Id of the downstream node
default Optional<Double>	getLength(T linkSegment)	Returns the length of the current link segment
default Optional<String>	getLinkSegmentExternalId(T linkSegment)	Returns the external Id of the current link segment
default Optional<Long>	getLinkSegmentId(T linkSegment)	Returns the Id of the current link segment
Optional<?>	getLinkSegmentOutputPropertyValue(OutputProperty outputProperty, T linkSegment)	Return the value of a specified output property of a link segment
default Optional<String>	getLinkSegmentXmlId(T linkSegment)	Returns the XML Id of the current link segment
default Optional<Integer>	getNumberOfLanes(T linkSegment)	Returns the number of lanes of the current link
GraphEntities<T>	getPhysicalLinkSegments(long infrastructureLayerId)	Return the Link segments for this assignment
default Optional<String>	getUpstreamNodeExternalId(T linkSegment)	Returns the external Id of the upstream node
default Optional<Long>	getUpstreamNodeId(T linkSegment)	Returns the Id of the upstream node
default Optional<String>	getUpstreamNodeLocation(T linkSegment)	Returns the location of the upstream node
default Optional<String>	getUpstreamNodeXmlId(T linkSegment)	Returns the XML Id of the upstream node
static Optional<String>	getVertexLocationAsString(Vertex vertex)	collect location as string representation from vertex

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

getIterationIndexForSubOutputType, getOutputType

Method Detail

getVertexLocationAsString

static Optional<String> getVertexLocationAsString(Vertex vertex)

collect location as string representation from vertex

Parameters:

vertex - to extract location for

Returns:

node location

getDownstreamNodeExternalId

default Optional<String> getDownstreamNodeExternalId(T linkSegment)
                                              throws PlanItException

Returns the external Id of the downstream node

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the external Id of the downstream node

Throws:

PlanItException - thrown if there is an error

getDownstreamNodeXmlId

default Optional<String> getDownstreamNodeXmlId(T linkSegment)
                                         throws PlanItException

Returns the XML Id of the downstream node

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the XML Id of the downstream node

Throws:

PlanItException - thrown if there is an error

getDownstreamNodeId

default Optional<Long> getDownstreamNodeId(T linkSegment)
                                    throws PlanItException

Returns the Id of the downstream node

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the Id of the downstream node

Throws:

PlanItException - thrown if there is an error

getDownstreamNodeLocation

default Optional<String> getDownstreamNodeLocation(T linkSegment)
                                            throws PlanItException

Returns the location of the downstream node

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the location of the downstream node

Throws:

PlanItException - thrown if the location could not be retrieved

getLength

default Optional<Double> getLength(T linkSegment)
                            throws PlanItException

Returns the length of the current link segment

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the length of the current link segment

Throws:

PlanItException - thrown if there is an error

getLinkSegmentExternalId

default Optional<String> getLinkSegmentExternalId(T linkSegment)
                                           throws PlanItException

Returns the external Id of the current link segment

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the external Id of the current link segment

Throws:

PlanItException - thrown if there is an error

getLinkSegmentXmlId

default Optional<String> getLinkSegmentXmlId(T linkSegment)
                                      throws PlanItException

Returns the XML Id of the current link segment

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the XML Id of the current link segment

Throws:

PlanItException - thrown if there is an error

getLinkSegmentId

default Optional<Long> getLinkSegmentId(T linkSegment)
                                 throws PlanItException

Returns the Id of the current link segment

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the Id of the current link segment

Throws:

PlanItException - thrown if there is an error

getNumberOfLanes

default Optional<Integer> getNumberOfLanes(T linkSegment)
                                    throws PlanItException

Returns the number of lanes of the current link

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the number of lanes of the current link

Throws:

PlanItException - thrown if there is an error

getUpstreamNodeExternalId

default Optional<String> getUpstreamNodeExternalId(T linkSegment)
                                            throws PlanItException

Returns the external Id of the upstream node

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the external Id of the upstream node

Throws:

PlanItException - thrown if there is an error

getUpstreamNodeXmlId

default Optional<String> getUpstreamNodeXmlId(T linkSegment)
                                       throws PlanItException

Returns the XML Id of the upstream node

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the XML Id of the upstream node

Throws:

PlanItException - thrown if there is an error

getUpstreamNodeLocation

default Optional<String> getUpstreamNodeLocation(T linkSegment)
                                          throws PlanItException

Returns the location of the upstream node

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the location of the upstream node

Throws:

PlanItException - thrown if there is an error

getUpstreamNodeId

default Optional<Long> getUpstreamNodeId(T linkSegment)
                                  throws PlanItException

Returns the Id of the upstream node

Parameters:

linkSegment - LinkSegment object containing the required data

Returns:

the Id of the upstream node

Throws:

PlanItException - thrown if there is an error

getPhysicalLinkSegments

GraphEntities<T> getPhysicalLinkSegments(long infrastructureLayerId)

Return the Link segments for this assignment

Parameters:

infrastructureLayerId - to collect link segments for

Returns:

a List of link segments for this assignment

getLinkSegmentOutputPropertyValue

Optional<?> getLinkSegmentOutputPropertyValue(OutputProperty outputProperty,
                                              T linkSegment)

Return the value of a specified output property of a link segment

Parameters:

outputProperty - the specified output property

linkSegment - the specified link segment

Returns:

the value of the specified output property (or an Exception if an error occurs)