TraversalMetadata (Neo4j Community 2.1.0-M01 API)
Date: 2014-02-20

org.neo4j.graphdb.traversal

## Interface TraversalMetadata

- All Known Subinterfaces:
    TraversalContext

      public interface TraversalMetadata

  Provides metadata about a traversal.
  Author:
    Mattias Persson

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `getNumberOfPathsReturned()`
    `int` | `getNumberOfRelationshipsTraversed()`

- - ### Method Detail

    - #### getNumberOfPathsReturned

          int getNumberOfPathsReturned()

      Returns:
        number of paths returned up to this point in the traversal.

    - #### getNumberOfRelationshipsTraversed

          int getNumberOfRelationshipsTraversed()

      Returns:
        number of relationships traversed up to this point in the traversal. Some relationships in this counter might be unnecessarily traversed relationships, but at the same time it gives an accurate measure of how many relationships are requested from the underlying graph. Useful for comparing and first-level debugging of queries.

Copyright © 2002–2014 The Neo4j Graph Database Project. All rights reserved.