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

Interface SearchQueryWhereStep<N extends SearchQueryOptionsStep<?,H,?,?,?>,H,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).

All Known Subinterfaces:

SearchQuerySelectStep<N,R,E,LOS,PJF,PDF>

All Known Implementing Classes:

AbstractDelegatingSearchQuerySelectStep, AbstractExtendedSearchQueryOptionsStep, AbstractSearchQueryOptionsStep, AbstractSearchQuerySelectStep

public interface SearchQueryWhereStep<N extends SearchQueryOptionsStep<?,H,?,?,?>,H,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 and Description
default N	predicate(Function<? super PDF,? extends PredicateFinalStep> predicateContributor) Deprecated. Use where(Function) instead.
default N	predicate(SearchPredicate predicate) Deprecated. Use where(SearchPredicate) instead.
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.

predicate

@Deprecated
default N predicate(SearchPredicate predicate)

Deprecated. Use where(SearchPredicate) instead.

Set the predicate for this query.

Parameters:

predicate - A SearchPredicate object obtained from the search scope.

Returns:

The next step.

predicate

@Deprecated
default N predicate(Function<? super PDF,? extends PredicateFinalStep> predicateContributor)

Deprecated. Use where(Function) instead.

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.