Package org.goplanit.graph.directed

Class EdgeSegmentImpl<E extends DirectedEdge>

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.id.ExternalIdAbleImpl

org.goplanit.graph.GraphEntityImpl

org.goplanit.graph.directed.EdgeSegmentImpl<E>

All Implemented Interfaces:

Serializable, Comparable<IdAble>, EdgeSegment, GraphEntity, ExternalIdAble, IdAble, ManagedId

Direct Known Subclasses:

ConjugateConnectoidSegmentImpl, ConjugateEdgeSegmentImpl, ConjugateLinkSegmentImpl, ConnectoidSegmentImpl, LinkSegmentBase, ServiceLegSegmentImpl

public class EdgeSegmentImpl<E extends DirectedEdge>
extends GraphEntityImpl
implements EdgeSegment

EdgeSegment represents an edge in a particular (single) direction. Each edge has either one or two edge segments where each edge segment may have a more detailed geography than its parent link (which represents both directions via a centre line)

Author:

markr

See Also:

Serialized Form

Field Summary

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

EDGE_SEGMENT_ID_CLASS, getDownstreamVertex, getUpstreamVertex

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EdgeSegmentImpl(EdgeSegmentImpl<E> edgeSegmentImpl, boolean deepCopy)	Copy constructor
protected	EdgeSegmentImpl(IdGroupingToken groupId, boolean directionAb)	Constructor (without setting parent edge)
protected	EdgeSegmentImpl(IdGroupingToken groupId, E parentEdge, boolean directionAb)	Constructor
protected	EdgeSegmentImpl(IdGroupingToken groupId, E parentEdge, boolean directionAb, Class<? extends EdgeSegment> idClazz)	Constructor

Method Summary

Modifier and Type	Method	Description
EdgeSegmentImpl<E>	deepClone()	An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call.
E	getParent()	Collect the parent edge of the segment
boolean	isDirectionAb()	check if edge segment runs from vertex a to b or b to a
void	removeParentEdge()	remove the parent edge from this edge segment
void	setParent(DirectedEdge parentEdge)	Set the parent edge
EdgeSegmentImpl<E>	shallowClone()	Create a shallow copy of this entity
boolean	validate()	validate the contents of this edge segment
protected static boolean	validate(EdgeSegment edgeSegment)	Validate given edge segment on validity

Methods inherited from class org.goplanit.graph.GraphEntityImpl

generateAndSetId, generateId, recreateManagedIds, toString

Methods inherited from class org.goplanit.utils.id.ExternalIdAbleImpl

getExternalId, getXmlId, setExternalId, setXmlId

Methods inherited from class org.goplanit.utils.id.IdAbleImpl

equals, generateAndSetId, getId, hashCode, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getDownstreamVertex, getIdClass, getLengthKm, getOppositeDirectionSegment, getParentName, getUpstreamVertex, hasGeometry, hasParent, hasParentName, isAdjacent, isParentGeometryInSegmentDirection

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

Constructor Detail

EdgeSegmentImpl

protected EdgeSegmentImpl(IdGroupingToken groupId,
                          E parentEdge,
                          boolean directionAb,
                          Class<? extends EdgeSegment> idClazz)

Constructor

Parameters:

groupId - contiguous id generation within this group for instances of this class

parentEdge - parent edge of segment

directionAb - direction of travel

idClazz - custom id class to use

EdgeSegmentImpl

protected EdgeSegmentImpl(IdGroupingToken groupId,
                          E parentEdge,
                          boolean directionAb)

Constructor

Parameters:

groupId - contiguous id generation within this group for instances of this class

parentEdge - parent edge of segment

directionAb - direction of travel

EdgeSegmentImpl

protected EdgeSegmentImpl(IdGroupingToken groupId,
                          boolean directionAb)

Constructor (without setting parent edge)

Parameters:

groupId - contiguous id generation within this group for instances of this class

directionAb - direction of travel

EdgeSegmentImpl

protected EdgeSegmentImpl(EdgeSegmentImpl<E> edgeSegmentImpl,
                          boolean deepCopy)

Copy constructor

Parameters:

edgeSegmentImpl - to copy

deepCopy - when true, create a deep copy, shallow copy otherwise

Method Detail

validate

protected static final boolean validate(EdgeSegment edgeSegment)

Validate given edge segment on validity

Parameters:

edgeSegment - to validate

Returns:

true when valid, false when not

isDirectionAb

public boolean isDirectionAb()

check if edge segment runs from vertex a to b or b to a

Specified by:

isDirectionAb in interface EdgeSegment

Returns:

true when running from a to b, otherwise false

getParent

public E getParent()

Collect the parent edge of the segment

Specified by:

getParent in interface EdgeSegment

Returns:

parentEdge

setParent

public void setParent(DirectedEdge parentEdge)

Set the parent edge

Specified by:

setParent in interface EdgeSegment

Parameters:

parentEdge - to set

removeParentEdge

public void removeParentEdge()

remove the parent edge from this edge segment

Specified by:

removeParentEdge in interface EdgeSegment

shallowClone

public EdgeSegmentImpl<E> shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface EdgeSegment

Specified by:

shallowClone in interface GraphEntity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in class GraphEntityImpl

Returns:

shallow copy of entity

deepClone

public EdgeSegmentImpl<E> deepClone()

An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call. To be used with caution if not called by managed id container related code

Specified by:

deepClone in interface EdgeSegment

Specified by:

deepClone in interface GraphEntity

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in class GraphEntityImpl

Returns:

deep copy of entity

validate

public boolean validate()

validate the contents of this edge segment

Specified by:

validate in interface EdgeSegment

Returns:

true when valid, false otherwise