salvo.jesus.graph

Class GraphImpl

java.lang.Object

salvo.jesus.graph.GraphImpl

All Implemented Interfaces:

Serializable, Graph

Direct Known Subclasses:

CyclePathImpl, DirectedGraphImpl, PathImpl, SimplePathImpl, TreeImpl, WeightedGraphImpl

public class GraphImpl
extends Object
implements Graph

An implementation of the Graph interface. GraphImpl represents a materialized graph data structure in the form of a set of incidence lists (one for each vertex). GraphImpl relies on hashing, so the Vertex and Edge implementations used must have well-behaved implementations of equals and hashCode (the basic Object implementations of these methods work and are the most efficient for most uses). $Id: GraphImpl.java,v 1.24 2002/08/24 07:32:24 jmsalvo Exp $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected GraphFactory	factory Reference to the instance of GraphFactory responsible for creating Vertices and Edges.
protected GraphTraversal	traversal Delegate object for implementing graph traversal.

Constructor Summary

Constructors

Constructor and Description
GraphImpl()

Method Summary

Modifier and Type	Method and Description
void	add(Vertex newvertex) This implementation of add(Vertex) should not normally be overridden by subclasses.
void	addEdge(Edge edge) This implementation of addEdge should not normally be overridden by subclasses.
Edge	addEdge(Vertex v1, Vertex v2) This implementation of addEdge should not normally be overridden by subclasses.
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 clone of the List of vertices.
boolean	containsEdge(Edge edge) Test whether an edge is included in this graph.
boolean	containsVertex(Vertex v) Test whether a vertex is included in this graph.
void	forgetConnectedSets() Forget any information which has been incrementally maintained about this graph's connected sets.
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 an unmodifiable 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.
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 a read-only iterator that iterates through the graph's vertices.
boolean	isConnected(Vertex v1, Vertex v2) Determines if two vertices are connected
void	remove(Vertex v) This implementation of remove should not normally be overridden by subclasses.
void	removeEdge(Edge edge) This implementation of removeEdge should not normally be overridden by subclasses.
void	removeEdges(Vertex v) This implementation of removeEdges should not normally be overridden by subclasses.
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
String	toString() Returns a String representation of the Graph.
List	traverse(Vertex startat) Traverses the Graph starting at startat Vertex.

Methods inherited from class java.lang.Object

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

Field Detail

factory

protected GraphFactory factory

Reference to the instance of GraphFactory responsible for creating Vertices and Edges.

traversal

protected GraphTraversal traversal

Delegate object for implementing graph traversal. The default implementation is DepthFirstGraphTraversal.

Constructor Detail

GraphImpl

public GraphImpl()

Method Detail

getGraphFactory

public GraphFactory getGraphFactory()

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)

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

Specified by:

setGraphFactory in interface Graph

getVerticesIterator

public Iterator getVerticesIterator()

Returns a read-only iterator that iterates through the graph's vertices.

Specified by:

getVerticesIterator in interface Graph

Returns:

An iterator of vertices.

cloneVertices

public List cloneVertices()

Returns a clone of the List of vertices.

Specified by:

cloneVertices in interface Graph

Returns:

A clone of the List of vertices.

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

See Also:

Graph.getVertexSet()

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

See Also:

Graph.getEdgeSet()

containsVertex

public boolean containsVertex(Vertex v)

Test whether a vertex is included in this graph.

Parameters:

v - the vertex to test

Returns:

true iff the vertex is included

containsEdge

public boolean containsEdge(Edge edge)

Test whether an edge is included in this graph.

Parameters:

edge - the edge to test

Returns:

true iff the edge is included

getEdges

public List getEdges(Vertex v)

Returns an unmodifiable List of edges of the specified vertex.

Specified by:

getEdges in interface Graph

Parameters:

v - The vertex whose edges we want returned

Returns:

A List of Edges that are incident edges of the specified vertex.

add

public void add(Vertex newvertex)
         throws Exception

This implementation of add(Vertex) should not normally be overridden by subclasses. Instead, subclasses should set up listeners to receive notifications of vertex additions.

Specified by:

add in interface Graph

Parameters:

newvertex - Vertex to be added to the Graph

Throws:

Exception

See Also:

Graph.add(salvo.jesus.graph.Vertex)

addEdge

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

This implementation of addEdge should not normally be overridden by subclasses. Instead, subclasses should set up listeners to receive notifications of edge additions.

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

See Also:

Graph.addEdge(Vertex,Vertex)

addEdge

public void addEdge(Edge edge)
             throws Exception

This implementation of addEdge should not normally be overridden by subclasses. Instead, subclasses should set up listeners to receive notifications of edge additions.

Specified by:

addEdge in interface Graph

Parameters:

edge - The edge to be added to the Graph.

Throws:

Exception

See Also:

Graph.addEdge(Edge)

remove

public void remove(Vertex v)
            throws Exception

This implementation of remove should not normally be overridden by subclasses. Instead, subclasses should set up listeners to receive notifications of vertex removals.

Specified by:

remove in interface Graph

Throws:

Exception

See Also:

Graph.remove(salvo.jesus.graph.Vertex)

removeEdge

public void removeEdge(Edge edge)
                throws Exception

This implementation of removeEdge should not normally be overridden by subclasses. Instead, subclasses should set up listeners to receive notifications of edge removals.

Specified by:

removeEdge in interface Graph

Parameters:

edge - The Edge object to be removed.

Throws:

Exception

See Also:

Graph.removeEdge(salvo.jesus.graph.Edge)

removeEdges

public void removeEdges(Vertex v)
                 throws Exception

This implementation of removeEdges should not normally be overridden by subclasses. Instead, subclasses should set up listeners to receive notifications of edge removals.

Specified by:

removeEdges in interface Graph

Parameters:

v - Vertex whose Edges are to be removed

Throws:

Exception

See Also:

Graph.removeEdges(salvo.jesus.graph.Vertex)

getVerticesCount

public int getVerticesCount()

Returns the number of vertices in the graph

Specified by:

getVerticesCount in interface Graph

Returns:

The number of vertices in the graph.

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.

See Also:

Graph.getEdgesCount()

getVertices

public Set getVertices(int degree)

Returns all vertices with the specified degree.

Specified by:

getVertices in interface Graph

Parameters:

degree - The degree of the vertex to be returned.

Returns:

A collection of vertices with the above specified degree.

getAdjacentVertices

public List getAdjacentVertices(Vertex v)

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:

List of vertices adjacent to the specified vertex v.

getAdjacentVertices

public Set getAdjacentVertices(List vertices)

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:

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

See Also:

Graph.getConnectedSet()

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.

See Also:

Graph.getConnectedSet(Vertex)

forgetConnectedSets

public void forgetConnectedSets()

Forget any information which has been incrementally maintained about this graph's connected sets. Such information is computed on demand, so before doing a large number of graph updates, it's a good idea to call this method if one of the getConnectedSet methods has been previously called.

traverse

public List traverse(Vertex startat)

Traverses the Graph starting at startat Vertex. 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()

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)

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)

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.

getDegree

public int getDegree()

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)

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.

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)

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, removeGraphAddVertexListener( GraphAddVertexListener )

addGraphAddEdgeListener

public 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.

Specified by:

addGraphAddEdgeListener in interface Graph

Parameters:

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

See Also:

GraphAddEdgeListener, removeGraphAddEdgeListener( GraphAddEdgeListener )

addGraphRemoveEdgeListener

public 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.

Specified by:

addGraphRemoveEdgeListener in interface Graph

Parameters:

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

See Also:

GraphRemoveEdgeListener, removeGraphRemoveEdgeListener( GraphRemoveEdgeListener )

addGraphRemoveVertexListener

public 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.

Specified by:

addGraphRemoveVertexListener in interface Graph

Parameters:

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

See Also:

GraphRemoveVertexListener, removeGraphRemoveVertexListener( GraphRemoveVertexListener )

removeGraphAddVertexListener

public void removeGraphAddVertexListener(GraphAddVertexListener listener)

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, addGraphAddVertexListener( GraphAddVertexListener )

removeGraphAddEdgeListener

public void removeGraphAddEdgeListener(GraphAddEdgeListener listener)

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, addGraphAddEdgeListener( GraphAddEdgeListener )

removeGraphRemoveEdgeListener

public void removeGraphRemoveEdgeListener(GraphRemoveEdgeListener listener)

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, addGraphRemoveEdgeListener( GraphRemoveEdgeListener )

removeGraphRemoveVertexListener

public void removeGraphRemoveVertexListener(GraphRemoveVertexListener listener)

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, addGraphRemoveVertexListener( GraphRemoveVertexListener )

toString

public String toString()

Returns a String representation of the Graph. The string returned in the form: "Vertices: " + getVertexSet().toString() + "\n " + "Edges: " + getEdgeSet().toString()

Overrides:

toString in class Object

Returns:

String representation of the Graph