|
|||||||||
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
org._3pq.jgrapht.graph.UnmodifiableGraph
public class UnmodifiableGraph
An unmodifiable view of the backing graph specified in the constructor. This
graph allows modules to provide users with "read-only" access to internal
graphs. Query operations on this graph "read through" to the backing graph,
and attempts to modify this graph result in an
UnsupportedOperationException
.
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 graph will be serializable if the backing graph is serializable.
Constructor Summary | |
---|---|
UnmodifiableGraph(Graph g)
Creates a new unmodifiable graph based on the specified backing graph. |
Method Summary | |
---|---|
boolean |
addAllEdges(java.util.Collection edges)
Adds all of the specified edges to this graph. |
boolean |
addAllVertices(java.util.Collection vertices)
Adds all of the specified vertices to this graph. |
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 |
removeAllEdges(java.util.Collection edges)
Removes all the edges in this graph that are also contained in the specified edge collection. |
java.util.List |
removeAllEdges(java.lang.Object sourceVertex,
java.lang.Object targetVertex)
Removes all the edges going from the specified source vertex to the specified target vertex, and returns a list of all removed edges. |
boolean |
removeAllVertices(java.util.Collection vertices)
Removes all the vertices in this graph that are also contained in the specified vertex collection. |
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. |
Methods inherited from class org._3pq.jgrapht.graph.GraphDelegator |
---|
containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, toString, vertexSet |
Methods inherited from class org._3pq.jgrapht.graph.AbstractGraph |
---|
assertVertexExist, containsEdge, removeAllEdges, 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 |
---|
containsEdge |
Constructor Detail |
---|
public UnmodifiableGraph(Graph g)
g
- the backing graph on which an unmodifiable graph is to be
created.Method Detail |
---|
public boolean addAllEdges(java.util.Collection edges)
Graph
Graph.addEdge(Edge)
method.
addAllEdges
in interface Graph
addAllEdges
in class AbstractGraph
edges
- the edges to be added to this graph.
Graph.addAllEdges(Collection)
public boolean addAllVertices(java.util.Collection vertices)
Graph
Graph.addVertex(Object)
method.
addAllVertices
in interface Graph
addAllVertices
in class AbstractGraph
vertices
- the vertices to be added to this graph.
Graph.addAllVertices(Collection)
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
addEdge
in class GraphDelegator
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
addEdge
in class GraphDelegator
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
addVertex
in class GraphDelegator
v
- vertex to be added to this graph.
Graph.addVertex(Object)
public boolean removeAllEdges(java.util.Collection edges)
Graph
Graph.removeEdge(Edge)
method.
removeAllEdges
in interface Graph
removeAllEdges
in class AbstractGraph
edges
- edges to be removed from this graph.
Graph.removeAllEdges(Collection)
public java.util.List removeAllEdges(java.lang.Object sourceVertex, java.lang.Object targetVertex)
Graph
null
if any of the specified vertices does exist
in the graph. If both vertices exist but no edge found, returns an
empty list. This method will either invoke the Graph.removeEdge(Edge)
method, or the Graph.removeEdge(Object, Object)
method.
removeAllEdges
in interface Graph
removeAllEdges
in class AbstractGraph
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.
null
if no edge removed.Graph.removeAllEdges(Object, Object)
public boolean removeAllVertices(java.util.Collection vertices)
Graph
Graph.removeVertex(Object)
method.
removeAllVertices
in interface Graph
removeAllVertices
in class AbstractGraph
vertices
- vertices to be removed from this graph.
Graph.removeAllVertices(Collection)
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
removeEdge
in class GraphDelegator
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
removeEdge
in class GraphDelegator
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
removeVertex
in class GraphDelegator
v
- vertex to be removed from this graph, if present.
true
if the graph contained the specified vertex;
false
otherwise.Graph.removeVertex(Object)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |