org.neo4j.api.core
Interface TraversalPosition


public interface TraversalPosition

Encapsulates information about the current traversal position.


Method Summary
 Node currentNode()
          Return the current node.
 int depth()
          Returns the current traversal depth.
 Relationship lastRelationshipTraversed()
          Return the last relationship traversed, may be null.
 Node previousNode()
          Returns the previous node, may be null.
 int returnedNodesCount()
          Return the number of nodes returned by traverser so far.
 

Method Detail

currentNode

Node currentNode()
Return the current node.

Returns:
The current node

previousNode

Node previousNode()
Returns the previous node, may be null.

Returns:
The previous node

lastRelationshipTraversed

Relationship lastRelationshipTraversed()
Return the last relationship traversed, may be null.

Returns:
The last relationship traversed

depth

int depth()
Returns the current traversal depth.

Returns:
The current traversal depth

returnedNodesCount

int returnedNodesCount()
Return the number of nodes returned by traverser so far.

Returns:
The number of returned nodes.


Copyright © 2007 Neo4j. All Rights Reserved.