org.neo4j.graphdb.traversal
Interface UniquenessFilter

public interface UniquenessFilter

Filter for Paths to make sure that a specific uniqueness contract is fulfilled. Only paths that fulfill the uniqueness contract will be let through. For example a uniqueness contract that for any given Path "there cannot be any node occurring more than once", or that "the end node being visited right now must not have been visited before".

Method Summary

boolean	check(TraversalBranch branch) Checks whether or not branch is unique, and hence can be visited in this traversal.
boolean	checkFirst(TraversalBranch branch) The check whether or not to expand the first branch is a separate method because it may contain checks which would be unnecessary for all other checks.
boolean	checkFull(Path path) Checks Path alone to see if it follows the uniqueness contract provided by this UniquenessFilter.

Method Detail

checkFirst

boolean checkFirst(TraversalBranch branch)

The check whether or not to expand the first branch is a separate method because it may contain checks which would be unnecessary for all other checks. So it's purely an optimization.

Parameters:

branch - the first branch to check, i.e. the branch representing the start node in the traversal.

Returns:

whether or not branch is unique, and hence can be visited in this traversal.

check

boolean check(TraversalBranch branch)

Checks whether or not branch is unique, and hence can be visited in this traversal.

Parameters:

branch - the TraversalBranch to check for uniqueness.

Returns:

whether or not branch is unique, and hence can be visited in this traversal.

checkFull

boolean checkFull(Path path)

Checks Path alone to see if it follows the uniqueness contract provided by this UniquenessFilter.

Parameters:

path - the Path to examine.

Returns:

true if the path fulfills the uniqueness contract, otherwise false.