Graph (Broadwick 1.2 API)

Type Parameters:

V - the vertex type.

E - the edge type.

All Superinterfaces:

Serializable

All Known Implementing Classes:

DirectedGraph, Tree, UndirectedGraph
```
public interface Graph<V extends Vertex,E extends Edge<V>>
extends Serializable
```
A graph consisting of a set of vertices of type V set and a set of edges of type E. Edges of this graph type have exactly two endpoints; whether these endpoints must be distinct depends on the implementation.
This implementation is shamelessly copied from the Jung graph library which is used as the implementation for all the classes in this package.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addEdge(E e, V v1, V v2)` Adds edge `e` to this graph such that it connects vertex `v1` to `v2`.
`boolean`	`addEdge(E e, V v1, V v2, EdgeType edgeType)` Adds edge `e` to this graph such that it connects vertex `v1` to `v2`.
`void`	`addEdgeAttribute(String name, Class type, String defaultValue)` Add a new node attribute to the network.
`boolean`	`addVertex(V vertex)` Adds a vertex to the graph.
`void`	`addVertexAttribute(String name, Class type, String defaultValue)` Add a new node attribute to the network.
`V`	`getDest(E directedEdge)` If `directed_edge` is a directed edge in this graph, returns the destination; otherwise returns `null`.
`E`	`getEdge(String id)` Returns a view the edges in this graph with the given id.
`Collection<EdgeAttribute>`	`getEdgeAttributes()` Get the attributes for the edges in the graph.
`Collection<E>`	`getEdges()` Returns a view of all edges in this graph.
`EdgeType`	`getEdgeType()` Get the type of edge (directed/undirected employed in the graph.
`Pair<V,V>`	`getEndpoints(E edge)` Returns the endpoints of `edge` as a `Pair`.
`Collection<E>`	`getInEdges(V vertex)` Returns a `Collection` view of the incoming edges incident to `vertex` in this graph.
`V`	`getOpposite(V vertex, E edge)` Returns the vertex at the other end of `edge` from `vertex`.
`Collection<E>`	`getOutEdges(V vertex)` Returns a `Collection` view of the outgoing edges incident to `vertex` in this graph.
`int`	`getPredecessorCount(V vertex)` Returns the number of predecessors that `vertex` has in this graph.
`Collection<V>`	`getPredecessors(V vertex)` Returns a `Collection` view of the predecessors of `vertex` in this graph.
`V`	`getSource(E directedEdge)` If `directed_edge` is a directed edge in this graph, returns the source; otherwise returns `null`.
`int`	`getSuccessorCount(V vertex)` Returns the number of successors that `vertex` has in this graph.
`Collection<V>`	`getSuccessors(V vertex)` Returns a `Collection` view of the successors of `vertex` in this graph.
`V`	`getVertex(String id)` Returns a view the vertex in this graph with a given id.Returns null if the edge does not exist.
`Collection<VertexAttribute>`	`getVertexAttributes()` Get the attributes for the vertics in the graph.
`int`	`getVertexCount()` Returns the number of vertices in this graph.
`Collection<V>`	`getVertices()` Returns a view of all vertices in this graph.
`int`	`inDegree(V vertex)` Returns the number of incoming edges incident to `vertex`.
`boolean`	`isDest(V vertex, E edge)` Returns `true` if `vertex` is the destination of `edge`.
`boolean`	`isPredecessor(V v1, V v2)` Returns `true` if `v1` is a predecessor of `v2` in this graph.
`boolean`	`isSource(V vertex, E edge)` Returns `true` if `vertex` is the source of `edge`.
`boolean`	`isSuccessor(V v1, V v2)` Returns `true` if `v1` is a successor of `v2` in this graph.
`int`	`outDegree(V vertex)` Returns the number of outgoing edges incident to `vertex`.
`boolean`	`removeEdge(E edge)` Removes `edge` from this graph.
`boolean`	`removeVertex(V vertex)` Remove the passed node, and, in the case of a tree, all nodes that are descendants of the passed node.

- Method Detail
  - getInEdges
```
Collection<E> getInEdges(V vertex)
```
    Returns a Collection view of the incoming edges incident to vertex in this graph.
    
    Parameters:
    
    vertex - the vertex whose incoming edges are to be returned
    
    Returns:
    
    a Collection view of the incoming edges incident to vertex in this graph
  - getOutEdges
```
Collection<E> getOutEdges(V vertex)
```
    Returns a Collection view of the outgoing edges incident to vertex in this graph.
    
    Parameters:
    
    vertex - the vertex whose outgoing edges are to be returned
    
    Returns:
    
    a Collection view of the outgoing edges incident to vertex in this graph
  - getPredecessors
```
Collection<V> getPredecessors(V vertex)
```
    Returns a Collection view of the predecessors of vertex in this graph. A predecessor of vertex is defined as a vertex v which is connected to vertex by an edge e, where e is an outgoing edge of v and an incoming edge of vertex.
    
    Parameters:
    
    vertex - the vertex whose predecessors are to be returned
    
    Returns:
    
    a Collection view of the predecessors of vertex in this graph
  - getSuccessors
```
Collection<V> getSuccessors(V vertex)
```
    Returns a Collection view of the successors of vertex in this graph. A successor of vertex is defined as a vertex v which is connected to vertex by an edge e, where e is an incoming edge of v and an outgoing edge of vertex.
    
    Parameters:
    
    vertex - the vertex whose predecessors are to be returned
    
    Returns:
    
    a Collection view of the successors of vertex in this graph
  - inDegree
```
int inDegree(V vertex)
```
    Returns the number of incoming edges incident to vertex. Equivalent to getInEdges(vertex).size().
    
    Parameters:
    
    vertex - the vertex whose indegree is to be calculated
    
    Returns:
    
    the number of incoming edges incident to vertex
  - outDegree
```
int outDegree(V vertex)
```
    Returns the number of outgoing edges incident to vertex. Equivalent to getOutEdges(vertex).size().
    
    Parameters:
    
    vertex - the vertex whose outdegree is to be calculated
    
    Returns:
    
    the number of outgoing edges incident to vertex
  - isPredecessor
```
boolean isPredecessor(V v1,
                      V v2)
```
    Returns true if v1 is a predecessor of v2 in this graph. Equivalent to v1.getPredecessors().contains(v2).
    
    Parameters:
    
    v1 - the first vertex to be queried
    
    v2 - the second vertex to be queried
    
    Returns:
    
    true if v1 is a predecessor of v2, and false otherwise.
  - isSuccessor
```
boolean isSuccessor(V v1,
                    V v2)
```
    Returns true if v1 is a successor of v2 in this graph. Equivalent to v1.getSuccessors().contains(v2).
    
    Parameters:
    
    v1 - the first vertex to be queried
    
    v2 - the second vertex to be queried
    
    Returns:
    
    true if v1 is a successor of v2, and false otherwise.
  - getPredecessorCount
```
int getPredecessorCount(V vertex)
```
    Returns the number of predecessors that vertex has in this graph. Equivalent to vertex.getPredecessors().size().
    
    Parameters:
    
    vertex - the vertex whose predecessor count is to be returned
    
    Returns:
    
    the number of predecessors that vertex has in this graph
  - getSuccessorCount
```
int getSuccessorCount(V vertex)
```
    Returns the number of successors that vertex has in this graph. Equivalent to vertex.getSuccessors().size().
    
    Parameters:
    
    vertex - the vertex whose successor count is to be returned
    
    Returns:
    
    the number of successors that vertex has in this graph
  - getSource
```
V getSource(E directedEdge)
```
    If directed_edge is a directed edge in this graph, returns the source; otherwise returns null. The source of a directed edge d is defined to be the vertex for which d is an outgoing edge. directed_edge is guaranteed to be a directed edge if its EdgeType is DIRECTED.
    
    Parameters:
    
    directedEdge - the edge for which we want the corresponding source.
    
    Returns:
    
    the source of directed_edge if it is a directed edge in this graph, or null otherwise
  - getDest
```
V getDest(E directedEdge)
```
    If directed_edge is a directed edge in this graph, returns the destination; otherwise returns null. The destination of a directed edge d is defined to be the vertex incident to d for which d is an incoming edge. directed_edge is guaranteed to be a directed edge if its EdgeType is DIRECTED.
    
    Parameters:
    
    directedEdge - the edge for which we want the corresponding destination.
    
    Returns:
    
    the destination of directed_edge if it is a directed edge in this graph, * * or null otherwise
  - isSource
```
boolean isSource(V vertex,
                 E edge)
```
    Returns true if vertex is the source of edge. Equivalent to getSource(edge).equals(vertex).
    
    Parameters:
    
    vertex - the vertex to be queried
    
    edge - the edge to be queried
    
    Returns:
    
    true iff vertex is the source of edge
  - isDest
```
boolean isDest(V vertex,
               E edge)
```
    Returns true if vertex is the destination of edge. Equivalent to getDest(edge).equals(vertex).
    
    Parameters:
    
    vertex - the vertex to be queried
    
    edge - the edge to be queried
    
    Returns:
    
    true iff vertex is the destination of edge
  - addVertex
```
boolean addVertex(V vertex)
```
    Adds a vertex to the graph. If the graph is a tree the first node added will be set as the root.
    
    Parameters:
    
    vertex - the vertex to be added to the graph
    
    Returns:
    
    true if this call mutates the underlying graph
  - addEdge
```
boolean addEdge(E e,
                V v1,
                V v2)
```
    Adds edge e to this graph such that it connects vertex v1 to v2. Equivalent to addEdge(e, new Pair(v1, v2)). If this graph does not contain v1, v2, or both, implementations may choose to either silently add the vertices to the graph or throw an IllegalArgumentException. If this graph assigns edge types to its edges, the edge type of e will be the default for this graph. See Hypergraph.addEdge() for a listing of possible reasons for failure.
    
    Parameters:
    
    e - the edge to be added
    
    v1 - the first vertex to be connected
    
    v2 - the second vertex to be connected
    
    Returns:
    
    true if the add is successful, false otherwise
    
    See Also:
    
    Hypergraph#addEdge(Object, Collection), #addEdge(Object, Object, Object, EdgeType)
  - addEdge
```
boolean addEdge(E e,
                V v1,
                V v2,
                EdgeType edgeType)
```
    Adds edge e to this graph such that it connects vertex v1 to v2. Equivalent to addEdge(e, new Pair(v1, v2)). If this graph does not contain v1, v2, or both, implementations may choose to either silently add the vertices to the graph or throw an IllegalArgumentException. If edgeType is not legal for this graph, this method will throw IllegalArgumentException. See Hypergraph.addEdge() for a listing of possible reasons for failure.
    
    Parameters:
    
    e - the edge to be added
    
    v1 - the first vertex to be connected
    
    v2 - the second vertex to be connected
    
    edgeType - the type to be assigned to the edge
    
    Returns:
    
    true if the add is successful, false otherwise
    
    See Also:
    
    Hypergraph#addEdge(Object, Collection), #addEdge(Object, Object, Object)
  - getEndpoints
```
Pair<V,V> getEndpoints(E edge)
```
    Returns the endpoints of edge as a Pair.
    
    Parameters:
    
    edge - the edge whose endpoints are to be returned
    
    Returns:
    
    the endpoints (incident vertices) of edge
  - getOpposite
```
V getOpposite(V vertex,
              E edge)
```
    Returns the vertex at the other end of edge from vertex. (That is, returns the vertex incident to edge which is not vertex.)
    
    Parameters:
    
    vertex - the vertex to be queried
    
    edge - the edge to be queried
    
    Returns:
    
    the vertex at the other end of edge from vertex
  - getVertexCount
```
int getVertexCount()
```
    Returns the number of vertices in this graph.
    
    Returns:
    
    the number of vertices in this graph
  - getVertices
```
Collection<V> getVertices()
```
    Returns a view of all vertices in this graph. In general, this obeys the Collection contract, and therefore makes no guarantees about the ordering of the vertices within the set.
    
    Returns:
    
    a Collection view of all vertices in this graph
  - getVertex
```
V getVertex(String id)
```
    Returns a view the vertex in this graph with a given id.Returns null if the edge does not exist.
    
    Parameters:
    
    id - the id of the vertex to be found.
    
    Returns:
    
    a view of the vertex with the given id, or null if the edges doesn't exist in the graph.
  - getEdge
```
E getEdge(String id)
```
    Returns a view the edges in this graph with the given id. Returns null if the edge does not exist.
    
    Parameters:
    
    id - the id of the vertex to be found
    
    Returns:
    
    a view of the edge with the given id, or null if the edges doesn't exist in the graph.
  - getEdges
```
Collection<E> getEdges()
```
    Returns a view of all edges in this graph. In general, this obeys the Collection contract, and therefore makes no guarantees about the ordering of the edges within the set.
    
    Returns:
    
    a Collection view of all edges in this graph
  - removeVertex
```
boolean removeVertex(V vertex)
```
    Remove the passed node, and, in the case of a tree, all nodes that are descendants of the passed node.
    
    Parameters:
    
    vertex - the vertex to be removed.
    
    Returns:
    
    true iff the graph was modified
  - removeEdge
```
boolean removeEdge(E edge)
```
    Removes edge from this graph. Fails if edge is null, or is otherwise not an element of this graph.
    
    Parameters:
    
    edge - the edge to remove
    
    Returns:
    
    true if the removal is successful, false otherwise
  - getVertexAttributes
```
Collection<VertexAttribute> getVertexAttributes()
```
    Get the attributes for the vertics in the graph.
    
    Returns:
    
    the collection of VertexAttributes.
  - getEdgeAttributes
```
Collection<EdgeAttribute> getEdgeAttributes()
```
    Get the attributes for the edges in the graph.
    
    Returns:
    
    the collection of EdgeAttributes.
  - addVertexAttribute
```
void addVertexAttribute(String name,
                        Class type,
                        String defaultValue)
```
    Add a new node attribute to the network.
    
    Parameters:
    
    name - the name of the attribute.
    
    type - the type of attribute (int string etc).
    
    defaultValue - the default value for the attribute.
  - addEdgeAttribute
```
void addEdgeAttribute(String name,
                      Class type,
                      String defaultValue)
```
    Add a new node attribute to the network.
    
    Parameters:
    
    name - the name of the attribute.
    
    type - the type of attribute (int string etc).
    
    defaultValue - the default value for the attribute.
  - getEdgeType
```
EdgeType getEdgeType()
```
    Get the type of edge (directed/undirected employed in the graph.
    
    Returns:
    
    either EdgeType.DIRECTED or EdgeType.UNDIRECTED

Interface Graph<V extends Vertex,E extends Edge<V>>

Method Summary

Method Detail

getInEdges

getOutEdges

getPredecessors

getSuccessors

inDegree

outDegree

isPredecessor

isSuccessor

getPredecessorCount

getSuccessorCount

getSource

getDest

isSource

isDest

addVertex

addEdge

addEdge

getEndpoints

getOpposite

getVertexCount

getVertices

getVertex

getEdge

getEdges

removeVertex

removeEdge

getVertexAttributes

getEdgeAttributes

addVertexAttribute

addEdgeAttribute

getEdgeType