Class UnmodifiableGraph
- java.lang.Object
-
- org._3pq.jgrapht.graph.AbstractGraph
-
- org._3pq.jgrapht.graph.GraphDelegator
-
- org._3pq.jgrapht.graph.UnmodifiableGraph
-
- All Implemented Interfaces:
java.io.Serializable
,Graph
- Direct Known Subclasses:
UnmodifiableDirectedGraph
,UnmodifiableUndirectedGraph
public class UnmodifiableGraph extends GraphDelegator implements java.io.Serializable
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 anUnsupportedOperationException
.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.
- Since:
- Jul 24, 2003
- Author:
- Barak Naveh
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description UnmodifiableGraph(Graph g)
Creates a new unmodifiable graph based on the specified backing graph.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.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
addEdge(Edge e)
Adds the specified edge to this graph.boolean
addVertex(java.lang.Object v)
Adds the specified vertex to this graph if not already present.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
removeAllEdges(java.util.Collection edges)
Removes all the edges in this graph that are also contained in the specified edge collection.boolean
removeAllVertices(java.util.Collection vertices)
Removes all the vertices in this graph that are also contained in the specified vertex collection.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
removeEdge(Edge e)
Removes the specified edge from the 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
-
UnmodifiableGraph
public UnmodifiableGraph(Graph g)
Creates a new unmodifiable graph based on the specified backing graph.- Parameters:
g
- the backing graph on which an unmodifiable graph is to be created.
-
-
Method Detail
-
addAllEdges
public boolean addAllEdges(java.util.Collection edges)
Description copied from interface:Graph
Adds all of the specified edges to this graph. The behavior of this operation is undefined if the specified vertex collection is modified while the operation is in progress. This method will invoke theGraph.addEdge(Edge)
method.- Specified by:
addAllEdges
in interfaceGraph
- Overrides:
addAllEdges
in classAbstractGraph
- Parameters:
edges
- the edges to be added to this graph.- Returns:
- true if this graph changed as a result of the call
- See Also:
Graph.addAllEdges(Collection)
-
addAllVertices
public boolean addAllVertices(java.util.Collection vertices)
Description copied from interface:Graph
Adds all of the specified vertices to this graph. The behavior of this operation is undefined if the specified vertex collection is modified while the operation is in progress. This method will invoke theGraph.addVertex(Object)
method.- Specified by:
addAllVertices
in interfaceGraph
- Overrides:
addAllVertices
in classAbstractGraph
- Parameters:
vertices
- the vertices to be added to this graph.- Returns:
- true if this graph changed as a result of the call
- See Also:
Graph.addAllVertices(Collection)
-
addEdge
public boolean addEdge(Edge e)
Description copied from interface:Graph
Adds the specified edge to this graph. 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 edge, the call leaves this graph unchanged and returns false. If the edge was added to the graph, returnstrue
.Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge going from
e.getSource()
vertex toe.getTarget()
vertex, than this method does not change the graph and returnsfalse
.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.
- Specified by:
addEdge
in interfaceGraph
- Overrides:
addEdge
in classGraphDelegator
- Parameters:
e
- edge to be added to this graph.- Returns:
- true if this graph did not already contain the specified edge.
- See Also:
Graph.addEdge(Edge)
-
addEdge
public Edge addEdge(java.lang.Object sourceVertex, java.lang.Object targetVertex)
Description copied from interface:Graph
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
- Overrides:
addEdge
in classGraphDelegator
- 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.addEdge(Object, Object)
-
addVertex
public boolean addVertex(java.lang.Object v)
Description copied from interface:Graph
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.- Specified by:
addVertex
in interfaceGraph
- Overrides:
addVertex
in classGraphDelegator
- Parameters:
v
- vertex to be added to this graph.- Returns:
- true if this graph did not already contain the specified vertex.
- See Also:
Graph.addVertex(Object)
-
removeAllEdges
public boolean removeAllEdges(java.util.Collection edges)
Description copied from interface:Graph
Removes all the edges in this graph that are also contained in the specified edge collection. After this call returns, this graph will contain no edges in common with the specified edges. This method will invoke theGraph.removeEdge(Edge)
method.- Specified by:
removeAllEdges
in interfaceGraph
- Overrides:
removeAllEdges
in classAbstractGraph
- Parameters:
edges
- edges to be removed from this graph.- Returns:
- true if this graph changed as a result of the call
- See Also:
Graph.removeAllEdges(Collection)
-
removeAllEdges
public java.util.List removeAllEdges(java.lang.Object sourceVertex, java.lang.Object targetVertex)
Description copied from interface:Graph
Removes all the edges going from the specified source vertex to the specified target vertex, and returns a list of all removed edges. Returnsnull
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 theGraph.removeEdge(Edge)
method, or theGraph.removeEdge(Object, Object)
method.- Specified by:
removeAllEdges
in interfaceGraph
- Overrides:
removeAllEdges
in classAbstractGraph
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.- Returns:
- The removed edge, or
null
if no edge removed. - See Also:
Graph.removeAllEdges(Object, Object)
-
removeAllVertices
public boolean removeAllVertices(java.util.Collection vertices)
Description copied from interface:Graph
Removes all the vertices in this graph that are also contained in the specified vertex collection. After this call returns, this graph will contain no vertices in common with the specified vertices. This method will invoke theGraph.removeVertex(Object)
method.- Specified by:
removeAllVertices
in interfaceGraph
- Overrides:
removeAllVertices
in classAbstractGraph
- Parameters:
vertices
- vertices to be removed from this graph.- Returns:
- true if this graph changed as a result of the call
- See Also:
Graph.removeAllVertices(Collection)
-
removeEdge
public boolean removeEdge(Edge e)
Description copied from interface:Graph
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
- Overrides:
removeEdge
in classGraphDelegator
- Parameters:
e
- edge to be removed from this graph, if present.- Returns:
true
if and only if the graph contained the specified edge.- See Also:
Graph.removeEdge(Edge)
-
removeEdge
public Edge removeEdge(java.lang.Object sourceVertex, java.lang.Object targetVertex)
Description copied from interface:Graph
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
- Overrides:
removeEdge
in classGraphDelegator
- Parameters:
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.- Returns:
- The removed edge, or
null
if no edge removed. - See Also:
Graph.removeEdge(Object, Object)
-
removeVertex
public boolean removeVertex(java.lang.Object v)
Description copied from interface:Graph
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
- Overrides:
removeVertex
in classGraphDelegator
- Parameters:
v
- vertex to be removed from this graph, if present.- Returns:
true
if the graph contained the specified vertex;false
otherwise.- See Also:
Graph.removeVertex(Object)
-
-