Package org.neo4j.graphdb.traversal
Interface UniquenessFactory
- All Known Implementing Classes:
Uniqueness
public interface 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.-
Method Summary
Modifier and TypeMethodDescriptionCreates a newUniquenessFilter
optionally with a parameter to it, otherwise null if no parameter should be handed to it.boolean
Specifies if theUniquenessFilter
must handle start branches eagerly.
-
Method Details
-
create
Creates a newUniquenessFilter
optionally with a parameter to it, otherwise null if no parameter should be handed to it.- Parameters:
optionalParameter
- an optional parameter to control the behavior of the returnedUniquenessFilter
. It's up to each filter implementation to decide what values are OK and what they mean and the caller of this method need to know that and pass in the correct parameter type.- Returns:
- a new
UniquenessFilter
of the type that this factory creates.
-
eagerStartBranches
boolean eagerStartBranches()Specifies if theUniquenessFilter
must handle start branches eagerly. Depending on the level of uniqueness it is not always necessary to eagerly exhaust start branches which can speed up the execution of the traversal.- Returns:
true
if eager start branches must be used, otherwisefalse
.
-