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

Interface ServiceLeg

All Superinterfaces:

Cloneable, Comparable<IdAble>, DirectedEdge, Edge, ExternalIdAble, GraphEntity, IdAble, ManagedId, Serializable

All Known Implementing Classes:

ServiceLegImpl

public interface ServiceLeg
extends DirectedEdge

Service leg interface which extends the Edge interface. A service leg comprises of one or more underlying physical links and represents an uninterrupted service route between two service nodes.

Author:

markr

Field Summary

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

EDGE_ID_CLASS

Method Summary

Modifier and Type	Method	Description
default Link	getFirstParentLink()	Collect the first parent link
default Link	getLastParentLink()	Collect the last parent link
default <LS extends ServiceLegSegment> LS	getLegSegment(boolean directionAb)	collect edgeSegment as something extending LegSegment which is to be expected for any Leg.
default <LS extends ServiceLegSegment> LS	getLegSegmentAb()	collect edgeSegment Ab as something extending LegSegment which is to be expected for any Leg.
default <LS extends ServiceLegSegment> Collection<LS>	getLegSegments()	Collect all available leg segments of this leg
default <LS extends ServiceLegSegment> LS	getLinkSegmentBa()	collect edgeSegment Ba as something extending LegSegment which is to be expected for any link.
List<Link>	getParentLinks()	Collect the links that make up this leg ordered and in direction from A to B
default <N extends ServiceNode> N	getServiceNodeA()	collect vertex A as something extending service node which is to be expected for any service leg.
default <N extends ServiceNode> N	getServiceNodeB()	collect vertex B as something extending service node which is to be expected for any service leg.
default boolean	hasLegSegmentAb()	verify if leg Segment Ab is present
default boolean	hasLegSegmentBa()	verify if LegSegment BA is present
default boolean	hasName()	Verify if name is present on leg

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

getEdgeSegment, getEdgeSegmentAb, getEdgeSegmentBa, getEdgeSegments, getVertexA, getVertexB, hasEdgeSegmentAb, hasEdgeSegmentBa, registerEdgeSegment, replace

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

addInputProperty, clone, createEnvelope, getGeometry, getIdClass, getInputProperty, getLengthKm, getName, hasGeometry, hasVertex, isGeometryInAbDirection, removeVertex, replace, setGeometry, setLengthKm, setName, transformGeometry, validate

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

getExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, 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

Method Detail

getServiceNodeA

default <N extends ServiceNode> N getServiceNodeA()

collect vertex A as something extending service node which is to be expected for any service leg. Convenience method for readability

Type Parameters:

N - service node type

Returns:

service node A

getServiceNodeB

default <N extends ServiceNode> N getServiceNodeB()

collect vertex B as something extending service node which is to be expected for any service leg. Convenience method for readability

Type Parameters:

N - service node type

Returns:

service node B

getLegSegment

default <LS extends ServiceLegSegment> LS getLegSegment(boolean directionAb)

collect edgeSegment as something extending LegSegment which is to be expected for any Leg. Convenience method for readability

Type Parameters:

LS - leg segment type

Parameters:

directionAb - the direction

Returns:

leg segment in given direction

getLegSegmentAb

default <LS extends ServiceLegSegment> LS getLegSegmentAb()

collect edgeSegment Ab as something extending LegSegment which is to be expected for any Leg. Convenience method for readability

Type Parameters:

LS - leg segment type

Returns:

leg segment in given direction

hasLegSegmentAb

default boolean hasLegSegmentAb()

verify if leg Segment Ab is present

Returns:

true when leg segment is present, false otherwise

getLinkSegmentBa

default <LS extends ServiceLegSegment> LS getLinkSegmentBa()

collect edgeSegment Ba as something extending LegSegment which is to be expected for any link. Convenience method for readability

Type Parameters:

LS - leg segment type

Returns:

leg segment in given direction

hasLegSegmentBa

default boolean hasLegSegmentBa()

verify if LegSegment BA is present

Returns:

true when leg segment is present, false otherwise

hasName

default boolean hasName()

Verify if name is present on leg

Specified by:

hasName in interface Edge

Returns:

true when present, false otherwise

getLegSegments

default <LS extends ServiceLegSegment> Collection<LS> getLegSegments()

Collect all available leg segments of this leg

Type Parameters:

LS - type of leg segment

Returns:

available leg segments

getParentLinks

List<Link> getParentLinks()

Collect the links that make up this leg ordered and in direction from A to B

Returns:

parent links this leg represents

getFirstParentLink

default Link getFirstParentLink()

Collect the first parent link

Returns:

first parent link

getLastParentLink

default Link getLastParentLink()

Collect the last parent link

Returns:

last parent link