Package org.hibernate.search.engine.search.query.dsl

Interface SearchQueryWhereStep<N extends SearchQueryOptionsStep<?,H,LOS,?,?>,H,LOS,PDF extends SearchPredicateFactory>

Type Parameters:

N - The type of the next step, returned after a predicate is defined.

H - The type of hits for the created query.

PDF - The type of factory used to create predicates in where(Function).

LOS - The type of the initial step of the loading options definition DSL accessible through SearchQueryOptionsStep.loading(Consumer).

All Known Subinterfaces:

ElasticsearchSearchQuerySelectStep<R,E,LOS>, ElasticsearchSearchQueryWhereStep<H,LOS>, LuceneSearchQuerySelectStep<R,E,LOS>, LuceneSearchQueryWhereStep<H,LOS>, SearchQuerySelectStep<N,R,E,LOS,PJF,PDF>

All Known Implementing Classes:

AbstractDelegatingSearchQuerySelectStep, AbstractExtendedSearchQueryOptionsStep, AbstractSearchQueryOptionsStep, AbstractSearchQuerySelectStep, DefaultSearchQuerySelectStep, ElasticsearchSearchQuerySelectStepImpl, LuceneSearchQuerySelectStepImpl

public interface SearchQueryWhereStep<N extends SearchQueryOptionsStep<?,H,LOS,?,?>,H,LOS,PDF extends SearchPredicateFactory>

The step in a query definition where the predicate, i.e. the "WHERE" clause, can be set.

Method Summary

Modifier and Type	Method	Description
N	where(BiConsumer<? super PDF,? super SimpleBooleanPredicateClausesCollector<?>> predicateContributor)	Set the predicate for this query.
N	where(Function<? super PDF,? extends PredicateFinalStep> predicateContributor)	Set the predicate for this query.
N	where(SearchPredicate predicate)	Set the predicate for this query.

Method Detail

where

N where(SearchPredicate predicate)

Set the predicate for this query.

Parameters:

predicate - A SearchPredicate object obtained from the search scope.

Returns:

The next step.

where

N where(Function<? super PDF,? extends PredicateFinalStep> predicateContributor)

Set the predicate for this query.

Parameters:

predicateContributor - 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:

The next step.

where

N where(BiConsumer<? super PDF,? super SimpleBooleanPredicateClausesCollector<?>> predicateContributor)

Set the predicate for this query.

Parameters:

predicateContributor - A consumer that will use the factory passed in parameter to create predicates and add them as clauses to the collector passed in parameter. Should generally be a lambda expression. The resulting root predicate will have to match all clauses.

Returns:

The next step.

See Also:

SimpleBooleanPredicateClausesCollector