Package org.goplanit.utils.graph

Interface ConjugateEdgeFactory

All Superinterfaces:

GraphEntityFactory<ConjugateEdge>, ManagedIdEntityFactory<ConjugateEdge>

public interface ConjugateEdgeFactory
extends GraphEntityFactory<ConjugateEdge>

Factory interface for creating conjugate instances

Author:

markr

Method Summary

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

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

createUniqueDeepCopyOf, createUniqueShallowCopyOf, getIdGroupingToken, setIdGroupingToken

Method Detail

registerNew

default ConjugateEdge registerNew(ConjugateVertex vertexA,
                                  ConjugateVertex vertexB,
                                  Edge originalEdge)
                           throws PlanItException

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

Parameters:

vertexA - the first conjugate vertex of this conjugate edge

vertexB - the second conjugate vertex of this conjugate edge

originalEdge - this conjugate represents

Returns:

the created edge

Throws:

PlanItException - thrown if there is an error

registerNew

ConjugateEdge registerNew(ConjugateVertex vertexA,
                          ConjugateVertex vertexB,
                          Edge originalEdge,
                          boolean registerOnVertices)
                   throws PlanItException

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

Parameters:

vertexA - the first conjugate vertex in this conjugate edge

vertexB - the second conjugate vertex in this conjugate edge

originalEdge - this conjugate represents

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

Returns:

the created edge

Throws:

PlanItException - thrown if there is an error