GraphAdaptor (S-Space Package 2.0.1 API)

java.lang.Object
- edu.ucla.sspace.graph.GraphAdaptor<T>

All Implemented Interfaces:

Graph<T>

Direct Known Subclasses:

LabeledGraph
```
public abstract class GraphAdaptor<T extends Edge>
extends Object
implements Graph<T>
```
An abstract adaptor class that wraps an existing Graph. All methods are pass through to the backing graph. Extend this class to provide custom functionality for specific methods for a backing graph, or to represents the graph's data using a different interface (e.g. wrapping a Graph with an extension that implements DirectedGraph).

Author:

David Jurgens

Constructor Summary

Constructors
Constructor and Description

GraphAdaptor(Graph<T> g)

Constructors
Constructor and Description
`GraphAdaptor(Graph<T> g)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(int i)` Adds a vertex with the provided index to the graph, returning `true` if the vertex was not previously present (optional operation).
`boolean`	`add(T edge)` Adds an edge between the two vertices, returning `true` if the edge was not previously present (optional operation).
`void`	`clear()` Removes all the edges and vertices from this graph (optional operation).
`void`	`clearEdges()` Removes all the edges in this graph, retaining all the vertices (optional operation).
`boolean`	`contains(Edge e)` Returns `true` if this graph contains an edge of the specific type between `vertex1` and `vertex2`.
`boolean`	`contains(int vertex)` Returns `true` if this graph a vertex with the specified index
`boolean`	`contains(int from, int to)` Returns `true` if this graph contains an edge between `from` and `to`.
`Graph<T>`	`copy(Set<Integer> vertices)` Creates a copy of this graph containing only the specified number of vertices and all edges between those vertices.
`int`	`degree(int vertex)` Returns the number of edges that connect this vertex to other vertices in this graph.
`Set<T>`	`edges()` Returns the set of edges contained in this graph.
`Set<T>`	`getAdjacencyList(int vertex)` Returns the set of edges connected to the provided vertex or an empty set if `vertex` is not in this graph.
`Set<T>`	`getEdges(int vertex1, int vertex2)` Returns the `Edge` instances connecting the two vertices or an empty set if the vertices are not connected.
`IntSet`	`getNeighbors(int vertex)` Returns the set of vertices that are connected to the specified vertex, or an empty set if the vertex is not in this graph.
`boolean`	`hasCycles()` Computes whether this graph is acyclic with its current set of edges, and returns `true` if this graph contains cycles, `false` if acyclic.
`int`	`order()` Returns the number of vertices in this graph.
`boolean`	`remove(int vertex)` Removes the vertex and all of its connected edges from the graph (optional operation).
`boolean`	`remove(T e)` Removes the edge from `vertex1` to `vertex2`, returning `true` if the edge existed and was removed (optional operation).
`int`	`size()` Returns the number of edges in this graph.
`Graph<T>`	`subgraph(Set<Integer> vertices)` Returns a view of this graph containing only the specified vertices where the returned graph's vertinces are renamed (0, ..., n).
`String`	`toString()`
`IntSet`	`vertices()` Returns the set of vertices in this graph.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GraphAdaptor
```
public GraphAdaptor(Graph<T> g)
```
- Method Detail
  - add
```
public boolean add(int i)
```
    Adds a vertex with the provided index to the graph, returning true if the vertex was not previously present (optional operation).
    
    Specified by:
    
    add in interface Graph<T extends Edge>
    
    Parameters:
    i - a non-negative index for a vertex. If the graph has size bounds (i.e. a limited number of vertices), the implementation may throw an exception if this index exceeds those bounds.
    
    Returns:
    if the vertex was not previously present
  - add
```
public boolean add(T edge)
```
    Adds an edge between the two vertices, returning true if the edge was not previously present (optional operation).
    If adding this edge would violate some structural constraints on the graph, implementations may return false or throw a GraphConstructionException. If false is returned, the called may check whether the edge was added using containsEdge
    Implemenations are free to decide the behavior for cases where one or both of the vertices are not currently in the graph, and whether self-edges are allowed (i.e. vertex1 == vertex2).
    
    Specified by:
    
    add in interface Graph<T extends Edge>
    
    Returns:
    true if the edge was added, false if the edge was not added, or if the edge was aready present
    See Also:
    #containsEdge(int, int)
  - clear
```
public void clear()
```
    Removes all the edges and vertices from this graph (optional operation).
    
    Specified by:
    
    clear in interface Graph<T extends Edge>
  - clearEdges
```
public void clearEdges()
```
    Removes all the edges in this graph, retaining all the vertices (optional operation).
    
    Specified by:
    
    clearEdges in interface Graph<T extends Edge>
  - copy
```
public Graph<T> copy(Set<Integer> vertices)
```
    Creates a copy of this graph containing only the specified number of vertices and all edges between those vertices. If vertices is empty a new, empty graph of this instance's type is returned. Any changes made to this graph will not be reflected in returned copy or vice-versa.
    
    Specified by:
    
    copy in interface Graph<T extends Edge>
  - contains
```
public boolean contains(int vertex)
```
    Returns true if this graph a vertex with the specified index
    
    Specified by:
    
    contains in interface Graph<T extends Edge>
  - contains
```
public boolean contains(int from,
               int to)
```
    Returns true if this graph contains an edge between from and to. Imeplementations are free to define whether the ordering of the vertices matters.
    
    Specified by:
    
    contains in interface Graph<T extends Edge>
  - contains
```
public boolean contains(Edge e)
```
    Returns true if this graph contains an edge of the specific type between vertex1 and vertex2.
    
    Specified by:
    
    contains in interface Graph<T extends Edge>
  - degree
```
public int degree(int vertex)
```
    Returns the number of edges that connect this vertex to other vertices in this graph. If the provided vertex is not in graph, this method returns 0.
    
    Specified by:
    
    degree in interface Graph<T extends Edge>
  - edges
```
public Set<T> edges()
```
    Returns the set of edges contained in this graph. It is expected that changes to this set be reflected in the backing graph.
    
    Specified by:
    
    edges in interface Graph<T extends Edge>
  - getAdjacencyList
```
public Set<T> getAdjacencyList(int vertex)
```
    Returns the set of edges connected to the provided vertex or an empty set if vertex is not in this graph.
    
    Specified by:
    
    getAdjacencyList in interface Graph<T extends Edge>
  - getNeighbors
```
public IntSet getNeighbors(int vertex)
```
    Returns the set of vertices that are connected to the specified vertex, or an empty set if the vertex is not in this graph.
    
    Specified by:
    
    getNeighbors in interface Graph<T extends Edge>
  - getEdges
```
public Set<T> getEdges(int vertex1,
              int vertex2)
```
    Returns the Edge instances connecting the two vertices or an empty set if the vertices are not connected.
    
    Specified by:
    
    getEdges in interface Graph<T extends Edge>
  - hasCycles
```
public boolean hasCycles()
```
    Computes whether this graph is acyclic with its current set of edges, and returns true if this graph contains cycles, false if acyclic.
    
    Specified by:
    
    hasCycles in interface Graph<T extends Edge>
  - order
```
public int order()
```
    Returns the number of vertices in this graph.
    
    Specified by:
    
    order in interface Graph<T extends Edge>
  - remove
```
public boolean remove(T e)
```
    Removes the edge from vertex1 to vertex2, returning true if the edge existed and was removed (optional operation).
    
    Specified by:
    
    remove in interface Graph<T extends Edge>
  - remove
```
public boolean remove(int vertex)
```
    Removes the vertex and all of its connected edges from the graph (optional operation).
    
    Specified by:
    
    remove in interface Graph<T extends Edge>
  - size
```
public int size()
```
    Returns the number of edges in this graph.
    
    Specified by:
    
    size in interface Graph<T extends Edge>
  - subgraph
```
public Graph<T> subgraph(Set<Integer> vertices)
```
    Returns a view of this graph containing only the specified vertices where the returned graph's vertinces are renamed (0, ..., n). This renaming is to ensure a conceptual distance between the "new" returned graph and the backing graph in terms of vertex labeling; for example, adding vertex n to the subgraph may not necessarily correspond to vertex n in the backing graph.
    Only edges connecting two vertices in the provided set will be viewable in the subgraph. Any changes to the subgraph will be reflected in this graph and vice versa.
    This view allows for direct manipulation of a part of the graph. For example, clearing this subgraph will remove all of its corresponding vertices and edges from the backing graph.
    
    Specified by:
    
    subgraph in interface Graph<T extends Edge>
    
    Parameters:
    vertices - the vertices to include in the subgraph
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - vertices
```
public IntSet vertices()
```
    Returns the set of vertices in this graph.
    
    Specified by:
    
    vertices in interface Graph<T extends Edge>

Class GraphAdaptor<T extends Edge>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GraphAdaptor

Method Detail

add

add

clear

clearEdges

copy

contains

contains

contains

degree

edges

getAdjacencyList

getNeighbors

getEdges

hasCycles

order

remove

remove

size

subgraph

toString

vertices