|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg._3pq.jgrapht.graph.AbstractGraph
org._3pq.jgrapht.graph.GraphDelegator
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.
Constructor Summary | |
GraphDelegator(Graph g)
Constructor for GraphDelegator. |
Method Summary | |
boolean |
addEdge(Edge e)
Adds the specified edge to this graph. |
Edge |
addEdge(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge. |
boolean |
addVertex(java.lang.Object v)
Adds the specified vertex to this graph if not already present. |
boolean |
containsEdge(Edge e)
Returns true if this graph contains the specified edge. |
boolean |
containsVertex(java.lang.Object v)
Returns true if this graph contains the specified vertex. |
int |
degreeOf(java.lang.Object vertex)
|
java.util.Set |
edgeSet()
Returns a set of the edges contained in this graph. |
java.util.List |
edgesOf(java.lang.Object vertex)
Returns a list of all edges touching the specified vertex. |
java.util.List |
getAllEdges(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Returns a list of all edges connecting source vertex to target vertex if such vertices exist in this graph. |
Edge |
getEdge(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph. |
EdgeFactory |
getEdgeFactory()
Returns the edge factory using which this graph creates new edges. |
java.util.List |
incomingEdgesOf(java.lang.Object vertex)
|
int |
inDegreeOf(java.lang.Object vertex)
|
int |
outDegreeOf(java.lang.Object vertex)
|
java.util.List |
outgoingEdgesOf(java.lang.Object vertex)
|
boolean |
removeEdge(Edge e)
Removes the specified edge from the graph. |
Edge |
removeEdge(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph. |
boolean |
removeVertex(java.lang.Object v)
Removes the specified vertex from this graph including all its touching edges if present. |
java.lang.String |
toString()
|
java.util.Set |
vertexSet()
Returns a set of the vertices contained in this graph. |
Methods inherited from class org._3pq.jgrapht.graph.AbstractGraph |
addAllEdges, addAllVertices, assertVertexExist, containsEdge, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toStringFromSets |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org._3pq.jgrapht.Graph |
addAllEdges, addAllVertices, containsEdge, removeAllEdges, removeAllEdges, removeAllVertices |
Constructor Detail |
public GraphDelegator(Graph g)
g
- the backing graph (the delegate).
java.lang.NullPointerException
Method Detail |
public java.util.List getAllEdges(java.lang.Object sourceVertex, java.lang.Object targetVertex)
Graph
null
, returns null
. If both
vertices exist but no edges found, returns an empty list.
In undirected graphs, some of the returned edges may have their source and target vertices in the opposite order. In simple graphs the returned list is either singleton list or empty list.
getAllEdges
in interface Graph
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.
Graph.getAllEdges(Object, Object)
public Edge getEdge(java.lang.Object sourceVertex, java.lang.Object targetVertex)
Graph
null
. If any of the specified vertices is
null
returns null
In undirected graphs, the returned edge may have its source and target vertices in the opposite order.
getEdge
in interface Graph
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.
Graph.getEdge(Object, Object)
public EdgeFactory getEdgeFactory()
Graph
getEdgeFactory
in interface Graph
Graph.getEdgeFactory()
public boolean addEdge(Edge e)
Graph
e
, to this graph if this graph contains no edge
e2
such that e2.equals(e)
. If this graph
already contains such edge, the call leaves this graph unchanged and
returns false. If the edge was added to the graph, returns
true
.
Some graphs do not allow edge-multiplicity. In such cases, if the graph
already contains an edge going from e.getSource()
vertex
to e.getTarget()
vertex, than this method does not change
the graph and returns false
.
The source and target vertices of the specified edge must already be in this graph. If this is not the case, IllegalArgumentException is thrown. The edge must also be assignment compatible with the class of the edges produced by the edge factory of this graph. If this is not the case ClassCastException is thrown.
addEdge
in interface Graph
e
- edge to be added to this graph.
Graph.addEdge(Edge)
public Edge addEdge(java.lang.Object sourceVertex, java.lang.Object targetVertex)
Graph
null
.
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's
EdgeFactory
. For the new edge to be added e
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 edge e2
such that e2.equals(e)
. If such
e2
is found then the newly created edge e
is
abandoned, the method leaves this graph unchanged returns
null
.
addEdge
in interface Graph
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.
null
.Graph.addEdge(Object, Object)
public boolean addVertex(java.lang.Object v)
Graph
v
, to this graph if
this graph contains no vertex u
such that
u.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.
addVertex
in interface Graph
v
- vertex to be added to this graph.
Graph.addVertex(Object)
public boolean containsEdge(Edge e)
Graph
e2
such that e.equals(e2)
. If the
specified edge is null
returns false
.
containsEdge
in interface Graph
e
- edge whose presence in this graph is to be tested.
Graph.containsEdge(Edge)
public boolean containsVertex(java.lang.Object v)
Graph
u
such that u.equals(v)
. If the
specified vertex is null
returns false
.
containsVertex
in interface Graph
v
- vertex whose presence in this graph is to be tested.
Graph.containsVertex(Object)
public int degreeOf(java.lang.Object vertex)
UndirectedGraph.degreeOf(Object)
public java.util.Set edgeSet()
Graph
edgeSet
in interface Graph
Graph.edgeSet()
public java.util.List edgesOf(java.lang.Object vertex)
Graph
edgesOf
in interface Graph
vertex
- the vertex for which a list of touching edges to be
returned.
Graph.edgesOf(Object)
public int inDegreeOf(java.lang.Object vertex)
DirectedGraph.inDegreeOf(Object)
public java.util.List incomingEdgesOf(java.lang.Object vertex)
DirectedGraph.incomingEdgesOf(Object)
public int outDegreeOf(java.lang.Object vertex)
DirectedGraph.outDegreeOf(Object)
public java.util.List outgoingEdgesOf(java.lang.Object vertex)
DirectedGraph.outgoingEdgesOf(Object)
public boolean removeEdge(Edge e)
Graph
e2
such that e2.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
returns false
.
removeEdge
in interface Graph
e
- edge to be removed from this graph, if present.
true
if and only if the graph contained the
specified edge.Graph.removeEdge(Edge)
public Edge removeEdge(java.lang.Object sourceVertex, java.lang.Object targetVertex)
Graph
null
otherwise.
removeEdge
in interface Graph
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.
null
if no edge removed.Graph.removeEdge(Object, Object)
public boolean removeVertex(java.lang.Object v)
Graph
u
such that u.equals(v)
, the call removes all
edges that touch u
and then removes u
itself.
If no such u
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
returns false
.
removeVertex
in interface Graph
v
- vertex to be removed from this graph, if present.
true
if the graph contained the specified vertex;
false
otherwise.Graph.removeVertex(Object)
public java.lang.String toString()
Object.toString()
public java.util.Set vertexSet()
Graph
vertexSet
in interface Graph
Graph.vertexSet()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |