Graph (openjgraph-0.9.2 1.0.0 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

BinaryTree, CyclePath, DirectedAcyclicGraph, DirectedGraph, Path, SimplePath, Tree, WeightedGraph

All Known Implementing Classes:

CyclePathImpl, DirectedAcyclicGraphAdaptor, DirectedAcyclicGraphImpl, DirectedGraphDelegator, DirectedGraphImpl, GraphDelegator, GraphImpl, PathImpl, SimplePathImpl, TreeImpl, WeightedGraphImpl
```
public interface Graph
extends Serializable
```
An interface for Graphs.
Note that all methods which return collections return unmodifiable collections; callers that need modifiable collections must copy the unmodifiable collections explicitly using collection constructors (e.g. new ArrayList(graph.getEdgeSet())). The reason is that the returned collections may be owned by the graph and so should not be modified by callers. $Id: Graph.java,v 1.20 2002/08/24 07:31:34 jmsalvo Exp $

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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)` Deprecated. Use addListener instead
`void`	`addGraphAddVertexListener(GraphAddVertexListener listener)` Deprecated. Use addListener instead
`void`	`addGraphRemoveEdgeListener(GraphRemoveEdgeListener listener)` Deprecated. Use addListener instead
`void`	`addGraphRemoveVertexListener(GraphRemoveVertexListener listener)` Deprecated. Use addListener instead
`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.
`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)` Deprecated. Use removeListener instead
`void`	`removeGraphAddVertexListener(GraphAddVertexListener listener)` Deprecated. Use removeListener instead
`void`	`removeGraphRemoveEdgeListener(GraphRemoveEdgeListener listener)` Deprecated. Use removeListener instead
`void`	`removeGraphRemoveVertexListener(GraphRemoveVertexListener listener)` Deprecated. Use removeListener instead
`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.

- Method Detail
  - getVerticesCount
```
int getVerticesCount()
```
    Returns the number of vertices in the graph
    
    Returns:
    
    The number of vertices in the graph.
  - getGraphFactory
```
GraphFactory getGraphFactory()
```
    Returns the factory that will be responsible for creating Vertices and Edges in a Graph.
  - setGraphFactory
```
void setGraphFactory(GraphFactory factory)
```
    Sets the factory that will be responsible for creating Vertices and Edges in a Graph.
  - add
```
void add(Vertex v)
  throws Exception
```
    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.
    
    Parameters:
    
    v - Vertex to be added to the Graph
    
    Throws:
    
    Exception
  - remove
```
void remove(Vertex v)
     throws Exception
```
    Removes the specified Vertex and all of its incident edges from the Graph. All GraphListeners are informed of events for the vertex and edges.
    
    Parameters:
    
    edge - The Edge object to be removed.
    
    Throws:
    
    Exception
  - getVerticesIterator
```
Iterator getVerticesIterator()
```
    Returns an iterator that iterates through the graph's vertices in arbitrary order.
    
    Returns:
    
    An iterator of List vertices.
  - cloneVertices
```
List cloneVertices()
```
    Returns a modifiable clone of the vertex set as a List in arbitrary order.
    
    Returns:
    
    List of Vertices
  - getVertexSet
```
Set getVertexSet()
```
    Returns an unmodifiable set of the vertices included in this graph.
    
    Returns:
    
    Set of Vertices
  - addEdge
```
Edge addEdge(Vertex v1,
             Vertex v2)
      throws Exception
```
    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.
    
    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
```
void addEdge(Edge e)
      throws Exception
```
    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.
    
    Parameters:
    
    e - The edge to be added to the Graph.
    
    Throws:
    
    Exception
  - removeEdge
```
void removeEdge(Edge e)
         throws Exception
```
    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.
    
    Parameters:
    
    e - The Edge object to be removed.
    
    Throws:
    
    Exception
  - removeEdges
```
void removeEdges(Vertex v)
          throws Exception
```
    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.
    
    Parameters:
    
    v - Vertex whose Edges are to be removed
    
    Throws:
    
    Exception
  - getEdgeSet
```
Set getEdgeSet()
```
    Returns an unmodifiable set of the edges included in this graph.
    
    Returns:
    
    Set of Edges
  - getEdgesCount
```
int getEdgesCount()
```
    Returns the number of edges in the graph
    
    Returns:
    
    The number of edges in the graph.
  - getDegree
```
int getDegree()
```
    Returns the degree of the graph, which is simply the highest degree of all the graph's vertices.
    
    Returns:
    
    An int indicating the degree of the graph.
  - getDegree
```
int getDegree(Vertex v)
```
    Returns the degree of the vertex, which is simply the number of edges of the vertex.
    
    Returns:
    
    The degree of the vertex.
  - getVertices
```
Set getVertices(int degree)
```
    Returns all vertices with the specified degree.
    
    Parameters:
    
    degree - The degree of the vertex to be returned.
    
    Returns:
    
    an unmodifiable set of vertices with the above specified degree.
  - getEdges
```
List getEdges(Vertex v)
```
    Returns a List of edges of the specified vertex.
    
    Parameters:
    
    v - The vertex whose edges we want returned
    
    Returns:
    
    an unmodifiable List of Edges that are incident edges of the specified vertex.
  - getAdjacentVertices
```
List getAdjacentVertices(Vertex v)
```
    Returns the vertices adjacent to the specified vertex.
    
    Parameters:
    
    v - The Vertex you want to determine its adjacent vertices.
    
    Returns:
    
    an unmodifiable List of vertices adjacent to the specified vertex v.
  - getAdjacentVertices
```
Set getAdjacentVertices(List vertices)
```
    Returns the vertices adjacent to all the vertices in the given collection.
    
    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
```
Collection getConnectedSet()
```
    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.
    
    Returns:
    
    unmodifiable Collection of unmodifiable Sets
  - getConnectedSet
```
Set getConnectedSet(Vertex v)
```
    Returns the connected set to which the specified vertex belongs.
    
    Parameters:
    
    v - Vertex to which you want the connected set returned.
    
    Returns:
    
    unmodifiable Set of connected vertices where the specified vertex belongs.
  - traverse
```
List traverse(Vertex startat)
```
    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.
    
    Parameters:
    
    startat - The Vertex to which you want to start the traversal.
  - getTraversal
```
GraphTraversal getTraversal()
```
    Gets the traversal algorithm used by the Graph.
    
    Returns:
    
    GraphTraversal object performing traversal for the Graph.
  - setTraversal
```
void setTraversal(GraphTraversal traversal)
```
    Sets the graph traversal algorithm to be used
    
    Parameters:
    
    traversal - A concrete implementation of the GraphTraversal object.
  - isConnected
```
boolean isConnected(Vertex v1,
                    Vertex v2)
```
    Determines if two vertices are connected
    
    Parameters:
    
    v1 - starting Vertex for the path
    
    v2 - ending Vertex for the path
    
    Returns:
    
    true if v1 and v2 are connected.
  - addListener
```
void addListener(GraphListener listener)
```
    Registers a GraphListener with this Graph.
    
    Parameters:
    
    listener - the listener being registered, which will receive notifications of all graph modifications
  - removeListener
```
void removeListener(GraphListener listener)
```
    Unregisters a GraphListener currently attached to this Graph.
    
    Parameters:
    
    listener - the listener being unregistered, which will cease receiving notifications
  - addGraphAddVertexListener
```
void addGraphAddVertexListener(GraphAddVertexListener listener)
```
    Deprecated. Use addListener instead
    
    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.
    
    Parameters:
    
    listener - GraphAddVertexListener you want registered or be notified when a new Vertex is added
    
    See Also:
    
    GraphAddVertexListener, removeGraphAddVertexListener( GraphAddVertexListener ), addListener(salvo.jesus.graph.GraphListener)
  - addGraphAddEdgeListener
```
void addGraphAddEdgeListener(GraphAddEdgeListener listener)
```
    Deprecated. Use addListener instead
    
    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.
    
    Parameters:
    
    listener - GraphAddEdgeListener you want registered or be notified when a new Edge is added
    
    See Also:
    
    GraphAddEdgeListener, removeGraphAddEdgeListener( GraphAddEdgeListener ), addListener(salvo.jesus.graph.GraphListener)
  - addGraphRemoveEdgeListener
```
void addGraphRemoveEdgeListener(GraphRemoveEdgeListener listener)
```
    Deprecated. Use addListener instead
    
    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.
    
    Parameters:
    
    listener - GraphRemoveEdgeListener you want registered or be notified when an Edge is removed
    
    See Also:
    
    GraphRemoveEdgeListener, removeGraphRemoveEdgeListener( GraphRemoveEdgeListener ), addListener(salvo.jesus.graph.GraphListener)
  - addGraphRemoveVertexListener
```
void addGraphRemoveVertexListener(GraphRemoveVertexListener listener)
```
    Deprecated. Use addListener instead
    
    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.
    
    Parameters:
    
    listener - GraphRemoveVertexListener you want registered or be notified when a Vertex is removed
    
    See Also:
    
    GraphRemoveVertexListener, removeGraphRemoveVertexListener( GraphRemoveVertexListener ), addListener(salvo.jesus.graph.GraphListener)
  - removeGraphAddVertexListener
```
void removeGraphAddVertexListener(GraphAddVertexListener listener)
```
    Deprecated. Use removeListener instead
    
    Removes a GraphAddVertexListener from the Graph's internal List of GraphAddVertexListeners.
    
    Parameters:
    
    listener - GraphAddVertexListener you no longer want registered or be notified when a Vertex is added
    
    See Also:
    
    GraphAddVertexListener, addGraphAddVertexListener( GraphAddVertexListener ), removeListener(salvo.jesus.graph.GraphListener)
  - removeGraphAddEdgeListener
```
void removeGraphAddEdgeListener(GraphAddEdgeListener listener)
```
    Deprecated. Use removeListener instead
    
    Removes a GraphAddEdgeListener from the Graph's internal List of GraphAddEdgeListeners.
    
    Parameters:
    
    listener - GraphAddEdgeListener you no longer want registered or be notified when an Edge is added
    
    See Also:
    
    GraphAddEdgeListener, addGraphAddEdgeListener( GraphAddEdgeListener ), removeListener(salvo.jesus.graph.GraphListener)
  - removeGraphRemoveEdgeListener
```
void removeGraphRemoveEdgeListener(GraphRemoveEdgeListener listener)
```
    Deprecated. Use removeListener instead
    
    Removes a GraphRemoveEdgeListener from the Graph's internal List of GraphRemoveEdgeListeners.
    
    Parameters:
    
    listener - GraphRemoveEdgeListener you no longer want registered or be notified when an Edge is removed
    
    See Also:
    
    GraphRemoveEdgeListener, addGraphRemoveEdgeListener( GraphRemoveEdgeListener ), removeListener(salvo.jesus.graph.GraphListener)
  - removeGraphRemoveVertexListener
```
void removeGraphRemoveVertexListener(GraphRemoveVertexListener listener)
```
    Deprecated. Use removeListener instead
    
    Removes a GraphRemoveVertexListener from the Graph's internal List of GraphRemoveVertexListeners.
    
    Parameters:
    
    listener - GraphRemoveVertexListener you no longer want registered or be notified when a Vertex is removed
    
    See Also:
    
    GraphRemoveVertexListener, addGraphRemoveVertexListener( GraphRemoveVertexListener ), removeListener(salvo.jesus.graph.GraphListener)

Interface Graph

Method Summary

Method Detail

getVerticesCount

getGraphFactory

setGraphFactory

add

remove

getVerticesIterator

cloneVertices

getVertexSet

addEdge

addEdge

removeEdge

removeEdges

getEdgeSet

getEdgesCount

getDegree

getDegree

getVertices

getEdges

getAdjacentVertices

getAdjacentVertices

getConnectedSet

getConnectedSet

traverse

getTraversal

setTraversal

isConnected

addListener

removeListener

addGraphAddVertexListener

addGraphAddEdgeListener

addGraphRemoveEdgeListener

addGraphRemoveVertexListener

removeGraphAddVertexListener

removeGraphAddEdgeListener

removeGraphRemoveEdgeListener

removeGraphRemoveVertexListener