Package org.goplanit.utils.network.layer.service

Interface ServiceNode

All Superinterfaces:

Comparable<IdAble>, DirectedVertex, ExternalIdAble, GraphEntity, IdAble, ManagedId, Serializable, Vertex

All Known Implementing Classes:

ServiceNodeImpl

public interface ServiceNode
extends DirectedVertex

Service node is a vertex but not all vertices are service nodes. A service node represents a location in the service network where legs intersect, usually representing for example stop locations of public transport.

Author:

markr

Field Summary

Fields inherited from interface org.goplanit.utils.graph.directed.DirectedVertex

getEntryEdgeSegments, getExitEdgeSegments

Fields inherited from interface org.goplanit.utils.graph.Vertex

LOGGER, VERTEX_ID_CLASS

Method Summary

Modifier and Type	Method	Description
ServiceNode	deepClone()	Deep clone
default Iterable<? extends EdgeSegment>	getEntryLegSegments()	Identical to DirectedVertex.getEntryEdgeSegments()
default Iterable<? extends EdgeSegment>	getExitLegSegments()	Identical to DirectedVertex.getExitEdgeSegments()
default ServiceLegSegment	getFirstEntryLegSegment()	Collect the first available entry leg segment using the iterator internally.
default ServiceLegSegment	getFirstExitLegSegment()	Collect the first available exit link segment using the iterator internally.
default Collection<? extends Edge>	getLegs()	Identical to DirectedVertex.getEdges()
default ServiceLegSegment	getLegSegment(ServiceNode endNode)	Identical to #getEdgeSegment(DirectedVertex)
Collection<Node>	getPhysicalParentNodes()	Provide access to the underlying network node(s)
boolean	hasPhysicalParentNodes()	Verify if a physical parent node is linked to this service node
boolean	isMappedToPhysicalParentNode(Node physicalParentNode)	Verify if provided node is registered as a physical parent node of this service node
ServiceNode	shallowClone()	Shallow clone

Methods inherited from interface org.goplanit.utils.graph.directed.DirectedVertex

getEdges, getEdgeSegment, getEntryEdgeSegments, getExitEdgeSegments, getNumberOfEntryEdgeSegments, getNumberOfExitEdgeSegments, hasEntryEdgeSegments, hasEntrySegment, hasExitEdgeSegments, hasExitSegment

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble

appendExternalId, appendExternalId, getExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId, setXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble

compareTo, getId, idEquals, idHashCode

Methods inherited from interface org.goplanit.utils.id.ManagedId

recreateManagedIds, resetChildManagedIdEntities

Methods inherited from interface org.goplanit.utils.graph.Vertex

addEdge, addEdges, addInputProperty, getEdges, getIdClass, getInputProperty, getNumberOfEdges, getPosition, hasPosition, isPositionEqual2D, isPositionEqual2D, removeAllEdges, removeEdge, removeEdge, removeEdges, replace, setPosition, transformPosition, validate

Method Detail

shallowClone

ServiceNode shallowClone()

Shallow clone

Specified by:

shallowClone in interface GraphEntity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in interface Vertex

Returns:

the cloned entity

deepClone

ServiceNode deepClone()

Deep clone

Specified by:

deepClone in interface GraphEntity

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in interface Vertex

Returns:

the cloned entity

getLegs

default Collection<? extends Edge> getLegs()

Identical to DirectedVertex.getEdges()

Returns:

legs

getEntryLegSegments

default Iterable<? extends EdgeSegment> getEntryLegSegments()

Identical to DirectedVertex.getEntryEdgeSegments()

Returns:

entryLegSegments

getExitLegSegments

default Iterable<? extends EdgeSegment> getExitLegSegments()

Identical to DirectedVertex.getExitEdgeSegments()

Returns:

exitLegSegments

getLegSegment

default ServiceLegSegment getLegSegment(ServiceNode endNode)

Identical to #getEdgeSegment(DirectedVertex)

Parameters:

endNode - to use

Returns:

first leg segment matching this signature

getFirstEntryLegSegment

default ServiceLegSegment getFirstEntryLegSegment()

Collect the first available entry leg segment using the iterator internally. It is assumed at least one entry is available

Returns:

first entry available

getFirstExitLegSegment

default ServiceLegSegment getFirstExitLegSegment()

Collect the first available exit link segment using the iterator internally. It is assumed at least one entry is available

Returns:

first exit available

getPhysicalParentNodes

Collection<Node> getPhysicalParentNodes()

Provide access to the underlying network node(s)

Returns:

networkLayerNode(s)

hasPhysicalParentNodes

boolean hasPhysicalParentNodes()

Verify if a physical parent node is linked to this service node

Returns:

true when present false otherwise

isMappedToPhysicalParentNode

boolean isMappedToPhysicalParentNode(Node physicalParentNode)

Verify if provided node is registered as a physical parent node of this service node

Parameters:

physicalParentNode - to verify

Returns:

true when registered, false otherwise