Package org.planit.graph

Class VertexImpl

java.lang.Object

org.planit.graph.VertexImpl

All Implemented Interfaces:

Serializable, Comparable<Vertex>, Vertex

Direct Known Subclasses:

CentroidImpl, NodeImpl

public class VertexImpl
extends Object
implements Vertex

Node representation connected to one or more entry and exit links

Author:

markr

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	VertexImpl.EdgeSegmentsImpl	EdgeSegment container
class	VertexImpl.EdgesImpl	edges of this vertex

Nested classes/interfaces inherited from interface org.planit.utils.graph.Vertex

Vertex.Edges, Vertex.EdgeSegments

Field Summary

Fields

Modifier and Type	Field	Description
protected org.opengis.geometry.DirectPosition	centrePointGeometry	Centre point geometry which is coordinate reference system aware
protected Vertex.Edges	edges	edge container
protected Vertex.EdgeSegments	entryEdgeSegments	entryEdgeSegment container
protected Vertex.EdgeSegments	exitEdgeSegments	exitEdgeSegmentcontainer
protected long	id	Unique internal identifier
protected Map<String,Object>	inputProperties	generic input property storage

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VertexImpl(IdGroupingToken groupId)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addInputProperty(String key, Object value)	Add a property from the original input that is not part of the readily available members
int	compareTo(Vertex o)	Compare vertices by their id
protected static int	generateVertexId(IdGroupingToken groupId)	generate unique node id
org.opengis.geometry.DirectPosition	getCentrePointGeometry()	Collect the geometry of the point location of this vertex
Vertex.Edges	getEdges()	#Collect the edges of this vertex
Vertex.EdgeSegments	getEntryEdgeSegments()	#Collect the entry edge segments of this vertex
Vertex.EdgeSegments	getExitEdgeSegments()	#Collect the exit edge segments of this vertex
long	getId()	#Return id of this instance.
Object	getInputProperty(String key)	Get input property by its key
void	setCentrePointGeometry(org.opengis.geometry.DirectPosition centrePointGeometry)	#Set the center point geometry for a vertex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

centrePointGeometry

protected org.opengis.geometry.DirectPosition centrePointGeometry

Centre point geometry which is coordinate reference system aware

id

protected final long id

Unique internal identifier

inputProperties

protected Map<String,Object> inputProperties

generic input property storage

edges

protected final Vertex.Edges edges

edge container

exitEdgeSegments

protected final Vertex.EdgeSegments exitEdgeSegments

exitEdgeSegmentcontainer

entryEdgeSegments

protected final Vertex.EdgeSegments entryEdgeSegments

entryEdgeSegment container

Constructor Detail

VertexImpl

protected VertexImpl(IdGroupingToken groupId)

Constructor

Parameters:

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

Method Detail

generateVertexId

protected static int generateVertexId(IdGroupingToken groupId)

generate unique node id

Parameters:

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

Returns:

nodeId

getCentrePointGeometry

public org.opengis.geometry.DirectPosition getCentrePointGeometry()

Collect the geometry of the point location of this vertex

Specified by:

getCentrePointGeometry in interface Vertex

Returns:

direct position reflecting point location

setCentrePointGeometry

public void setCentrePointGeometry(org.opengis.geometry.DirectPosition centrePointGeometry)

#Set the center point geometry for a vertex

Specified by:

setCentrePointGeometry in interface Vertex

Parameters:

centrePointGeometry - the center point for a vertex

getId

public long getId()

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

Specified by:

getId in interface Vertex

Returns:

the id

addInputProperty

public void addInputProperty(String key,
                             Object value)

Add a property from the original input that is not part of the readily available members

Parameters:

key - key (name) of the input property

value - value of the input property

getInputProperty

public Object getInputProperty(String key)

Get input property by its key

Parameters:

key - the key of the input property

Returns:

value the value of the input property

compareTo

public int compareTo(Vertex o)

Compare vertices by their id

Specified by:

compareTo in interface Comparable<Vertex>

Parameters:

o - Vertex object to be compared to this one

Returns:

result of comparison

See Also:

Comparable.compareTo(java.lang.Object)

getEntryEdgeSegments

public Vertex.EdgeSegments getEntryEdgeSegments()

#Collect the entry edge segments of this vertex

Specified by:

getEntryEdgeSegments in interface Vertex

Returns:

edgeSegments

getExitEdgeSegments

public Vertex.EdgeSegments getExitEdgeSegments()

#Collect the exit edge segments of this vertex

Specified by:

getExitEdgeSegments in interface Vertex

Returns:

edgeSegments

getEdges

public Vertex.Edges getEdges()

#Collect the edges of this vertex

Specified by:

getEdges in interface Vertex

Returns:

edges