Interface SortFilterStep<S,PDF extends SearchPredicateFactory>
-
- Type Parameters:
S
- The "self" type (the actual exposed type of this step)PDF
- The type of factory used to create predicates infilter(Function)
.
- All Known Subinterfaces:
DistanceSortOptionsStep<S,PDF>
,FieldSortOptionsStep<S,PDF>
public interface SortFilterStep<S,PDF extends SearchPredicateFactory>
The step in a sort definition where a filter can be set to select nested objects from which values will be extracted for this sort.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description S
filter(Function<? super PDF,? extends PredicateFinalStep> clauseContributor)
Filter nested objects from which values will be extracted for this sort.default S
filter(PredicateFinalStep dslFinalStep)
Filter nested objects from which values will be extracted for this sort.S
filter(SearchPredicate searchPredicate)
Filter nested objects from which values will be extracted for this sort.
-
-
-
Method Detail
-
filter
S filter(SearchPredicate searchPredicate)
Filter nested objects from which values will be extracted for this sort.The filter is based on a previously-built
SearchPredicate
.- Parameters:
searchPredicate
- The predicate that must match.- Returns:
this
, for method chaining.
-
filter
S filter(Function<? super PDF,? extends PredicateFinalStep> clauseContributor)
Filter nested objects from which values will be extracted for this sort.The filter is defined by the given function.
Best used with lambda expressions.
- Parameters:
clauseContributor
- A function that will use the factory passed in parameter to create a predicate, returning the final step in the predicate DSL. Should generally be a lambda expression.- Returns:
this
, for method chaining.
-
filter
default S filter(PredicateFinalStep dslFinalStep)
Filter nested objects from which values will be extracted for this sort.The filter is based on an almost-built
SearchPredicate
.- Parameters:
dslFinalStep
- A final step in the predicate DSL allowing the retrieval of aSearchPredicate
.- Returns:
this
, for method chaining.
-
-