org._3pq.jgrapht.graph
public class DefaultListenableGraph extends GraphDelegator implements ListenableGraph, java.lang.Cloneable
GraphListener
s and by
VertexSetListener
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.
GraphListener
,
VertexSetListener
,
Serialized FormConstructor and Description |
---|
DefaultListenableGraph(Graph g)
Creates a new listenable graph.
|
DefaultListenableGraph(Graph g,
boolean reuseEvents)
Creates a new listenable graph.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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 the
reuseEvents flag is set. |
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.
|
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 the
reuseEvents flag is set to true this
class will reuse previously fired events and will not create a new
object for each event. |
containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, toString, vertexSet
addAllEdges, addAllVertices, assertVertexExist, containsEdge, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toStringFromSets
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addAllEdges, addAllVertices, containsEdge, containsEdge, containsVertex, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, removeAllEdges, removeAllEdges, removeAllVertices, vertexSet
public DefaultListenableGraph(Graph g)
g
- the backing graph.public DefaultListenableGraph(Graph g, boolean reuseEvents)
reuseEvents
flag is
set to true
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.g
- the backing graph.reuseEvents
- whether to reuse previously fired event objects
instead of creating a new event object for each event.java.lang.IllegalArgumentException
- if the backing graph is already a
listenable graph.public void setReuseEvents(boolean reuseEvents)
reuseEvents
flag is set to true
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.reuseEvents
- whether to reuse previously fired event objects
instead of creating a new event object for each event.public boolean isReuseEvents()
reuseEvents
flag is set. If the flag is
set to true
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.reuseEvents
flag.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 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 void addGraphListener(GraphListener l)
ListenableGraph
addGraphListener
in interface ListenableGraph
l
- the listener to be added.ListenableGraph.addGraphListener(GraphListener)
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 void addVertexSetListener(VertexSetListener l)
ListenableGraph
addVertexSetListener
in interface ListenableGraph
l
- the listener to be added.ListenableGraph.addVertexSetListener(VertexSetListener)
public java.lang.Object clone()
clone
in class java.lang.Object
Object.clone()
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 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 void removeGraphListener(GraphListener l)
ListenableGraph
removeGraphListener
in interface ListenableGraph
l
- he listener to be removed.ListenableGraph.removeGraphListener(GraphListener)
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)
public void removeVertexSetListener(VertexSetListener l)
ListenableGraph
removeVertexSetListener
in interface ListenableGraph
l
- the listener to be removed.ListenableGraph.removeVertexSetListener(VertexSetListener)
protected void fireEdgeAdded(Edge edge)
edge
- the edge that was added.protected void fireEdgeRemoved(Edge edge)
edge
- the edge that was removed.protected void fireVertexAdded(java.lang.Object vertex)
vertex
- the vertex that was added.protected void fireVertexRemoved(java.lang.Object vertex)
vertex
- the vertex that was removed.