galileo.graph

Class Vertex<L extends java.lang.Comparable<L>,V>

java.lang.Object

galileo.graph.Vertex<L,V>

public class Vertex<L extends java.lang.Comparable<L>,V>
extends java.lang.Object

Provides a lightweight generic implementation of a graph vertex backed by a TreeMap for extensibility. This provides the basis of the hybrid trees/graphs used in the system.

Author:

malensek

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.TreeMap<L,Vertex<L,V>>	edges
protected L	label
protected java.util.Set<V>	values

Constructor Summary

Constructors

Constructor and Description
Vertex()
Vertex(L label)
Vertex(L label, java.util.Collection<V> values)
Vertex(L label, V value)
Vertex(Vertex<L,V> v)

Method Summary

Modifier and Type	Method and Description
void	addPath(java.util.Iterator<Vertex<L,V>> path) Add and connect a collection of vertices in the form of a traversal path.
void	addValue(V value)
void	addValues(java.util.Collection<V> values)
void	clearEdges() Removes all the edges from this Vertex, severing any connections with neighboring vertices.
void	clearValues() Clears all values associated with this Vertex.
Vertex<L,V>	connect(Vertex<L,V> vertex) Connnects two vertices.
boolean	connectedTo(L label) Determines if two vertices are connected.
java.util.List<Path<L,V>>	descendantPaths() Retrieves all Path instances represented by the children of this Vertex.
java.util.Collection<Vertex<L,V>>	getAllNeighbors() Traverse all edges to return all neighboring vertices.
L	getLabel()
Vertex<L,V>	getNeighbor(L label) Retrieve a neighboring Vertex.
java.util.Set<L>	getNeighborLabels() Retrieve the labels of all neighboring vertices.
java.util.NavigableMap<L,Vertex<L,V>>	getNeighborsGreaterThan(L label, boolean inclusive)
java.util.NavigableMap<L,Vertex<L,V>>	getNeighborsLessThan(L label, boolean inclusive)
java.util.Set<V>	getValues()
long	numDescendantEdges() Retrieves the number of descendant edges for this Vertex.
long	numDescendants() Retrieves the number of descendant vertices for this Vertex.
void	setLabel(L label)
java.lang.String	toString()
protected java.lang.String	toString(int indent) Pretty-print this vertex (and its children) with a given indent level.
protected void	traverseDescendants(Vertex<L,V> vertex, java.util.List<Path<L,V>> paths, Path<L,V> currentPath) Traverses through descendant Vertices, finding Path instances.

Methods inherited from class java.lang.Object

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

Field Detail

label

protected L extends java.lang.Comparable<L> label

values

protected java.util.Set<V> values

edges

protected java.util.TreeMap<L extends java.lang.Comparable<L>,Vertex<L extends java.lang.Comparable<L>,V>> edges

Constructor Detail

Vertex

public Vertex()

Vertex

public Vertex(L label)

Vertex

public Vertex(L label,
              V value)

Vertex

public Vertex(L label,
              java.util.Collection<V> values)

Vertex

public Vertex(Vertex<L,V> v)

Method Detail

connectedTo

public boolean connectedTo(L label)

Determines if two vertices are connected.

Returns:

true if the Vertex label is found on a connecting edge.

getNeighbor

public Vertex<L,V> getNeighbor(L label)

Retrieve a neighboring Vertex.

Parameters:

label - Neighbor's label.

Returns:

Neighbor Vertex.

getNeighborsLessThan

public java.util.NavigableMap<L,Vertex<L,V>> getNeighborsLessThan(L label,
                                                                  boolean inclusive)

getNeighborsGreaterThan

public java.util.NavigableMap<L,Vertex<L,V>> getNeighborsGreaterThan(L label,
                                                                     boolean inclusive)

getNeighborLabels

public java.util.Set<L> getNeighborLabels()

Retrieve the labels of all neighboring vertices.

Returns:

Neighbor Vertex labels.

getAllNeighbors

public java.util.Collection<Vertex<L,V>> getAllNeighbors()

Traverse all edges to return all neighboring vertices.

Returns:

collection of all neighboring vertices.

connect

public Vertex<L,V> connect(Vertex<L,V> vertex)

Connnects two vertices. If this vertex is already connected to the provided vertex label, then the already-connected vertex is returned, and its value is updated.

Parameters:

vertex - The vertex to connect to.

Returns:

Connected vertex.

addPath

public void addPath(java.util.Iterator<Vertex<L,V>> path)

Add and connect a collection of vertices in the form of a traversal path.

getLabel

public L getLabel()

setLabel

public void setLabel(L label)

getValues

public java.util.Set<V> getValues()

addValue

public void addValue(V value)

addValues

public void addValues(java.util.Collection<V> values)

descendantPaths

public java.util.List<Path<L,V>> descendantPaths()

Retrieves all Path instances represented by the children of this Vertex.

Returns:

List of Paths that are descendants of this Vertex

traverseDescendants

protected void traverseDescendants(Vertex<L,V> vertex,
                                   java.util.List<Path<L,V>> paths,
                                   Path<L,V> currentPath)

Traverses through descendant Vertices, finding Path instances. A Path leads to one or more payloads stored as Vertex values. This method is designed to be used recursively.

Parameters:

vertex - Vertex to query descendants

paths - List of Paths discovered thus far during traversal. This is updated as new Path instances are found.

currentPath - The current Path being inspected by the traversal

numDescendants

public long numDescendants()

Retrieves the number of descendant vertices for this Vertex.

Returns:

number of descendants (children)

numDescendantEdges

public long numDescendantEdges()

Retrieves the number of descendant edges for this Vertex. This count includes the links between descendants for scan operations.

Returns:

number of descendant edges.

clearEdges

public void clearEdges()

Removes all the edges from this Vertex, severing any connections with neighboring vertices.

clearValues

public void clearValues()

Clears all values associated with this Vertex.

toString

protected java.lang.String toString(int indent)

Pretty-print this vertex (and its children) with a given indent level.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object