Class DefaultListenableGraph
- java.lang.Object
-
- org._3pq.jgrapht.graph.AbstractGraph
-
- org._3pq.jgrapht.graph.GraphDelegator
-
- org._3pq.jgrapht.graph.DefaultListenableGraph
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,Graph
,ListenableGraph
- Direct Known Subclasses:
ListenableDirectedGraph
,ListenableUndirectedGraph
public class DefaultListenableGraph extends GraphDelegator implements ListenableGraph, java.lang.Cloneable
A graph backed by the the graph specified at the constructor, which can be listened byGraphListener
s and byVertexSetListener
s. 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.
- Since:
- Jul 20, 2003
- Author:
- Barak Naveh
- See Also:
GraphListener
,VertexSetListener
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DefaultListenableGraph(Graph g)
Creates a new listenable graph.DefaultListenableGraph(Graph g, boolean reuseEvents)
Creates a new listenable graph.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.void
addGraphListener(GraphListener l)
Adds the specified graph listener to this graph, if not already present.boolean
addVertex(java.lang.Object v)
Adds the specified vertex to this graph if not already present.void
addVertexSetListener(VertexSetListener l)
Adds the specified vertex set listener to this graph, if not already present.java.lang.Object
clone()
protected void
fireEdgeAdded(Edge edge)
Notify listeners that the specified edge was added.protected void
fireEdgeRemoved(Edge edge)
Notify listeners that the specified edge was removed.protected void
fireVertexAdded(java.lang.Object vertex)
Notify listeners that the specified vertex was added.protected void
fireVertexRemoved(java.lang.Object vertex)
Notify listeners that the specified vertex was removed.boolean
isReuseEvents()
Tests whether thereuseEvents
flag is set.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.void
removeGraphListener(GraphListener l)
Removes the specified graph listener from this graph, if present.boolean
removeVertex(java.lang.Object v)
Removes the specified vertex from this graph including all its touching edges if present.void
removeVertexSetListener(VertexSetListener l)
Removes the specified vertex set listener from this graph, if present.void
setReuseEvents(boolean reuseEvents)
If thereuseEvents
flag is set totrue
this class will reuse previously fired events and will not create a new object for each event.-
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
addAllEdges, addAllVertices, assertVertexExist, containsEdge, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toStringFromSets
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org._3pq.jgrapht.Graph
addAllEdges, addAllVertices, containsEdge, containsEdge, containsVertex, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, removeAllEdges, removeAllEdges, removeAllVertices, vertexSet
-
-
-
-
Constructor Detail
-
DefaultListenableGraph
public DefaultListenableGraph(Graph g)
Creates a new listenable graph.- Parameters:
g
- the backing graph.
-
DefaultListenableGraph
public DefaultListenableGraph(Graph g, boolean reuseEvents)
Creates a new listenable graph. If thereuseEvents
flag is set totrue
this class will reuse previously fired events and will not create a new object for each event. This option increases performance but should be used with care, especially in multithreaded environment.- Parameters:
g
- the backing graph.reuseEvents
- whether to reuse previously fired event objects instead of creating a new event object for each event.- Throws:
java.lang.IllegalArgumentException
- if the backing graph is already a listenable graph.
-
-
Method Detail
-
setReuseEvents
public void setReuseEvents(boolean reuseEvents)
If thereuseEvents
flag is set totrue
this class will reuse previously fired events and will not create a new object for each event. This option increases performance but should be used with care, especially in multithreaded environment.- Parameters:
reuseEvents
- whether to reuse previously fired event objects instead of creating a new event object for each event.
-
isReuseEvents
public boolean isReuseEvents()
Tests whether thereuseEvents
flag is set. If the flag is set totrue
this class will reuse previously fired events and will not create a new object for each event. This option increases performance but should be used with care, especially in multithreaded environment.- Returns:
- the value of the
reuseEvents
flag.
-
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)
-
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)
-
addGraphListener
public void addGraphListener(GraphListener l)
Description copied from interface:ListenableGraph
Adds the specified graph listener to this graph, if not already present.- Specified by:
addGraphListener
in interfaceListenableGraph
- Parameters:
l
- the listener to be added.- See Also:
ListenableGraph.addGraphListener(GraphListener)
-
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)
-
addVertexSetListener
public void addVertexSetListener(VertexSetListener l)
Description copied from interface:ListenableGraph
Adds the specified vertex set listener to this graph, if not already present.- Specified by:
addVertexSetListener
in interfaceListenableGraph
- Parameters:
l
- the listener to be added.- See Also:
ListenableGraph.addVertexSetListener(VertexSetListener)
-
clone
public java.lang.Object clone()
- Overrides:
clone
in classjava.lang.Object
- See Also:
Object.clone()
-
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)
-
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)
-
removeGraphListener
public void removeGraphListener(GraphListener l)
Description copied from interface:ListenableGraph
Removes the specified graph listener from this graph, if present.- Specified by:
removeGraphListener
in interfaceListenableGraph
- Parameters:
l
- he listener to be removed.- See Also:
ListenableGraph.removeGraphListener(GraphListener)
-
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)
-
removeVertexSetListener
public void removeVertexSetListener(VertexSetListener l)
Description copied from interface:ListenableGraph
Removes the specified vertex set listener from this graph, if present.- Specified by:
removeVertexSetListener
in interfaceListenableGraph
- Parameters:
l
- the listener to be removed.- See Also:
ListenableGraph.removeVertexSetListener(VertexSetListener)
-
fireEdgeAdded
protected void fireEdgeAdded(Edge edge)
Notify listeners that the specified edge was added.- Parameters:
edge
- the edge that was added.
-
fireEdgeRemoved
protected void fireEdgeRemoved(Edge edge)
Notify listeners that the specified edge was removed.- Parameters:
edge
- the edge that was removed.
-
fireVertexAdded
protected void fireVertexAdded(java.lang.Object vertex)
Notify listeners that the specified vertex was added.- Parameters:
vertex
- the vertex that was added.
-
fireVertexRemoved
protected void fireVertexRemoved(java.lang.Object vertex)
Notify listeners that the specified vertex was removed.- Parameters:
vertex
- the vertex that was removed.
-
-