Class GraphDelegator<V,E>
- java.lang.Object
-
- org.jgrapht.graph.AbstractGraph<V,E>
-
- org.jgrapht.graph.GraphDelegator<V,E>
-
- Type Parameters:
V
- the graph vertex typeE
- the graph edge type
- All Implemented Interfaces:
java.io.Serializable
,Graph<V,E>
- Direct Known Subclasses:
AsUndirectedGraph
,AsUnweightedGraph
,AsWeightedGraph
,DefaultListenableGraph
,EdgeReversedGraph
,ParanoidGraph
,UnmodifiableGraph
public class GraphDelegator<V,E> extends AbstractGraph<V,E> implements Graph<V,E>, java.io.Serializable
A graph backed by the the graph specified at the constructor, which delegates all its methods to the backing graph. Operations on this graph "pass through" to the to the backing graph. Any modification made to this graph or the backing graph is reflected by the other.This graph does not pass the hashCode and equals operations through to the backing graph, but relies on Object's equals and hashCode methods.
This class is mostly used as a base for extending subclasses.
- Since:
- Jul 20, 2003
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private Graph<V,E>
delegate
The graph to which operations are delegated.private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description GraphDelegator(Graph<V,E> g)
Constructor for GraphDelegator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description E
addEdge(V sourceVertex, V targetVertex)
Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge.boolean
addEdge(V sourceVertex, V targetVertex, E e)
Adds the specified edge to this graph, going from the source vertex to the target vertex.boolean
addVertex(V v)
Adds the specified vertex to this graph if not already present.boolean
containsEdge(E e)
Returns true if this graph contains the specified edge.boolean
containsVertex(V v)
Returns true if this graph contains the specified vertex.int
degreeOf(V vertex)
Returns the degree of the specified vertex.java.util.Set<E>
edgeSet()
Returns a set of the edges contained in this graph.java.util.Set<E>
edgesOf(V vertex)
Returns a set of all edges touching the specified vertex.java.util.Set<E>
getAllEdges(V sourceVertex, V targetVertex)
Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph.E
getEdge(V sourceVertex, V targetVertex)
Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph.EdgeFactory<V,E>
getEdgeFactory()
Returns the edge factory using which this graph creates new edges.V
getEdgeSource(E e)
Returns the source vertex of an edge.V
getEdgeTarget(E e)
Returns the target vertex of an edge.double
getEdgeWeight(E e)
Returns the weight assigned to a given edge.java.util.Set<E>
incomingEdgesOf(V vertex)
Returns a set of all edges incoming into the specified vertex.int
inDegreeOf(V vertex)
Returns the "in degree" of the specified vertex.int
outDegreeOf(V vertex)
Returns the "out degree" of the specified vertex.java.util.Set<E>
outgoingEdgesOf(V vertex)
Returns a set of all edges outgoing from the specified vertex.boolean
removeEdge(E e)
Removes the specified edge from the graph.E
removeEdge(V sourceVertex, V targetVertex)
Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph.boolean
removeVertex(V v)
Removes the specified vertex from this graph including all its touching edges if present.void
setEdgeWeight(E e, double weight)
Assigns a weight to an edge.java.lang.String
toString()
Returns a string of the parenthesized pair (V, E) representing this G=(V,E) graph.java.util.Set<V>
vertexSet()
Returns a set of the vertices contained in this graph.-
Methods inherited from class org.jgrapht.graph.AbstractGraph
assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toStringFromSets
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.jgrapht.Graph
containsEdge, removeAllEdges, removeAllEdges, removeAllVertices
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAllEdges
public java.util.Set<E> getAllEdges(V sourceVertex, V targetVertex)
Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph. If any of the vertices does not exist or isnull
, returnsnull
. If both vertices exist but no edges found, returns an empty set.In undirected graphs, some of the returned edges may have their source and target vertices in the opposite order. In simple graphs the returned set is either singleton set or empty set.
- Specified by:
getAllEdges
in interfaceGraph<V,E>
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.- Returns:
- a set of all edges connecting source vertex to target vertex.
-
getEdge
public E getEdge(V sourceVertex, V targetVertex)
Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph. Otherwise returnsnull
. If any of the specified vertices isnull
returnsnull
In undirected graphs, the returned edge may have its source and target vertices in the opposite order.
-
getEdgeFactory
public EdgeFactory<V,E> getEdgeFactory()
Returns the edge factory using which this graph creates new edges. The edge factory is defined when the graph is constructed and must not be modified.- Specified by:
getEdgeFactory
in interfaceGraph<V,E>
- Returns:
- the edge factory using which this graph creates new edges.
-
addEdge
public E addEdge(V sourceVertex, V targetVertex)
Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge. Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, than this method does not change the graph and returnsnull
.The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.
This method creates the new edge
e
using this graph'sEdgeFactory
. For the new edge to be addede
must not be equal to any other edge the graph (even if the graph allows edge-multiplicity). More formally, the graph must not contain any edgee2
such thate2.equals(e)
. If suche2
is found then the newly created edgee
is abandoned, the method leaves this graph unchanged returnsnull
.- Specified by:
addEdge
in interfaceGraph<V,E>
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.- Returns:
- The newly created edge if added to the graph, otherwise
null
. - See Also:
Graph.getEdgeFactory()
-
addEdge
public boolean addEdge(V sourceVertex, V targetVertex, E e)
Adds the specified edge to this graph, going from the source vertex to the target vertex. More formally, adds the specified edge,e
, to this graph if this graph contains no edgee2
such thate2.equals(e)
. If this graph already contains such an edge, the call leaves this graph unchanged and returns false. Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, than this method does not change the graph and returnsfalse
. If the edge was added to the graph, returnstrue
.The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.
- Specified by:
addEdge
in interfaceGraph<V,E>
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.e
- edge to be added to this graph.- Returns:
- true if this graph did not already contain the specified edge.
- See Also:
Graph.addEdge(Object, Object)
,Graph.getEdgeFactory()
-
addVertex
public boolean addVertex(V v)
Adds the specified vertex to this graph if not already present. More formally, adds the specified vertex,v
, to this graph if this graph contains no vertexu
such thatu.equals(v)
. If this graph already contains such vertex, the call leaves this graph unchanged and returns false. In combination with the restriction on constructors, this ensures that graphs never contain duplicate vertices.
-
containsEdge
public boolean containsEdge(E e)
Returns true if this graph contains the specified edge. More formally, returns true if and only if this graph contains an edgee2
such thate.equals(e2)
. If the specified edge isnull
returnsfalse
.- Specified by:
containsEdge
in interfaceGraph<V,E>
- Parameters:
e
- edge whose presence in this graph is to be tested.- Returns:
- true if this graph contains the specified edge.
-
containsVertex
public boolean containsVertex(V v)
Returns true if this graph contains the specified vertex. More formally, returns true if and only if this graph contains a vertexu
such thatu.equals(v)
. If the specified vertex isnull
returnsfalse
.- Specified by:
containsVertex
in interfaceGraph<V,E>
- Parameters:
v
- vertex whose presence in this graph is to be tested.- Returns:
- true if this graph contains the specified vertex.
-
degreeOf
public int degreeOf(V vertex)
Returns the degree of the specified vertex.- Parameters:
vertex
- vertex whose degree is to be calculated- Returns:
- the degree of the specified vertex
- See Also:
UndirectedGraph.degreeOf(Object)
-
edgeSet
public java.util.Set<E> edgeSet()
Returns a set of the edges contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.The graph implementation may maintain a particular set ordering (e.g. via
LinkedHashSet
) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.
-
edgesOf
public java.util.Set<E> edgesOf(V vertex)
Returns a set of all edges touching the specified vertex. If no edges are touching the specified vertex returns an empty set.
-
inDegreeOf
public int inDegreeOf(V vertex)
Returns the "in degree" of the specified vertex.- Parameters:
vertex
- vertex whose in degree is to be calculated- Returns:
- the in degree of the specified vertex
- See Also:
DirectedGraph.inDegreeOf(Object)
-
incomingEdgesOf
public java.util.Set<E> incomingEdgesOf(V vertex)
Returns a set of all edges incoming into the specified vertex.- Parameters:
vertex
- the vertex for which the list of incoming edges to be returned- Returns:
- a set of all edges incoming into the specified vertex
- See Also:
DirectedGraph.incomingEdgesOf(Object)
-
outDegreeOf
public int outDegreeOf(V vertex)
Returns the "out degree" of the specified vertex.- Parameters:
vertex
- vertex whose out degree is to be calculated- Returns:
- the out degree of the specified vertex
- See Also:
DirectedGraph.outDegreeOf(Object)
-
outgoingEdgesOf
public java.util.Set<E> outgoingEdgesOf(V vertex)
Returns a set of all edges outgoing from the specified vertex.- Parameters:
vertex
- the vertex for which the list of outgoing edges to be returned- Returns:
- a set of all edges outgoing from the specified vertex
- See Also:
DirectedGraph.outgoingEdgesOf(Object)
-
removeEdge
public boolean removeEdge(E e)
Removes the specified edge from the graph. Removes the specified edge from this graph if it is present. More formally, removes an edgee2
such thate2.equals(e)
, if the graph contains such edge. Returns true if the graph contained the specified edge. (The graph will not contain the specified edge once the call returns).If the specified edge is
null
returnsfalse
.- Specified by:
removeEdge
in interfaceGraph<V,E>
- Parameters:
e
- edge to be removed from this graph, if present.- Returns:
true
if and only if the graph contained the specified edge.
-
removeEdge
public E removeEdge(V sourceVertex, V targetVertex)
Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph. Returns the edge if removed ornull
otherwise.- Specified by:
removeEdge
in interfaceGraph<V,E>
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.- Returns:
- The removed edge, or
null
if no edge removed.
-
removeVertex
public boolean removeVertex(V v)
Removes the specified vertex from this graph including all its touching edges if present. More formally, if the graph contains a vertexu
such thatu.equals(v)
, the call removes all edges that touchu
and then removesu
itself. If no suchu
is found, the call leaves the graph unchanged. Returns true if the graph contained the specified vertex. (The graph will not contain the specified vertex once the call returns).If the specified vertex is
null
returnsfalse
.- Specified by:
removeVertex
in interfaceGraph<V,E>
- Parameters:
v
- vertex to be removed from this graph, if present.- Returns:
true
if the graph contained the specified vertex;false
otherwise.
-
toString
public java.lang.String toString()
Returns a string of the parenthesized pair (V, E) representing this G=(V,E) graph. 'V' is the string representation of the vertex set, and 'E' is the string representation of the edge set.- Overrides:
toString
in classAbstractGraph<V,E>
- Returns:
- a string representation of this graph.
-
vertexSet
public java.util.Set<V> vertexSet()
Returns a set of the vertices contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.The graph implementation may maintain a particular set ordering (e.g. via
LinkedHashSet
) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.
-
getEdgeSource
public V getEdgeSource(E e)
Returns the source vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).- Specified by:
getEdgeSource
in interfaceGraph<V,E>
- Parameters:
e
- edge of interest- Returns:
- source vertex
-
getEdgeTarget
public V getEdgeTarget(E e)
Returns the target vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).- Specified by:
getEdgeTarget
in interfaceGraph<V,E>
- Parameters:
e
- edge of interest- Returns:
- target vertex
-
getEdgeWeight
public double getEdgeWeight(E e)
Returns the weight assigned to a given edge. Unweighted graphs return 1.0 (as defined byWeightedGraph.DEFAULT_EDGE_WEIGHT
), allowing weighted-graph algorithms to apply to them where meaningful.- Specified by:
getEdgeWeight
in interfaceGraph<V,E>
- Parameters:
e
- edge of interest- Returns:
- edge weight
- See Also:
WeightedGraph
-
setEdgeWeight
public void setEdgeWeight(E e, double weight)
Assigns a weight to an edge.- Parameters:
e
- edge on which to set weightweight
- new weight for edge
-
-