Uses of Interface org.neo4j.graphdb.traversal.PathEvaluator (Neo4j Community 2.1.0-M01 API)
Date: 2014-02-20

## Uses of Interface
org.neo4j.graphdb.traversal.PathEvaluator

- Packages that use PathEvaluator
  Package | Description
  --- | ---
  org.neo4j.graphdb.traversal | Traversal framework.

- - ### Uses of PathEvaluator in org.neo4j.graphdb.traversal

    Classes in org.neo4j.graphdb.traversal that implement PathEvaluator
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `Evaluator.AsPathEvaluator<STATE>` Exposes an `Evaluator` as a `PathEvaluator`.
    `static class` | `PathEvaluator.Adapter<STATE>` Adapter for `PathEvaluator`.

    Methods in org.neo4j.graphdb.traversal that return PathEvaluator
    Modifier and Type | Method and Description
    --- | ---
    `static PathEvaluator` | Evaluators.`all()`
    `static PathEvaluator` | Evaluators.`atDepth(int depth)` Returns an `Evaluator` which only includes positions at `depth` and prunes everything deeper than that.
    `static PathEvaluator` | Evaluators.`endNodeIs(Evaluation evaluationIfMatch, Evaluation evaluationIfNoMatch, Node... possibleEndNodes)` An `Evaluator` which will return `evaluationIfMatch` if `Path.endNode()` for a given path is any of `nodes`, else `evaluationIfNoMatch`.
    `static PathEvaluator` | Evaluators.`excludeStartPosition()`
    `static PathEvaluator` | Evaluators.`fromDepth(int depth)` Returns an `Evaluator` which only includes positions from `depth` and deeper and never prunes anything.
    `static PathEvaluator` | Evaluators.`includeIfAcceptedByAny(Evaluator... evaluators)` Whereas adding `Evaluator`s to a `TraversalDescription` puts those evaluators in `AND-mode` this can group many evaluators in `OR-mode`.
    `static PathEvaluator` | Evaluators.`includeIfAcceptedByAny(PathEvaluator... evaluators)` Whereas adding `Evaluator`s to a `TraversalDescription` puts those evaluators in `AND-mode` this can group many evaluators in `OR-mode`.
    `static PathEvaluator` | Evaluators.`includeIfContainsAll(Node... nodes)` Evaluator which decides to include a `Path` if all the `nodes` exist in it.
    `static PathEvaluator` | Evaluators.`includeWhereEndNodeIs(Node... nodes)`
    `static PathEvaluator` | Evaluators.`includeWhereLastRelationshipTypeIs(RelationshipType type, RelationshipType... orAnyOfTheseTypes)`
    `static PathEvaluator` | Evaluators.`includingDepths(int minDepth, int maxDepth)` Returns an `Evaluator` which only includes positions between depths `minDepth` and `maxDepth`.
    `static PathEvaluator` | Evaluators.`lastRelationshipTypeIs(Evaluation evaluationIfMatch, Evaluation evaluationIfNoMatch, RelationshipType type, RelationshipType... orAnyOfTheseTypes)` Returns an `Evaluator` which compares the type of the last relationship in a `Path` to a given set of relationship types (one or more).If the type of the last relationship in a path is of one of the given types then `evaluationIfMatch` will be returned, otherwise `evaluationIfNoMatch` will be returned.
    `static PathEvaluator` | Evaluators.`pruneWhereEndNodeIs(Node... nodes)`
    `static PathEvaluator` | Evaluators.`pruneWhereLastRelationshipTypeIs(RelationshipType type, RelationshipType... orAnyOfTheseTypes)`
    `static PathEvaluator` | Evaluators.`toDepth(int depth)` Returns an `Evaluator` which includes positions down to `depth` and prunes everything deeper than that.

    Methods in org.neo4j.graphdb.traversal with parameters of type PathEvaluator
    Modifier and Type | Method and Description
    --- | ---
    `BidirectionalTraversalDescription` | BidirectionalTraversalDescription.`collisionEvaluator(PathEvaluator collisionEvaluator)` Sets the `PathEvaluator` to use for branch collisions.
    `TraversalDescription` | TraversalDescription.`evaluator(PathEvaluator evaluator)` Adds `evaluator` to the list of evaluators which will control the behavior of the traversal.
    `static PathEvaluator` | Evaluators.`includeIfAcceptedByAny(PathEvaluator... evaluators)` Whereas adding `Evaluator`s to a `TraversalDescription` puts those evaluators in `AND-mode` this can group many evaluators in `OR-mode`.

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