Package org.goplanit.utils.graph.directed

Interface DirectedEdgeFactory

All Superinterfaces:

GraphEntityFactory<DirectedEdge>, ManagedIdEntityFactory<DirectedEdge>

All Known Implementing Classes:

DirectedEdgeFactoryImpl

public interface DirectedEdgeFactory
extends GraphEntityFactory<DirectedEdge>

Factory interface for creating directed edges.

Author:

markr

Method Summary

Modifier and Type	Method	Description
default DirectedEdge	registerNew(DirectedVertex vertexA, DirectedVertex vertexB)	Create and register new directed edge to graph identified via its id, (not registered on vertices)
DirectedEdge	registerNew(DirectedVertex vertexA, DirectedVertex 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 DirectedEdge registerNew(DirectedVertex vertexA,
                                 DirectedVertex vertexB)
                          throws PlanItException

Create and register new directed 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

DirectedEdge registerNew(DirectedVertex vertexA,
                         DirectedVertex 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