org.neo4j.kernel.impl.traversal
Class FinalTraversalBranch

java.lang.Object
  extended by org.neo4j.kernel.impl.traversal.FinalTraversalBranch
All Implemented Interfaces:
TraversalBranch

public final class FinalTraversalBranch
extends Object
implements TraversalBranch


Constructor Summary
FinalTraversalBranch(Node head, Relationship... path)
           
 
Method Summary
 int depth()
          The depth for this expansion source compared to the start node of the traversal.
 Evaluation evaluation()
           
 int expanded()
          Returns the number of relationships this expansion source has expanded.
 void initialize()
           
 TraversalBranch next()
          Returns null since FinalTraversalBranch does not expand.
 Node node()
          The node for this expansion source.
 TraversalBranch parent()
          The parent expansion source which created this TraversalBranch.
 Path position()
          The position represented by this expansion source.
 Relationship relationship()
          The relationship for this expansion source.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FinalTraversalBranch

public FinalTraversalBranch(Node head,
                            Relationship... path)
Method Detail

depth

public int depth()
Description copied from interface: TraversalBranch
The depth for this expansion source compared to the start node of the traversal.

Specified by:
depth in interface TraversalBranch
Returns:
the depth of this expansion source.

next

public TraversalBranch next()
Returns null since FinalTraversalBranch does not expand.

Specified by:
next in interface TraversalBranch
Returns:
the next expansion source from this expansion source.

node

public Node node()
Description copied from interface: TraversalBranch
The node for this expansion source.

Specified by:
node in interface TraversalBranch
Returns:
the node for this expansion source.

parent

public TraversalBranch parent()
Description copied from interface: TraversalBranch
The parent expansion source which created this TraversalBranch.

Specified by:
parent in interface TraversalBranch
Returns:
the parent of this expansion source.

position

public Path position()
Description copied from interface: TraversalBranch
The position represented by this expansion source.

Specified by:
position in interface TraversalBranch
Returns:
the position represented by this expansion source.

relationship

public Relationship relationship()
Description copied from interface: TraversalBranch
The relationship for this expansion source. It's the relationship which was traversed to get to this expansion source.

Specified by:
relationship in interface TraversalBranch
Returns:
the relationship for this expansion source.

expanded

public int expanded()
Description copied from interface: TraversalBranch
Returns the number of relationships this expansion source has expanded. In this count isn't included the relationship which led to coming here (since that could also be traversed, although skipped, when expanding this source).

Specified by:
expanded in interface TraversalBranch
Returns:
the number of relationships this expansion source has expanded.

evaluation

public Evaluation evaluation()
Specified by:
evaluation in interface TraversalBranch

initialize

public void initialize()
Specified by:
initialize in interface TraversalBranch


Copyright © 2002-2012 The Neo4j Graph Database Project. All Rights Reserved.