org.pandora.api.knowledge
Interface VertexIterator

All Known Implementing Classes:

AbstractVertexIterator

public interface VertexIterator

Allow iteration over all related vertices and all descendants.

Method Summary

void	addBreadth(Vertex vertex) Add the vertex to the breadth set for traversal.
int	decrementDepth() Increment the current depth of traversal.
java.util.Map<Vertex,Vertex>	getBreadthSet() Return the set of vertices for the next breadth first traversal level.
int	getDepth() Return the current depth of traversal.
boolean	getIgnorePrimitives() Do not iterate on or over primitives.
int	getMaxDepth() Return the max depth of relationships to traverse, -1 means all.
int	getMaxIterations() Maximum number of vertices to iterator over, -1 means no maximum.
Path	getPath() Traversal path.
java.util.Map<Vertex,Vertex>	getTraversed() Return the set of already traversed vertices.
int	incrementDepth() Increment the current depth of traversal.
boolean	isMaxDepth() Return if the iterator is at the max depth.
boolean	isMaxIterations() Return if the iterator has iterated the max iterations.
boolean	iterate(Vertex vertex) Iterate on the vertex, and return true if children should be traversed.
void	setBreadthSet(java.util.Map<Vertex,Vertex> breadthSet) Set of vertices for the next breadth first traversal level.
void	setDepth(int depth) Set the current depth of traversal.

Method Detail

getIgnorePrimitives

boolean getIgnorePrimitives()

Do not iterate on or over primitives.

getMaxIterations

int getMaxIterations()

Maximum number of vertices to iterator over, -1 means no maximum.

getMaxDepth

int getMaxDepth()

Return the max depth of relationships to traverse, -1 means all.

isMaxDepth

boolean isMaxDepth()

Return if the iterator is at the max depth.

isMaxIterations

boolean isMaxIterations()

Return if the iterator has iterated the max iterations.

incrementDepth

int incrementDepth()

Increment the current depth of traversal.

decrementDepth

int decrementDepth()

Increment the current depth of traversal.

getDepth

int getDepth()

Return the current depth of traversal.

setDepth

void setDepth(int depth)

Set the current depth of traversal.

getPath

Path getPath()

Traversal path.

iterate

boolean iterate(Vertex vertex)

Iterate on the vertex, and return true if children should be traversed.

getTraversed

java.util.Map<Vertex,Vertex> getTraversed()

Return the set of already traversed vertices.

getBreadthSet

java.util.Map<Vertex,Vertex> getBreadthSet()

Return the set of vertices for the next breadth first traversal level.

setBreadthSet

void setBreadthSet(java.util.Map<Vertex,Vertex> breadthSet)

Set of vertices for the next breadth first traversal level.

addBreadth

void addBreadth(Vertex vertex)

Add the vertex to the breadth set for traversal.