Package org.planit.graph

Class GraphBuilderImpl

java.lang.Object

org.planit.graph.GraphBuilderImpl

All Implemented Interfaces:

GraphBuilder<Vertex,Edge>

public class GraphBuilderImpl
extends Object
implements GraphBuilder<Vertex,Edge>

Create network entities for a physical network simulation model

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
protected IdGroupingToken	groupIdToken	the id group token

Constructor Summary

Constructors

Constructor	Description
GraphBuilderImpl(IdGroupingToken groupIdToken)	Constructor

Method Summary

Modifier and Type	Method	Description
Edge	createEdge(Vertex vertexA, Vertex vertexB, double length)	Create a new link instance
Edge	createUniqueCopyOf(Edge edgeToCopy)	create a shallo copy of the passed in edge, albeit with unique internal ids
Vertex	createVertex()	Create a new vertex instance
IdGroupingToken	getIdGroupingToken()	Collect the id grouping token used by this builder
void	recreateIds(Edges<? extends Edge> edges)	recreate the ids for all passed in edges
void	recreateIds(Vertices<? extends Vertex> vertices)	recreate the ids for all passed in vertices
void	setIdGroupingToken(IdGroupingToken groupIdToken)	Each builder needs a group if token to allow all underlying factory methods to generated ids uniquely tied to the group the entities belong to

Methods inherited from class java.lang.Object

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

Field Detail

groupIdToken

protected IdGroupingToken groupIdToken

the id group token

Constructor Detail

GraphBuilderImpl

public GraphBuilderImpl(IdGroupingToken groupIdToken)

Constructor

Parameters:

groupIdToken - to use for creating element ids

Method Detail

createVertex

public Vertex createVertex()

Create a new vertex instance

Specified by:

createVertex in interface GraphBuilder<Vertex,Edge>

Returns:

created vertex

createEdge

public Edge createEdge(Vertex vertexA,
                       Vertex vertexB,
                       double length)
                throws PlanItException

Create a new link instance

Specified by:

createEdge in interface GraphBuilder<Vertex,Edge>

Parameters:

vertexA - the first vertex in this edge

vertexB - the second vertex in this edge

length - the length (in km)

Returns:

created edge

Throws:

PlanItException - thrown if there is an error

setIdGroupingToken

public void setIdGroupingToken(IdGroupingToken groupIdToken)

Each builder needs a group if token to allow all underlying factory methods to generated ids uniquely tied to the group the entities belong to

Specified by:

setIdGroupingToken in interface GraphBuilder<Vertex,Edge>

Parameters:

groupIdToken - , contiguous id generation within this group for instances created with the factory methods

getIdGroupingToken

public IdGroupingToken getIdGroupingToken()

Collect the id grouping token used by this builder

Specified by:

getIdGroupingToken in interface GraphBuilder<Vertex,Edge>

Returns:

idGroupingToken the id grouping token used by this builder

recreateIds

public void recreateIds(Edges<? extends Edge> edges)

recreate the ids for all passed in edges

Specified by:

recreateIds in interface GraphBuilder<Vertex,Edge>

Parameters:

edges - to recreate ids for

recreateIds

public void recreateIds(Vertices<? extends Vertex> vertices)

recreate the ids for all passed in vertices

Specified by:

recreateIds in interface GraphBuilder<Vertex,Edge>

Parameters:

vertices - to recreate ids for

createUniqueCopyOf

public Edge createUniqueCopyOf(Edge edgeToCopy)

create a shallo copy of the passed in edge, albeit with unique internal ids

Specified by:

createUniqueCopyOf in interface GraphBuilder<Vertex,Edge>

Parameters:

edgeToCopy - the edge to copy

Returns:

new edge based on passed in edge