edu.ucla.sspace.graph

Class LabeledGraph<L,E extends Edge>

java.lang.Object

edu.ucla.sspace.graph.GraphAdaptor<E>

edu.ucla.sspace.graph.LabeledGraph<L,E>

All Implemented Interfaces:

Graph<E>, Serializable

public class LabeledGraph<L,E extends Edge>
extends GraphAdaptor<E>
implements Serializable

A decorator around all graph types that allows vertices to take on arbitrary labels. This class does not directly implement Graph but rather exposes the backing graph through the #graph() method, which ensures that the backing graph is of the appropriate type (or subtype).

The view returned by #graph() is read-only with respect to vertices (i.e., edges may be added or removed). This ensures that all vertex additions or removals to the graph are made through this class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LabeledGraph(Graph<E> graph)
LabeledGraph(Graph<E> graph, Indexer<L> vertexLabels)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(int vertex) Adds a vertex with the provided index to the graph, returning true if the vertex was not previously present (optional operation).
boolean	add(L vertexLabel)
boolean	contains(L vertexLabel)
LabeledGraph<L,E>	copy(Set<Integer> vertices) Creates a copy of this graph containing only the specified number of vertices and all edges between those vertices.
boolean	remove(L vertexLabel)
String	toString()

Methods inherited from class edu.ucla.sspace.graph.GraphAdaptor

add, clear, clearEdges, contains, contains, contains, degree, edges, getAdjacencyList, getEdges, getNeighbors, hasCycles, order, remove, remove, size, subgraph, vertices

Methods inherited from class java.lang.Object

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

Constructor Detail

LabeledGraph

public LabeledGraph(Graph<E> graph)

LabeledGraph

public LabeledGraph(Graph<E> graph,
            Indexer<L> vertexLabels)

Method Detail

add

public boolean add(L vertexLabel)

add

public boolean add(int vertex)

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<E extends Edge>

Overrides:

add in class GraphAdaptor<E extends Edge>

Parameters:

vertex - 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

Throws:

IllegalArgumentException - if adding a vertex that has not previously been assigned a label

copy

public LabeledGraph<L,E> 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<E extends Edge>

Overrides:

copy in class GraphAdaptor<E extends Edge>

contains

public boolean contains(L vertexLabel)

remove

public boolean remove(L vertexLabel)

toString

public String toString()

Description copied from class: GraphAdaptor

Overrides:

toString in class GraphAdaptor<E extends Edge>