Package org.goplanit.network.layer.physical

Class LinkImpl

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.id.ExternalIdAbleImpl

org.goplanit.graph.GraphEntityImpl

org.goplanit.graph.EdgeImpl

org.goplanit.graph.directed.DirectedEdgeImpl

org.goplanit.network.layer.physical.LinkImpl

All Implemented Interfaces:

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

public class LinkImpl
extends DirectedEdgeImpl
implements Link

Link class connecting two nodes via some geometry. Each link has one or two underlying link segments in a particular direction which may carry additional information for each particular direction of the link.

Author:

markr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected long	linkId	unique internal identifier

Fields inherited from class org.goplanit.graph.EdgeImpl

inputProperties, lengthInKm, lineGeometry, name

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

EDGE_ID_CLASS

Fields inherited from interface org.goplanit.utils.network.layer.physical.Link

LINK_ID_CLASS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LinkImpl(LinkImpl linkImpl)	Copy constructor, geometry is deep copied, see also DirectedEdge copy constructed
protected	LinkImpl(IdGroupingToken groupId, Node nodeA, Node nodeB)	Constructor which injects link length directly
protected	LinkImpl(IdGroupingToken groupId, Node nodeA, Node nodeB, double length)	Constructor which injects link length directly

Method Summary

Modifier and Type	Method	Description
LinkImpl	clone()	Create a shallow copy of this entity
protected static long	generateLinkId(IdGroupingToken tokenId)	generate unique link id
long	getLinkId()	Return id of this instance.
protected long	recreateLinkId(IdGroupingToken tokenId)	recreate the internal link id and set it
long	recreateManagedIds(IdGroupingToken tokenId)	Recreate id and link id
protected void	setLinkId(long linkId)	Set the link id
boolean	validate()	validate the contents of this edge

Methods inherited from class org.goplanit.graph.directed.DirectedEdgeImpl

getEdgeSegmentAb, getEdgeSegmentBa, getVertexA, getVertexB, registerEdgeSegment, replace, setEdgeSegmentAb, setEdgeSegmentBa

Methods inherited from class org.goplanit.graph.EdgeImpl

addInputProperty, getGeometry, getInputProperty, getLengthKm, getName, removeVertex, removeVertexA, removeVertexB, replace, setGeometry, setLengthKm, setName, setVertexA, setVertexB

Methods inherited from class org.goplanit.graph.GraphEntityImpl

generateAndSetId, generateId, 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

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

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, createEnvelope, getGeometry, getIdClass, getInputProperty, getLengthKm, getName, hasGeometry, hasVertex, isGeometryInAbDirection, removeVertex, replace, setGeometry, setLengthKm, setName, transformGeometry

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.network.layer.physical.Link

getLinkIdClass, getLinkSegment, getLinkSegmentAb, getLinkSegmentBa, getLinkSegments, getNodeA, getNodeB, hasLinkSegmentAb, hasLinkSegmentBa, hasName

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

resetChildManagedIdEntities

Field Detail

linkId

protected long linkId

unique internal identifier

Constructor Detail

LinkImpl

protected LinkImpl(LinkImpl linkImpl)

Copy constructor, geometry is deep copied, see also DirectedEdge copy constructed

Parameters:

linkImpl - to copy

LinkImpl

protected LinkImpl(IdGroupingToken groupId,
                   Node nodeA,
                   Node nodeB)

Constructor which injects link length directly

Parameters:

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

nodeA - the first node in the link

nodeB - the second node in the link

LinkImpl

protected LinkImpl(IdGroupingToken groupId,
                   Node nodeA,
                   Node nodeB,
                   double length)

Constructor which injects link length directly

Parameters:

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

nodeA - the first node in the link

nodeB - the second node in the link

length - the length of the link

Method Detail

generateLinkId

protected static long generateLinkId(IdGroupingToken tokenId)

generate unique link id

Parameters:

tokenId - , contiguous id generation within this group for instances of this class

Returns:

linkId created

setLinkId

protected void setLinkId(long linkId)

Set the link id

Parameters:

linkId - to set

recreateLinkId

protected long recreateLinkId(IdGroupingToken tokenId)

recreate the internal link id and set it

Parameters:

tokenId - to use

Returns:

the created link id

getLinkId

public long getLinkId()

Return id of this instance. This id is expected to be generated using the org.planit.utils.misc.IdGenerator

Specified by:

getLinkId in interface Link

Returns:

linkId

recreateManagedIds

public long recreateManagedIds(IdGroupingToken tokenId)

Recreate id and link id

Specified by:

recreateManagedIds in interface ManagedId

Overrides:

recreateManagedIds in class GraphEntityImpl

Parameters:

tokenId - to use

Returns:

created id (updated link Id is not returned)

clone

public LinkImpl clone()

Create a shallow copy of this entity

Specified by:

clone in interface Edge

Specified by:

clone in interface IdAble

Overrides:

clone in class DirectedEdgeImpl

Returns:

shallow copy of entity

validate

public boolean validate()

validate the contents of this edge

Specified by:

validate in interface Edge

Overrides:

validate in class EdgeImpl

Returns:

true when valid, false otherwise