salvo.jesus.graph.adaptor

Class GraphDelegator

java.lang.Object

salvo.jesus.graph.adaptor.GraphDelegator

All Implemented Interfaces:

Serializable, Graph

Direct Known Subclasses:

DirectedGraphDelegator

public abstract class GraphDelegator
extends Object
implements Graph

GraphDelegator is a utility base for creating adaptors which need to delegate most of their methods to an underlying Graph.

Author:

John V. Sichi

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GraphDelegator(Graph graph)

Method Summary

Modifier and Type	Method and Description
void	add(Vertex v) Adds a Vertex into the Graph.
void	addEdge(Edge e) Adds a previously-defined Edge into the Graph.
Edge	addEdge(Vertex v1, Vertex v2) Creates an edge between two vertices and adds it into the Graph.
void	addGraphAddEdgeListener(GraphAddEdgeListener listener) Adds a GraphAddEdgeListener to the Graph's internal List of GraphAddEdgeListeners so that when a new Edge is added, all registered GraphAddEdgeListeners are notified of the event.
void	addGraphAddVertexListener(GraphAddVertexListener listener) Adds a GraphAddVertexListener to the Graph's internal List of GraphAddVertexListeners so that when a new Vertex is added, all registered GraphAddVertedListeners are notified of the event.
void	addGraphRemoveEdgeListener(GraphRemoveEdgeListener listener) Adds a GraphRemoveEdgeListener to the Graph's internal List of GraphRemoveEdgeListeners so that when an Edge is removed, all registered GraphRemoveEdgeListeners are notified of the event.
void	addGraphRemoveVertexListener(GraphRemoveVertexListener listener) Adds a GraphRemoveVertexListener to the Graph's internal List of GraphRemoveVertexListeners so that when a Vertex is removed, all registered GraphRemoveVertexListeners are notified of the event.
void	addListener(GraphListener listener) Registers a GraphListener with this Graph.
List	cloneVertices() Returns a modifiable clone of the vertex set as a List in arbitrary order.
Set	getAdjacentVertices(List vertices) Returns the vertices adjacent to all the vertices in the given collection.
List	getAdjacentVertices(Vertex v) Returns the vertices adjacent to the specified vertex.
Collection	getConnectedSet() Returns the connected sets in the Graph.
Set	getConnectedSet(Vertex v) Returns the connected set to which the specified vertex belongs.
int	getDegree() Returns the degree of the graph, which is simply the highest degree of all the graph's vertices.
int	getDegree(Vertex v) Returns the degree of the vertex, which is simply the number of edges of the vertex.
List	getEdges(Vertex v) Returns a List of edges of the specified vertex.
int	getEdgesCount() Returns the number of edges in the graph
Set	getEdgeSet() Returns an unmodifiable set of the edges included in this graph.
protected Graph	getGraph()
GraphFactory	getGraphFactory() Returns the factory that will be responsible for creating Vertices and Edges in a Graph.
GraphTraversal	getTraversal() Gets the traversal algorithm used by the Graph.
Set	getVertexSet() Returns an unmodifiable set of the vertices included in this graph.
Set	getVertices(int degree) Returns all vertices with the specified degree.
int	getVerticesCount() Returns the number of vertices in the graph
Iterator	getVerticesIterator() Returns an iterator that iterates through the graph's vertices in arbitrary order.
boolean	isConnected(Vertex v1, Vertex v2) Determines if two vertices are connected
void	remove(Vertex v) Removes the specified Vertex and all of its incident edges from the Graph.
void	removeEdge(Edge e) Removes the specified Edge from the Graph, and notifies listeners.
void	removeEdges(Vertex v) Removes incident Edges of a Vertex.
void	removeGraphAddEdgeListener(GraphAddEdgeListener listener) Removes a GraphAddEdgeListener from the Graph's internal List of GraphAddEdgeListeners.
void	removeGraphAddVertexListener(GraphAddVertexListener listener) Removes a GraphAddVertexListener from the Graph's internal List of GraphAddVertexListeners.
void	removeGraphRemoveEdgeListener(GraphRemoveEdgeListener listener) Removes a GraphRemoveEdgeListener from the Graph's internal List of GraphRemoveEdgeListeners.
void	removeGraphRemoveVertexListener(GraphRemoveVertexListener listener) Removes a GraphRemoveVertexListener from the Graph's internal List of GraphRemoveVertexListeners.
void	removeListener(GraphListener listener) Unregisters a GraphListener currently attached to this Graph.
void	setGraphFactory(GraphFactory factory) Sets the factory that will be responsible for creating Vertices and Edges in a Graph.
void	setTraversal(GraphTraversal traversal) Sets the graph traversal algorithm to be used
List	traverse(Vertex startat) Traverses the Graph starting at startat Vertex by performing a depth-first traversal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GraphDelegator

protected GraphDelegator(Graph graph)

Method Detail

getGraph

protected final Graph getGraph()

getVertexSet

public Set getVertexSet()

Description copied from interface: Graph

Returns an unmodifiable set of the vertices included in this graph.

Specified by:

getVertexSet in interface Graph

Returns:

Set of Vertices

getEdgeSet

public Set getEdgeSet()

Description copied from interface: Graph

Returns an unmodifiable set of the edges included in this graph.

Specified by:

getEdgeSet in interface Graph

Returns:

Set of Edges

getEdgesCount

public int getEdgesCount()

Description copied from interface: Graph

Returns the number of edges in the graph

Specified by:

getEdgesCount in interface Graph

Returns:

The number of edges in the graph.

getVerticesCount

public int getVerticesCount()

Description copied from interface: Graph

Returns the number of vertices in the graph

Specified by:

getVerticesCount in interface Graph

Returns:

The number of vertices in the graph.

getGraphFactory

public GraphFactory getGraphFactory()

Description copied from interface: Graph

Returns the factory that will be responsible for creating Vertices and Edges in a Graph.

Specified by:

getGraphFactory in interface Graph

setGraphFactory

public void setGraphFactory(GraphFactory factory)

Description copied from interface: Graph

Sets the factory that will be responsible for creating Vertices and Edges in a Graph.

Specified by:

setGraphFactory in interface Graph

add

public void add(Vertex v)
         throws Exception

Description copied from interface: Graph

Adds a Vertex into the Graph. All GraphListeners are informed of the event that a Vertex has been added to the Graph. Note that this method is not called when a vertex is added implicitly due to edge addition.

Specified by:

add in interface Graph

Parameters:

v - Vertex to be added to the Graph

Throws:

Exception

remove

public void remove(Vertex v)
            throws Exception

Description copied from interface: Graph

Removes the specified Vertex and all of its incident edges from the Graph. All GraphListeners are informed of events for the vertex and edges.

Specified by:

remove in interface Graph

Throws:

Exception

getVerticesIterator

public Iterator getVerticesIterator()

Description copied from interface: Graph

Returns an iterator that iterates through the graph's vertices in arbitrary order.

Specified by:

getVerticesIterator in interface Graph

Returns:

An iterator of List vertices.

cloneVertices

public List cloneVertices()

Description copied from interface: Graph

Returns a modifiable clone of the vertex set as a List in arbitrary order.

Specified by:

cloneVertices in interface Graph

Returns:

List of Vertices

addEdge

public Edge addEdge(Vertex v1,
                    Vertex v2)
             throws Exception

Description copied from interface: Graph

Creates an edge between two vertices and adds it into the Graph. All GraphListeners are informed of the event that a Edge has been added to the Graph. If the vertices of the Edge are not already part of the graph, they are implicitly added, and listeners are notified of them as well.

Specified by:

addEdge in interface Graph

Parameters:

v1 - One endpoint of the edge

v2 - Other endpoint of the edge

Returns:

The Edge object created and added to the Graph.

Throws:

Exception

addEdge

public void addEdge(Edge e)
             throws Exception

Description copied from interface: Graph

Adds a previously-defined Edge into the Graph. All GraphListeners are informed of the event that the Edge has been added to the Graph. If the vertices of the Edge are not already part of the graph, they are implicitly added, and listeners are notified of them as well.

Note: It is the caller's responsibility to make sure that the type of Edge being added to the Graph matches the Graph. For example, only a DirectedEdge must be added to a DirectedGraph.

Specified by:

addEdge in interface Graph

Parameters:

e - The edge to be added to the Graph.

Throws:

Exception

removeEdge

public void removeEdge(Edge e)
                throws Exception

Description copied from interface: Graph

Removes the specified Edge from the Graph, and notifies listeners. Note that this method is not called when an edge is removed implicitly due to vertex removal.

Specified by:

removeEdge in interface Graph

Parameters:

e - The Edge object to be removed.

Throws:

Exception

removeEdges

public void removeEdges(Vertex v)
                 throws Exception

Description copied from interface: Graph

Removes incident Edges of a Vertex. The Edges removed are those whose either endpoints has the specified vertex. This method leaves the specified Vertex as a disconnected singleton. Note that this method is not called implicitly when a vertex is removed.

Specified by:

removeEdges in interface Graph

Parameters:

v - Vertex whose Edges are to be removed

Throws:

Exception

getDegree

public int getDegree()

Description copied from interface: Graph

Returns the degree of the graph, which is simply the highest degree of all the graph's vertices.

Specified by:

getDegree in interface Graph

Returns:

An int indicating the degree of the graph.

getDegree

public int getDegree(Vertex v)

Description copied from interface: Graph

Returns the degree of the vertex, which is simply the number of edges of the vertex.

Specified by:

getDegree in interface Graph

Returns:

The degree of the vertex.

getVertices

public Set getVertices(int degree)

Description copied from interface: Graph

Returns all vertices with the specified degree.

Specified by:

getVertices in interface Graph

Parameters:

degree - The degree of the vertex to be returned.

Returns:

an unmodifiable set of vertices with the above specified degree.

getEdges

public List getEdges(Vertex v)

Description copied from interface: Graph

Returns a List of edges of the specified vertex.

Specified by:

getEdges in interface Graph

Parameters:

v - The vertex whose edges we want returned

Returns:

an unmodifiable List of Edges that are incident edges of the specified vertex.

getAdjacentVertices

public List getAdjacentVertices(Vertex v)

Description copied from interface: Graph

Returns the vertices adjacent to the specified vertex.

Specified by:

getAdjacentVertices in interface Graph

Parameters:

v - The Vertex you want to determine its adjacent vertices.

Returns:

an unmodifiable List of vertices adjacent to the specified vertex v.

getAdjacentVertices

public Set getAdjacentVertices(List vertices)

Description copied from interface: Graph

Returns the vertices adjacent to all the vertices in the given collection.

Specified by:

getAdjacentVertices in interface Graph

Parameters:

vertices - List of Vertex where each vertex in the returned Set must be adjacent to.

Returns:

unmodifiable Set of vertices adjacent to all the vertices in the supplied List.

getConnectedSet

public Collection getConnectedSet()

Description copied from interface: Graph

Returns the connected sets in the Graph. Each Set in the return Collection is a Set of vertices that are connected to each other, regardless of the direction or length of the paths connecting them together.

Specified by:

getConnectedSet in interface Graph

Returns:

unmodifiable Collection of unmodifiable Sets

getConnectedSet

public Set getConnectedSet(Vertex v)

Description copied from interface: Graph

Returns the connected set to which the specified vertex belongs.

Specified by:

getConnectedSet in interface Graph

Parameters:

v - Vertex to which you want the connected set returned.

Returns:

unmodifiable Set of connected vertices where the specified vertex belongs.

traverse

public List traverse(Vertex startat)

Description copied from interface: Graph

Traverses the Graph starting at startat Vertex by performing a depth-first traversal. The vertices traversed from startat are stored in Visited. Only the connected components to which startat belongs to will be traversed.

Specified by:

traverse in interface Graph

Parameters:

startat - The Vertex to which you want to start the traversal.

getTraversal

public GraphTraversal getTraversal()

Description copied from interface: Graph

Gets the traversal algorithm used by the Graph.

Specified by:

getTraversal in interface Graph

Returns:

GraphTraversal object performing traversal for the Graph.

setTraversal

public void setTraversal(GraphTraversal traversal)

Description copied from interface: Graph

Sets the graph traversal algorithm to be used

Specified by:

setTraversal in interface Graph

Parameters:

traversal - A concrete implementation of the GraphTraversal object.

isConnected

public boolean isConnected(Vertex v1,
                           Vertex v2)

Description copied from interface: Graph

Determines if two vertices are connected

Specified by:

isConnected in interface Graph

Parameters:

v1 - starting Vertex for the path

v2 - ending Vertex for the path

Returns:

true if v1 and v2 are connected.

addListener

public void addListener(GraphListener listener)

Description copied from interface: Graph

Registers a GraphListener with this Graph.

Specified by:

addListener in interface Graph

Parameters:

listener - the listener being registered, which will receive notifications of all graph modifications

removeListener

public void removeListener(GraphListener listener)

Description copied from interface: Graph

Unregisters a GraphListener currently attached to this Graph.

Specified by:

removeListener in interface Graph

Parameters:

listener - the listener being unregistered, which will cease receiving notifications

addGraphAddVertexListener

public void addGraphAddVertexListener(GraphAddVertexListener listener)

Description copied from interface: Graph

Adds a GraphAddVertexListener to the Graph's internal List of GraphAddVertexListeners so that when a new Vertex is added, all registered GraphAddVertedListeners are notified of the event.

Specified by:

addGraphAddVertexListener in interface Graph

Parameters:

listener - GraphAddVertexListener you want registered or be notified when a new Vertex is added

See Also:

GraphAddVertexListener, Graph.removeGraphAddVertexListener( GraphAddVertexListener ), Graph.addListener(salvo.jesus.graph.GraphListener)

addGraphAddEdgeListener

public void addGraphAddEdgeListener(GraphAddEdgeListener listener)

Description copied from interface: Graph

Adds a GraphAddEdgeListener to the Graph's internal List of GraphAddEdgeListeners so that when a new Edge is added, all registered GraphAddEdgeListeners are notified of the event.

Specified by:

addGraphAddEdgeListener in interface Graph

Parameters:

listener - GraphAddEdgeListener you want registered or be notified when a new Edge is added

See Also:

GraphAddEdgeListener, Graph.removeGraphAddEdgeListener( GraphAddEdgeListener ), Graph.addListener(salvo.jesus.graph.GraphListener)

addGraphRemoveEdgeListener

public void addGraphRemoveEdgeListener(GraphRemoveEdgeListener listener)

Description copied from interface: Graph

Adds a GraphRemoveEdgeListener to the Graph's internal List of GraphRemoveEdgeListeners so that when an Edge is removed, all registered GraphRemoveEdgeListeners are notified of the event.

Specified by:

addGraphRemoveEdgeListener in interface Graph

Parameters:

listener - GraphRemoveEdgeListener you want registered or be notified when an Edge is removed

See Also:

GraphRemoveEdgeListener, Graph.removeGraphRemoveEdgeListener( GraphRemoveEdgeListener ), Graph.addListener(salvo.jesus.graph.GraphListener)

addGraphRemoveVertexListener

public void addGraphRemoveVertexListener(GraphRemoveVertexListener listener)

Description copied from interface: Graph

Adds a GraphRemoveVertexListener to the Graph's internal List of GraphRemoveVertexListeners so that when a Vertex is removed, all registered GraphRemoveVertexListeners are notified of the event.

Specified by:

addGraphRemoveVertexListener in interface Graph

Parameters:

listener - GraphRemoveVertexListener you want registered or be notified when a Vertex is removed

See Also:

GraphRemoveVertexListener, Graph.removeGraphRemoveVertexListener( GraphRemoveVertexListener ), Graph.addListener(salvo.jesus.graph.GraphListener)

removeGraphAddVertexListener

public void removeGraphAddVertexListener(GraphAddVertexListener listener)

Description copied from interface: Graph

Removes a GraphAddVertexListener from the Graph's internal List of GraphAddVertexListeners.

Specified by:

removeGraphAddVertexListener in interface Graph

Parameters:

listener - GraphAddVertexListener you no longer want registered or be notified when a Vertex is added

See Also:

GraphAddVertexListener, Graph.addGraphAddVertexListener( GraphAddVertexListener ), Graph.removeListener(salvo.jesus.graph.GraphListener)

removeGraphAddEdgeListener

public void removeGraphAddEdgeListener(GraphAddEdgeListener listener)

Description copied from interface: Graph

Removes a GraphAddEdgeListener from the Graph's internal List of GraphAddEdgeListeners.

Specified by:

removeGraphAddEdgeListener in interface Graph

Parameters:

listener - GraphAddEdgeListener you no longer want registered or be notified when an Edge is added

See Also:

GraphAddEdgeListener, Graph.addGraphAddEdgeListener( GraphAddEdgeListener ), Graph.removeListener(salvo.jesus.graph.GraphListener)

removeGraphRemoveEdgeListener

public void removeGraphRemoveEdgeListener(GraphRemoveEdgeListener listener)

Description copied from interface: Graph

Removes a GraphRemoveEdgeListener from the Graph's internal List of GraphRemoveEdgeListeners.

Specified by:

removeGraphRemoveEdgeListener in interface Graph

Parameters:

listener - GraphRemoveEdgeListener you no longer want registered or be notified when an Edge is removed

See Also:

GraphRemoveEdgeListener, Graph.addGraphRemoveEdgeListener( GraphRemoveEdgeListener ), Graph.removeListener(salvo.jesus.graph.GraphListener)

removeGraphRemoveVertexListener

public void removeGraphRemoveVertexListener(GraphRemoveVertexListener listener)

Description copied from interface: Graph

Removes a GraphRemoveVertexListener from the Graph's internal List of GraphRemoveVertexListeners.

Specified by:

removeGraphRemoveVertexListener in interface Graph

Parameters:

listener - GraphRemoveVertexListener you no longer want registered or be notified when a Vertex is removed

See Also:

GraphRemoveVertexListener, Graph.addGraphRemoveVertexListener( GraphRemoveVertexListener ), Graph.removeListener(salvo.jesus.graph.GraphListener)