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

# Package org.neo4j.graphdb.traversal

Traversal framework.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  BidirectionalTraversalDescription | Represents a description of a bidirectional traversal.
  BidirectionalUniquenessFilter |
  BranchCollisionDetector | In a bidirectional traversal there's one traversal from each start/end side and they will probably meet somewhere in the middle and the full paths are formed.
  BranchCollisionPolicy | Copied from kernel package so that we can hide kernel from the public API.
  BranchOrderingPolicy | Creator of `BranchSelector` instances with a starting point to base the first decision on.
  BranchSelector | Decides "where to go next" in a traversal.
  BranchState<STATE> | Accessor for a state associated with a `TraversalBranch` during a traversal.
  Evaluator | An Evaluator controls what's to be returned from a traversal and also how pruning is done.
  InitialBranchState<STATE> | Factory for initial state of `TraversalBranch`es in a traversal.
  InitialStateFactory<STATE> | Deprecated use `InitialBranchState` instead, which has got `InitialBranchState.reverse()` as well.
  PathEvaluator<STATE> | A PathEvaluator controls what's to be returned from a traversal and also how pruning is done.
  Paths.PathDescriptor<T extends Path> | Provides hooks to help build a string representation of a `Path`.
  PruneEvaluator | Deprecated because of the introduction of `Evaluator` which combines `PruneEvaluator` and filtering (`Predicate` of `Path`s).
  SideSelector | Dictates which side is the current side in a bidirectional traversal to traverse the next step for.
  SideSelectorPolicy | A factory for `SideSelector`s.
  TraversalBranch | Represents a `position` and a `RelationshipExpander` with a traversal context, for example parent and an iterator of relationships to go next.
  TraversalContext | Provides a context for `TraversalBranch`es which they need to move further and report their progress.
  TraversalDescription | Represents a description of a traversal.
  TraversalMetadata | Provides metadata about a traversal.
  Traverser | This interface represents the traverser which is used to step through the results of a traversal.
  UniquenessFactory | Factory for `UniquenessFilter` filters, it can supply the created `UniquenessFilter` with an optional parameter which is up to the filter itself to validate and make sense of.
  UniquenessFilter |

- Class Summary
  Class | Description
  --- | ---
  Evaluator.AsPathEvaluator<STATE> | Exposes an `Evaluator` as a `PathEvaluator`.
  Evaluators | Common `Evaluator`s useful during common traversals.
  InitialBranchState.Adapter<STATE> |
  InitialBranchState.State<STATE> | Branch state evaluator for an initial state.
  InitialStateFactory.AsInitialBranchState<STATE> | Wraps an `InitialStateFactory` in a `InitialBranchState`
  PathEvaluator.Adapter<STATE> | Adapter for `PathEvaluator`.
  Paths | Utilities for `Path` objects.
  Paths.DefaultPathDescriptor<T extends Path> | The default `Paths.PathDescriptor` used in common toString() representations in classes implementing `Path`.
  Sorting | Provides some common traversal sorting, used by `TraversalDescription.sort(Comparator)`.

- Enum Summary
  Enum | Description
  --- | ---
  BranchCollisionPolicies | A catalogue of convenient branch collision policies Copied from kernel package so that we can hide kernel from the public API.
  BranchOrderingPolicies | A catalog of convenient branch ordering policies.
  Evaluation | Outcome of `Evaluator.evaluate(org.neo4j.graphdb.Path)`.
  SideSelectorPolicies | A catalogue of convenient side selector policies for use in bidirectional traversals.
  Uniqueness | A catalogue of convenient uniqueness factories.

## Package org.neo4j.graphdb.traversal Description

Traversal framework.

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