org.jscience.computing.graph
Interface Graph

All Known Subinterfaces:
DirectedGraph, ListenableGraph, UndirectedGraph, WeightedGraph
All Known Implementing Classes:
AbstractBaseGraph, AbstractGraph, AsUndirectedGraph, DefaultDirectedGraph, DefaultDirectedWeightedGraph, DefaultListenableGraph, DirectedMultigraph, DirectedSubgraph, DirectedWeightedMultigraph, DirectedWeightedSubgraph, GraphDelegator, ListenableDirectedGraph, ListenableDirectedWeightedGraph, ListenableUndirectedGraph, ListenableUndirectedWeightedGraph, Multigraph, Pseudograph, SemanticNetwork, SimpleDirectedGraph, SimpleDirectedWeightedGraph, SimpleGraph, SimpleWeightedGraph, Subgraph, UndirectedSubgraph, UndirectedWeightedSubgraph, UnmodifiableDirectedGraph, UnmodifiableGraph, UnmodifiableUndirectedGraph, WeightedMultigraph, WeightedPseudograph

public interface Graph

The root interface in the graph hierarchy. A mathematical graph-theory graph object G(V,E) contains a set V of vertices and a set E of edges. Each edge e=(v1,v2) in E connects vertex v1 to vertex v2. for more information about graphs and their related definitions see http://mathworld.wolfram.com/Graph.html.

This library generally follows the terminology found at: http://mathworld.wolfram.com/topics/GraphTheory.html. Implementation of this interface can provide simple-graphs, multigraphs, pseudographs etc. The package org.jscience.computing.graph.graph provides a gallery of abstract and concrete graph implementations.

This library works best when vertices represent arbitrary objects and edges represent the relationships between them. Vertex and edge instances may be shared by more than one graph.

Since:
Jul 14, 2003

Method Summary
 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.
 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.
 boolean addVertex(java.lang.Object v)
          Adds the specified vertex to this graph if not already present.
 boolean containsEdge(Edge e)
          Returns true if this graph contains the specified edge.
 boolean containsEdge(java.lang.Object sourceVertex, java.lang.Object targetVertex)
          Returns true if and only if this graph contains an edge going from the source vertex to the target vertex.
 boolean containsVertex(java.lang.Object v)
          Returns true if this graph contains the specified vertex.
 java.util.Set edgeSet()
          Returns a set of the edges contained in this graph.
 java.util.List edgesOf(java.lang.Object vertex)
          Returns a list of all edges touching the specified vertex.
 java.util.List getAllEdges(java.lang.Object sourceVertex, java.lang.Object targetVertex)
          Returns a list of all edges connecting source vertex to target vertex if such vertices exist in this graph.
 Edge getEdge(java.lang.Object sourceVertex, java.lang.Object targetVertex)
          Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph.
 EdgeFactory getEdgeFactory()
          Returns the edge factory using which this graph creates new edges.
 boolean removeAllEdges(java.util.Collection edges)
          Removes all the edges in this graph that are also contained in the specified edge collection.
 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 removeAllVertices(java.util.Collection vertices)
          Removes all the vertices in this graph that are also contained in the specified vertex collection.
 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.
 boolean removeVertex(java.lang.Object v)
          Removes the specified vertex from this graph including all its touching edges if present.
 java.util.Set vertexSet()
          Returns a set of the vertices contained in this graph.
 

Method Detail

getAllEdges

java.util.List getAllEdges(java.lang.Object sourceVertex,
                           java.lang.Object targetVertex)
Returns a list of all edges connecting source vertex to target vertex if such vertices exist in this graph. If any of the vertices does not exist or is null, returns null. If both vertices exist but no edges found, returns an empty list.

In undirected graphs, some of the returned edges may have their source and target vertices in the opposite order. In simple graphs the returned list is either singleton list or empty list.

Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
a list of all edges connecting source vertex to target vertex.

getEdge

Edge getEdge(java.lang.Object sourceVertex,
             java.lang.Object targetVertex)
Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph. Otherwise returns null. If any of the specified vertices is null returns null

In undirected graphs, the returned edge may have its source and target vertices in the opposite order.

Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
an edge connecting source vertex to target vertex.

getEdgeFactory

EdgeFactory getEdgeFactory()
Returns the edge factory using which this graph creates new edges. The edge factory is defined when the graph is constructed and must not be modified.

Returns:
the edge factory using which this graph creates new edges.

addAllEdges

boolean addAllEdges(java.util.Collection edges)
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 the addEdge(Edge) method.

Parameters:
edges - the edges to be added to this graph.
Returns:
true if this graph changed as a result of the call
Throws:
java.lang.NullPointerException - if the specified edges contains one or more null edges, or if the specified vertex collection is null.
See Also:
addVertex(Object)

addAllVertices

boolean addAllVertices(java.util.Collection vertices)
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 the addVertex(Object) method.

Parameters:
vertices - the vertices to be added to this graph.
Returns:
true if this graph changed as a result of the call
Throws:
java.lang.NullPointerException - if the specified vertices contains one or more null vertices, or if the specified vertex collection is null.
See Also:
addVertex(Object)

addEdge

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

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.
Throws:
java.lang.IllegalArgumentException - if source or target vertices are not found in the graph.
java.lang.NullPointerException - if any of the specified vertices is null.
See Also:
getEdgeFactory()

addEdge

boolean addEdge(Edge e)
Adds the specified edge to this graph. More formally, adds the specified edge, 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.

Parameters:
e - edge to be added to this graph.
Returns:
true if this graph did not already contain the specified edge.
Throws:
java.lang.IllegalArgumentException - if source or target vertices of specified edge are not found in this graph.
java.lang.ClassCastException - if the specified edge is not assignment compatible with the class of edges produced by the edge factory of this graph.
java.lang.NullPointerException - if the specified edge is null.
See Also:
addEdge(Object,Object), getEdgeFactory(), EdgeFactory

addVertex

boolean addVertex(java.lang.Object v)
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 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.

Parameters:
v - vertex to be added to this graph.
Returns:
true if this graph did not already contain the specified vertex.
Throws:
java.lang.NullPointerException - if the specified vertex is null.

containsEdge

boolean containsEdge(java.lang.Object sourceVertex,
                     java.lang.Object targetVertex)
Returns true if and only if this graph contains an edge going from the source vertex to the target vertex. In undirected graphs the same result is obtained when source and target are inverted. If any of the specified vertices does not exist in the graph, or if is null, returns false.

Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
true if this graph contains the specified edge.

containsEdge

boolean containsEdge(Edge e)
Returns true if this graph contains the specified edge. More formally, returns true if and only if this graph contains an edge e2 such that e.equals(e2). If the specified edge is null returns false.

Parameters:
e - edge whose presence in this graph is to be tested.
Returns:
true if this graph contains the specified edge.

containsVertex

boolean containsVertex(java.lang.Object v)
Returns true if this graph contains the specified vertex. More formally, returns true if and only if this graph contains a vertex u such that u.equals(v). If the specified vertex is null returns false.

Parameters:
v - vertex whose presence in this graph is to be tested.
Returns:
true if this graph contains the specified vertex.

edgeSet

java.util.Set edgeSet()
Returns a set of the edges contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.

The graph implementation may maintain a particular set ordering (e.g. via LinkedHashSet) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

Returns:
a set of the edges contained in this graph.

edgesOf

java.util.List edgesOf(java.lang.Object vertex)
Returns a list of all edges touching the specified vertex. If no edges are touching the specified vertex returns an empty list.

Parameters:
vertex - the vertex for which a list of touching edges to be returned.
Returns:
a list of all edges touching the specified vertex.

removeAllEdges

boolean removeAllEdges(java.util.Collection edges)
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 the removeEdge(Edge) method.

Parameters:
edges - edges to be removed from this graph.
Returns:
true if this graph changed as a result of the call
Throws:
java.lang.NullPointerException - if the specified edge collection is null.
See Also:
removeEdge(Edge), containsEdge(Edge)

removeAllEdges

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. Returns null 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 the removeEdge(Edge) method, or the removeEdge(Object,Object) method.

Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
The removed edge, or null if no edge removed.

removeAllVertices

boolean removeAllVertices(java.util.Collection vertices)
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 the removeVertex(Object) method.

Parameters:
vertices - vertices to be removed from this graph.
Returns:
true if this graph changed as a result of the call
Throws:
java.lang.NullPointerException - if the specified vertex collection is null.
See Also:
removeVertex(Object), containsVertex(Object)

removeEdge

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. Returns the edge if removed or null otherwise.

Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
The removed edge, or null if no edge removed.

removeEdge

boolean removeEdge(Edge e)
Removes the specified edge from the graph. Removes the specified edge from this graph if it is present. More formally, removes an edge 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.

Parameters:
e - edge to be removed from this graph, if present.
Returns:
true if and only if the graph contained the specified edge.

removeVertex

boolean removeVertex(java.lang.Object v)
Removes the specified vertex from this graph including all its touching edges if present. More formally, if the graph contains a vertex 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.

Parameters:
v - vertex to be removed from this graph, if present.
Returns:
true if the graph contained the specified vertex; false otherwise.

vertexSet

java.util.Set vertexSet()
Returns a set of the vertices contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.

The graph implementation may maintain a particular set ordering (e.g. via LinkedHashSet) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

Returns:
a set view of the vertices contained in this graph.