Package org.goplanit.utils.graph

Interface EdgeFactory

All Superinterfaces:

GraphEntityFactory<Edge>, ManagedIdEntityFactory<Edge>

All Known Implementing Classes:

EdgeFactoryImpl

public interface EdgeFactory
extends GraphEntityFactory<Edge>

Factory interface for creating edge instances

Author:

markr

Method Summary

Modifier and Type	Method	Description
default Edge	registerNew(Vertex vertexA, Vertex vertexB)	Create new edge to graph identified via its id, (not registered on vertices)
Edge	registerNew(Vertex vertexA, Vertex vertexB, boolean registerOnVertices)	Create new edge to network identified via its id, allow to be registered on vertices if indicated)

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

createUniqueDeepCopyOf, createUniqueShallowCopyOf, getIdGroupingToken, setIdGroupingToken

Method Detail

registerNew

default Edge registerNew(Vertex vertexA,
                         Vertex vertexB)
                  throws PlanItException

Create new edge to graph identified via its id, (not registered on vertices)

Parameters:

vertexA - the first vertex of this edge

vertexB - the second vertex of this edge

Returns:

the created edge

Throws:

PlanItException - thrown if there is an error

registerNew

Edge registerNew(Vertex vertexA,
                 Vertex vertexB,
                 boolean registerOnVertices)
          throws PlanItException

Create new edge to network identified via its id, allow to be registered on vertices if indicated)

Parameters:

vertexA - the first vertex in this edge

vertexB - the second vertex in this edge

registerOnVertices - choice to register new edge on the vertices or not

Returns:

the created edge

Throws:

PlanItException - thrown if there is an error