com.codemelon.graph.vertex

Class DirectedEdgeDataVertex<T>

java.lang.Object

com.codemelon.graph.vertex.AbstractVertex

com.codemelon.graph.vertex.DirectedEdgeDataVertex<T>

All Implemented Interfaces:

EdgeDataVertex<T>, Vertex

Direct Known Subclasses:

DirectedDfsVertex, DirectedShortestPathVertex, UndirectedEdgeDataVertex

public class DirectedEdgeDataVertex<T>
extends AbstractVertex
implements EdgeDataVertex<T>

Constructor Summary

Constructors

Constructor and Description
DirectedEdgeDataVertex(EdgeDataFactory<T> edgeDataFactory) Constructor from an EdgeDataFactory

Method Summary

Methods

Modifier and Type	Method and Description
<V extends Vertex> boolean	addAdjacency(V to) Adds the specified vertex to the set of adjacencies.
int	adjacencyCount() Returns the number of vertices in the adjacency set
void	clearAdjacencies() Removes all vertices from the adjacency set.
boolean	containsAdjacency(Vertex to) Returns true if the adjacency set contains the specified vertex
java.util.Set<? extends Vertex>	getAdjacencies() Returns a set of all adjacent vertices
T	getEdgeData(EdgeDataVertex<T> to) Get data for a particular edge.
boolean	hasAdjacencies() Returns true if the vertex is the tail of at least one edge
boolean	removeAdjacency(Vertex to) Removes the specified vertex from the adjacency set.

Methods inherited from class com.codemelon.graph.vertex.AbstractVertex

equals, getGraph, setGraph

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.codemelon.graph.vertex.Vertex

getGraph, setGraph

Constructor Detail

DirectedEdgeDataVertex

public DirectedEdgeDataVertex(EdgeDataFactory<T> edgeDataFactory)

Constructor from an EdgeDataFactory

Parameters:

edgeDataFactory - factory to use for creating new EdgeData objects

Method Detail

addAdjacency

public <V extends Vertex> boolean addAdjacency(V to)

Description copied from interface: Vertex

Adds the specified vertex to the set of adjacencies. Note that this method only adds a directed adjacency. If the vertex belongs to an undirected graph, the graph will be put into an inconsistent state if an adjacency (u, v) is added using this method without also adding the directed adjacency (v, u)!

Specified by:

addAdjacency in interface Vertex

Parameters:

to - vertex to be added

Returns:

true if the adjacency list did not already contain to

removeAdjacency

public boolean removeAdjacency(Vertex to)

Description copied from interface: Vertex

Removes the specified vertex from the adjacency set. Note that this method only removes a directed adjacency.

Specified by:

removeAdjacency in interface Vertex

Parameters:

to - vertex to be removed

Returns:

true if the vertex was found in the adjacency set

clearAdjacencies

public void clearAdjacencies()

Description copied from interface: Vertex

Removes all vertices from the adjacency set. The adjacency set will be empty after this call returns. The cautionary statements regarding the use of removeAdjacency() in an undirected graph also apply to this method.

Specified by:

clearAdjacencies in interface Vertex

containsAdjacency

public final boolean containsAdjacency(Vertex to)

Description copied from interface: Vertex

Returns true if the adjacency set contains the specified vertex

Specified by:

containsAdjacency in interface Vertex

Parameters:

to - vertex whose presence is to be tested

Returns:

true if to is found in the adjacency set

adjacencyCount

public final int adjacencyCount()

Description copied from interface: Vertex

Returns the number of vertices in the adjacency set

Specified by:

adjacencyCount in interface Vertex

Returns:

the number of vertices in this adjacency set (its cardinality)

getAdjacencies

public final java.util.Set<? extends Vertex> getAdjacencies()

Description copied from interface: Vertex

Returns a set of all adjacent vertices

Specified by:

getAdjacencies in interface Vertex

Returns:

a set of all adjacent vertices

hasAdjacencies

public final boolean hasAdjacencies()

Description copied from interface: Vertex

Returns true if the vertex is the tail of at least one edge

Specified by:

hasAdjacencies in interface Vertex

Returns:

true if the vertex has at least one adjacency

getEdgeData

public T getEdgeData(EdgeDataVertex<T> to)

Description copied from interface: EdgeDataVertex

Get data for a particular edge.

Specified by:

getEdgeData in interface EdgeDataVertex<T>

Parameters:

to - head of the edge for which to retrieve data

Returns:

the data for the given edge