org.clafer.graph

Class KeyGraph<V>

java.lang.Object

org.clafer.graph.KeyGraph<V>

Type Parameters:

V - the type of the data

All Implemented Interfaces:

Graph<V>

public class KeyGraph<V>
extends Object
implements Graph<V>

A graph where every data is mapped to exactly one node.

There exists a injection from the data to the vertices. This graph maintains a mapping from data to its vertex. New vertices are created on-the-fly.

For example, a 2-cycle graph:

 KeyGraph<Character>graph = new KeyGraph<Character>();
 graph.getVertex('a').addNeighbour(graph.getVertex('b'));
 graph.getVertex('b').addNeighbour(graph.getVertex('a'));
 

Author:

jimmy

Constructor Summary

Constructors

Constructor and Description
KeyGraph()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEdge(V from, V to)
void	addUndirectedEdge(V from, V to)
Vertex<V>	getVertex(V data) Returns the vertex associated with the data.
Collection<Vertex<V>>	getVertices() Return the set of vertices contained in the graph.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KeyGraph

public KeyGraph()

Method Detail

getVertex

public Vertex<V> getVertex(V data)

Returns the vertex associated with the data. The data class should implement equals and hashCode.

Parameters:

data - the data

Returns:

the vertex containing the data

See Also:

Object.equals(Object), Object.hashCode()

addEdge

public void addEdge(V from,
           V to)

addUndirectedEdge

public void addUndirectedEdge(V from,
                     V to)

getVertices

public Collection<Vertex<V>> getVertices()

Return the set of vertices contained in the graph. Vertices can be removed but not added. Vertices can be mutated.

Specified by:

getVertices in interface Graph<V>

Returns:

the set of vertices

toString

public String toString()

Overrides:

toString in class Object