Package org.neo4j.graphdb.traversal
Interface PathEvaluator<STATE>
- Type Parameters:
STATE
- type of state each branch holds.
- All Superinterfaces:
Evaluator
- All Known Implementing Classes:
Evaluator.AsPathEvaluator
,PathEvaluator.Adapter
A PathEvaluator controls what's to be returned from a traversal and also how
pruning is done. It looks at a
Path
and BranchState
and decides
whether or not it should be included in the traversal result. It also decides
whether the traverser should continue down that path or if it should be pruned
so that the traverser won't continue down that path.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.neo4j.graphdb.traversal.Evaluator
Evaluator.AsPathEvaluator<STATE>
-
Method Summary
Modifier and TypeMethodDescriptionevaluate
(Path path, BranchState<STATE> state) Evaluates aPath
and returns anEvaluation
containing information about whether or not to include it in the traversal result, i.e return it from theTraverser
.
-
Method Details
-
evaluate
Evaluates aPath
and returns anEvaluation
containing information about whether or not to include it in the traversal result, i.e return it from theTraverser
. And also whether or not to continue traversing down thatpath
or if it instead should be pruned so that the traverser won't continue down that branch represented bypath
.- Parameters:
path
- thePath
to evaluate.state
- the state of this branch in the current traversal.- Returns:
- an
Evaluation
containing information about whether or not to return it from theTraverser
and whether or not to continue down that path.
-