Package org.hibernate.search.engine.search.predicate.dsl

Interface GenericBooleanPredicateClausesStep<SR,S extends C,C extends BooleanPredicateOptionsCollector<SR,?>>

Type Parameters:

SR - Scope root type.

S - The "self" type (the actual exposed type of this collector).

C - The "collector" type (the type of collector passed to the consumer in with(Consumer).

All Superinterfaces:

BooleanPredicateOptionsCollector<SR,C>, CommonMinimumShouldMatchOptionsStep<C>, PredicateFinalStep, PredicateScoreStep<S>

All Known Subinterfaces:

BooleanPredicateClausesStep<SR,S>

public interface GenericBooleanPredicateClausesStep<SR,S extends C,C extends BooleanPredicateOptionsCollector<SR,?>>
extends BooleanPredicateOptionsCollector<SR,C>, PredicateScoreStep<S>, PredicateFinalStep

A generic superinterface for Predicate DSL steps that involve collecting clauses and options of a boolean predicate.

This interface mostly a technical detail to handle generics in the predicate DSL; refer to BooleanPredicateOptionsCollector, PredicateScoreStep or PredicateFinalStep for meaningful documentation.

Method Summary

Modifier and Type	Method	Description
S	filter(Function<? super TypedSearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Add a "filter" clause to be defined by the given function.
default S	filter(PredicateFinalStep dslFinalStep)	Add a "filter" clause based on an almost-built SearchPredicate.
S	filter(SearchPredicate searchPredicate)	Add a "filter" clause based on a previously-built SearchPredicate.
MinimumShouldMatchConditionStep<S>	minimumShouldMatch()
S	minimumShouldMatch(Consumer<? super MinimumShouldMatchConditionStep<?>> constraintContributor)	Start defining the minimum number of "should" constraints that have to match in order for the boolean predicate to match.
default S	minimumShouldMatchNumber(int matchingClausesNumber)	Add a default "minimumShouldMatch" constraint.
default S	minimumShouldMatchPercent(int matchingClausesPercent)	Add a default "minimumShouldMatch" constraint.
S	must(Function<? super TypedSearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Add a "must" clause to be defined by the given function.
default S	must(PredicateFinalStep dslFinalStep)	Add a "must" clause based on an almost-built SearchPredicate.
S	must(SearchPredicate searchPredicate)	Add a "must" clause based on a previously-built SearchPredicate.
S	mustNot(Function<? super TypedSearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Add a "must not" clause to be defined by the given function.
default S	mustNot(PredicateFinalStep dslFinalStep)	Add a "must not" clause based on an almost-built SearchPredicate.
S	mustNot(SearchPredicate searchPredicate)	Add a "must not" clause based on a previously-built SearchPredicate.
S	should(Function<? super TypedSearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)	Add a "should" clause to be defined by the given function.
default S	should(PredicateFinalStep dslFinalStep)	Add a "should" clause based on an almost-built SearchPredicate.
S	should(SearchPredicate searchPredicate)	Add a "should" clause based on a previously-built SearchPredicate.
S	with(Consumer<? super C> contributor)	Delegates setting clauses and options to a given consumer.

Methods inherited from interface org.hibernate.search.engine.search.predicate.dsl.BooleanPredicateOptionsCollector

hasClause

Methods inherited from interface org.hibernate.search.engine.search.predicate.dsl.PredicateFinalStep

toPredicate

Methods inherited from interface org.hibernate.search.engine.search.predicate.dsl.PredicateScoreStep

boost, constantScore

Method Details

with

S with(Consumer<? super C> contributor)

Description copied from interface: BooleanPredicateOptionsCollector

Delegates setting clauses and options to a given consumer.

Best used with lambda expressions.

Specified by:

with in interface BooleanPredicateOptionsCollector<SR,S extends C>

Parameters:

contributor - A consumer that will add clauses and options to the collector that it consumes. Should generally be a lambda expression.

Returns:

this, for method chaining.

must

S must(SearchPredicate searchPredicate)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "must" clause based on a previously-built SearchPredicate.

Specified by:

must in interface BooleanPredicateOptionsCollector<SR,S extends C>

Parameters:

searchPredicate - The predicate that must match.

Returns:

this, for method chaining.

mustNot

S mustNot(SearchPredicate searchPredicate)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "must not" clause based on a previously-built SearchPredicate.

Specified by:

mustNot in interface BooleanPredicateOptionsCollector<SR,S extends C>

Parameters:

searchPredicate - The predicate that must not match.

Returns:

this, for method chaining.

should

S should(SearchPredicate searchPredicate)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "should" clause based on a previously-built SearchPredicate.

Specified by:

should in interface BooleanPredicateOptionsCollector<SR,S extends C>

Parameters:

searchPredicate - The predicate that should match.

Returns:

this, for method chaining.

filter

S filter(SearchPredicate searchPredicate)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "filter" clause based on a previously-built SearchPredicate.

Specified by:

filter in interface BooleanPredicateOptionsCollector<SR,S extends C>

Parameters:

searchPredicate - The predicate that must match.

Returns:

this, for method chaining.

must

default S must(PredicateFinalStep dslFinalStep)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "must" clause based on an almost-built SearchPredicate.

Specified by:

must in interface BooleanPredicateOptionsCollector<SR,S extends C>

Parameters:

dslFinalStep - A final step in the predicate DSL allowing the retrieval of a SearchPredicate.

Returns:

this, for method chaining.

mustNot

default S mustNot(PredicateFinalStep dslFinalStep)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "must not" clause based on an almost-built SearchPredicate.

Specified by:

mustNot in interface BooleanPredicateOptionsCollector<SR,S extends C>

Parameters:

dslFinalStep - A final step in the predicate DSL allowing the retrieval of a SearchPredicate.

Returns:

this, for method chaining.

should

default S should(PredicateFinalStep dslFinalStep)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "should" clause based on an almost-built SearchPredicate.

Specified by:

should in interface BooleanPredicateOptionsCollector<SR,S extends C>

Parameters:

dslFinalStep - A final step in the predicate DSL allowing the retrieval of a SearchPredicate.

Returns:

this, for method chaining.

filter

default S filter(PredicateFinalStep dslFinalStep)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "filter" clause based on an almost-built SearchPredicate.

Specified by:

filter in interface BooleanPredicateOptionsCollector<SR,S extends C>

Parameters:

dslFinalStep - A final step in the predicate DSL allowing the retrieval of a SearchPredicate.

Returns:

this, for method chaining.

must

S must(Function<? super TypedSearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "must" clause to be defined by the given function.

Best used with lambda expressions.

Specified by:

must in interface BooleanPredicateOptionsCollector<SR,S extends C>

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.

mustNot

S mustNot(Function<? super TypedSearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "must not" clause to be defined by the given function.

Best used with lambda expressions.

Specified by:

mustNot in interface BooleanPredicateOptionsCollector<SR,S extends C>

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.

should

S should(Function<? super TypedSearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "should" clause to be defined by the given function.

Best used with lambda expressions.

Specified by:

should in interface BooleanPredicateOptionsCollector<SR,S extends C>

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

S filter(Function<? super TypedSearchPredicateFactory<SR>,? extends PredicateFinalStep> clauseContributor)

Description copied from interface: BooleanPredicateOptionsCollector

Add a "filter" clause to be defined by the given function.

Best used with lambda expressions.

Specified by:

filter in interface BooleanPredicateOptionsCollector<SR,S extends C>

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.

minimumShouldMatchNumber

default S minimumShouldMatchNumber(int matchingClausesNumber)

Description copied from interface: CommonMinimumShouldMatchOptionsStep

Add a default "minimumShouldMatch" constraint.

Specified by:

minimumShouldMatchNumber in interface CommonMinimumShouldMatchOptionsStep<SR>

Parameters:

matchingClausesNumber - A definition of the number of "should" clauses that have to match. If positive, it is the number of clauses that have to match. See Definition of the minimum for details and possible values, in particular negative values.

Returns:

this, for method chaining.

minimumShouldMatchPercent

default S minimumShouldMatchPercent(int matchingClausesPercent)

Description copied from interface: CommonMinimumShouldMatchOptionsStep

Add a default "minimumShouldMatch" constraint.

Specified by:

minimumShouldMatchPercent in interface CommonMinimumShouldMatchOptionsStep<SR>

Parameters:

matchingClausesPercent - A definition of the number of "should" clauses that have to match, as a percentage. If positive, it is the percentage of the total number of "should" clauses that have to match. See Definition of the minimum for details and possible values, in particular negative values.

Returns:

this, for method chaining.

minimumShouldMatch

MinimumShouldMatchConditionStep<S> minimumShouldMatch()

Specified by:

minimumShouldMatch in interface CommonMinimumShouldMatchOptionsStep<SR>

minimumShouldMatch

S minimumShouldMatch(Consumer<? super MinimumShouldMatchConditionStep<?>> constraintContributor)

Description copied from interface: CommonMinimumShouldMatchOptionsStep

Start defining the minimum number of "should" constraints that have to match in order for the boolean predicate to match.

See MinimumShouldMatchConditionStep.

Specified by:

minimumShouldMatch in interface CommonMinimumShouldMatchOptionsStep<SR>

Returns:

A MinimumShouldMatchConditionStep where constraints can be defined.