org.neo4j.graphdb.traversal

Interface Evaluator

All Known Subinterfaces:

PathEvaluator<STATE>

All Known Implementing Classes:

Evaluator.AsPathEvaluator, PathEvaluator.Adapter

public interface Evaluator

An Evaluator controls what's to be returned from a traversal and also how pruning is done. It looks at a Path 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.

Author:

Mattias Persson

See Also:

Evaluation, Evaluators, TraversalDescription.evaluator(Evaluator)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Evaluator.AsPathEvaluator<STATE> Exposes an Evaluator as a PathEvaluator.

Method Summary

Modifier and Type	Method and Description
Evaluation	evaluate(Path path) Evaluates a Path and returns an Evaluation containing information about whether or not to include it in the traversal result, i.e return it from the Traverser.

Method Detail

evaluate

Evaluation evaluate(Path path)

Evaluates a Path and returns an Evaluation containing information about whether or not to include it in the traversal result, i.e return it from the Traverser. And also whether or not to continue traversing down that path or if it instead should be pruned so that the traverser won't continue down that branch represented by path.

Parameters:

path - the Path to evaluate.

Returns:

an Evaluation containing information about whether or not to return it from the Traverser and whether or not to continue down that path.