AdjacencyListGraph

java.lang.Object
- rioko.grapht.AdjacencyListGraph<V,E>

Type Parameters:

V - Class of the Vertex of the Graph.

E - Class of the Edges of the Graph.

All Implemented Interfaces:

Graph<V,E>
```
public class AdjacencyListGraph<V extends Vertex,E extends Edge<V>>
extends java.lang.Object
implements Graph<V,E>
```
Implementation of Graph structure using adjacency lists to store the edges of the graph.

Author:

Antonio

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Class<?> edgeClass
Class of the edges of the graph

Fields
Modifier and Type	Field and Description
`protected java.lang.Class<?>`	`edgeClass` Class of the edges of the graph

Constructor Summary

Constructors
Constructor and Description

AdjacencyListGraph(java.lang.Class<?> edgeClass, java.lang.Class<?> vertexClass)

Constructors
Constructor and Description
`AdjacencyListGraph(java.lang.Class<?> edgeClass, java.lang.Class<?> vertexClass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`E`	`addEdge(V arg0, V arg1)` Method that add a new edge that join the parameter vertices.
`boolean`	`addVertex(V arg0)` Method to add a new Vertex to the graph.
`boolean`	`containsVertex(V arg0)` Method to check if a vertex is contained in the graph,
`java.util.Set<E>`	`edgeSet()` Method that returns the set of Edges contained in this graph.
`java.util.Set<E>`	`edgesFrom(V vertex)` Method that return a set of edge where everyone has a certain source vertex.
`java.util.Set<java.util.Set<V>>`	`getConnectedComponents(java.lang.Boolean strongConnected)` Method that gets the connected components of the graph.
`java.lang.Class<? extends E>`	`getEdgeClass()` Method to get the Edge class of the Graph.
`EdgeFactory<V,E>`	`getEdgeFactory()` Method to get the Edge Factory to create new edges for this graph.
`AdjacencyListGraph<V,E>`	`getSimilarType()` Method that return a new Graph with the same class of vertices and edges.
`java.util.Collection<V>`	`getSubTree(DirectedSearchIterator<V> iterator)` Method that gives the vertices of the graph that, given an Interator over the vertices, are found iterating it.
`java.lang.Class<? extends V>`	`getVertexClass()` Method to get the Vertex class of the Graph.
`VertexFactory<V>`	`getVertexFactory()` Method to get the Vertex Factory to create new edges for this graph.
`AdjacencyListGraph<V,E>`	`inducedSubgraph(java.util.Collection<V> nodes)` Method to get the induced sub-graph given a collection of vertices.
`boolean`	`removeEdge(E arg0)` Method to remove an edge of the graph.
`boolean`	`removeVertex(V arg0)` Method that remove a vertex from the graph.
`protected void`	`setLoopsAvaible(boolean loopsAvaible)` Setter method to the `loopsAvaible` parameter.
`java.util.Set<V>`	`vertexSet()` Method that returns the set of Vertex contained in this graph.

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

Methods inherited from interface rioko.grapht.Graph
containsEdge, containsEdge, edgesOf, edgesTo, getAllEdges, getEdge, getEdgeSource, getEdgeTarget, getEdgeWeight, removeAllEdges, removeAllEdges, removeAllVertices, removeEdge, vertexFrom, vertexTo

- Field Detail
  - edgeClass
```
protected java.lang.Class<?> edgeClass
```
    Class of the edges of the graph
- Constructor Detail
  - AdjacencyListGraph
```
public AdjacencyListGraph(java.lang.Class<?> edgeClass,
                          java.lang.Class<?> vertexClass)
```
- Method Detail
  - setLoopsAvaible
```
protected void setLoopsAvaible(boolean loopsAvaible)
```
    Setter method to the loopsAvaible parameter.
    
    Parameters:
    
    loopsAvaible - Boolean value which will be set as loopsAvaible parameter.
  - addEdge
```
public E addEdge(V arg0,
                 V arg1)
```
    Description copied from interface: Graph
    
    Method that add a new edge that join the parameter vertices. The two vertices should exist in the Graph. If the edge already exists, this method do nothing.
    
    Specified by:
    
    addEdge in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Parameters:
    
    arg0 - Vertex from the edge will go.
    
    arg1 - Vertex to the edge will go.
    
    Returns:
    
    An edge in the graph that joins source to target or null if there is any error.
  - addVertex
```
public boolean addVertex(V arg0)
```
    Description copied from interface: Graph
    
    Method to add a new Vertex to the graph.
    
    Specified by:
    
    addVertex in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Parameters:
    
    arg0 - The vertex we will add.
    
    Returns:
    
    True if the vertex have been added and false if the vertex already was in the Graph.
  - containsVertex
```
public boolean containsVertex(V arg0)
```
    Description copied from interface: Graph
    
    Method to check if a vertex is contained in the graph,
    
    Specified by:
    
    containsVertex in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Parameters:
    
    arg0 - Vertex to check.
    
    Returns:
    
    True if the vertex is in the graph and false otherwise.
  - edgeSet
```
public java.util.Set<E> edgeSet()
```
    Description copied from interface: Graph
    
    Method that returns the set of Edges contained in this graph.
    
    Specified by:
    
    edgeSet in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Returns:
    
    Set of the vertex.
  - getEdgeFactory
```
public EdgeFactory<V,E> getEdgeFactory()
```
    Description copied from interface: Graph
    
    Method to get the Edge Factory to create new edges for this graph.
    
    Specified by:
    
    getEdgeFactory in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Returns:
    
    A factory of type EdgeFactory<V,E>
  - getVertexFactory
```
public VertexFactory<V> getVertexFactory()
```
    Description copied from interface: Graph
    
    Method to get the Vertex Factory to create new edges for this graph.
    
    Specified by:
    
    getVertexFactory in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Returns:
    
    A factory of type VertexFactory<V>
  - removeEdge
```
public boolean removeEdge(E arg0)
```
    Description copied from interface: Graph
    
    Method to remove an edge of the graph.
    
    Specified by:
    
    removeEdge in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Parameters:
    
    arg0 - Edge we want to remove from the graph.
    
    Returns:
    
    True if the edge was successfully removed and false if the edge was not contained in the graph.
  - removeVertex
```
public boolean removeVertex(V arg0)
```
    Description copied from interface: Graph
    
    Method that remove a vertex from the graph. If the graph does not contain the vertex, this method do nothing. This method remove all the edges of the graph that have as source or target the vertex.
    
    Specified by:
    
    removeVertex in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Parameters:
    
    arg0 - Vertex we want to remove.
    
    Returns:
    
    True if the vertex was successfully removed and false if the graph does not contain the vertex.
  - vertexSet
```
public java.util.Set<V> vertexSet()
```
    Description copied from interface: Graph
    
    Method that returns the set of Vertex contained in this graph.
    
    Specified by:
    
    vertexSet in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Returns:
    
    Set of the vertex.
  - edgesFrom
```
public java.util.Set<E> edgesFrom(V vertex)
```
    Description copied from interface: Graph
    
    Method that return a set of edge where everyone has a certain source vertex.
    
    Specified by:
    
    edgesFrom in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Parameters:
    
    vertex - Vertex we search as source.
    
    Returns:
    
    Set of edges where for all edge in it, "edge.getSource().equals(vertex)" is true.
  - getEdgeClass
```
public java.lang.Class<? extends E> getEdgeClass()
```
    Description copied from interface: Graph
    
    Method to get the Edge class of the Graph. It must be the parameter E of the Graph class.
    
    Specified by:
    
    getEdgeClass in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Returns:
    
    Class of the Edges
  - getVertexClass
```
public java.lang.Class<? extends V> getVertexClass()
```
    Description copied from interface: Graph
    
    Method to get the Vertex class of the Graph. It must be the parameter V of the Graph class.
    
    Specified by:
    
    getVertexClass in interface Graph<V extends Vertex,E extends Edge<V>>
    
    Returns:
    
    Class of the Vertices
  - inducedSubgraph
```
public AdjacencyListGraph<V,E> inducedSubgraph(java.util.Collection<V> nodes)
```
    Method to get the induced sub-graph given a collection of vertices. It requires that the whole collection of vertices are included in the graph. The induced sub-graph has the vertices given as parameter and all the edges whose source and target are elements of the collection of vertices.
    
    Parameters:
    
    nodes - Collection of vertices which will be in the induced sub-graph
    
    Returns:
    
    A new Graph of the same kind of this with the induced sub-graph.
  - getSubTree
```
public java.util.Collection<V> getSubTree(DirectedSearchIterator<V> iterator)
```
    Method that gives the vertices of the graph that, given an Interator over the vertices, are found iterating it.
    
    Parameters:
    
    iterator - Iterator that will be iterated until it give no more vertices.
    
    Returns:
    
    Collection with the vertices found.
  - getConnectedComponents
```
public java.util.Set<java.util.Set<V>> getConnectedComponents(java.lang.Boolean strongConnected)
```
    Method that gets the connected components of the graph. It is possible get Strongly Connected Components or just the Connected Components. It uses the Tarjan algorithm.
    
    Parameters:
    
    strongConnected - Parameter indicating if get Strongly or Normal Connected components
    
    Returns:
    
    A set with the Connected Components (as Sets of vertices).
  - getSimilarType
```
public AdjacencyListGraph<V,E> getSimilarType()
```
    Method that return a new Graph with the same class of vertices and edges.
    
    Returns:
    
    New AdjacencyListGraph with the same vertex and edge class.

Class AdjacencyListGraph<V extends Vertex,E extends Edge<V>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface rioko.grapht.Graph

Field Detail

edgeClass

Constructor Detail

AdjacencyListGraph

Method Detail

setLoopsAvaible

addEdge

addVertex

containsVertex

edgeSet

getEdgeFactory

getVertexFactory

removeEdge

removeVertex

vertexSet

edgesFrom

getEdgeClass

getVertexClass

inducedSubgraph

getSubTree

getConnectedComponents

getSimilarType