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

Class BooleanPredicateClausesStepImpl

java.lang.Object

org.hibernate.search.engine.search.predicate.dsl.spi.AbstractPredicateFinalStep

org.hibernate.search.engine.search.predicate.dsl.impl.BooleanPredicateClausesStepImpl

All Implemented Interfaces:

BooleanPredicateClausesStep<BooleanPredicateClausesStepImpl>, BooleanPredicateOptionsCollector<BooleanPredicateOptionsCollector<?>>, CommonMinimumShouldMatchOptionsStep<BooleanPredicateOptionsCollector<?>>, GenericBooleanPredicateClausesStep<BooleanPredicateClausesStepImpl,BooleanPredicateOptionsCollector<?>>, PredicateFinalStep, PredicateScoreStep<BooleanPredicateClausesStepImpl>

public final class BooleanPredicateClausesStepImpl
extends AbstractPredicateFinalStep
implements BooleanPredicateClausesStep<BooleanPredicateClausesStepImpl>

Field Summary

Fields inherited from class org.hibernate.search.engine.search.predicate.dsl.spi.AbstractPredicateFinalStep

dslContext

Constructor Summary

Constructors

Constructor	Description
BooleanPredicateClausesStepImpl(SearchPredicateDslContext<?> dslContext, SearchPredicateFactory factory)

Method Summary

Modifier and Type	Method	Description
BooleanPredicateClausesStepImpl	boost(float boost)	Boost the weight of the predicate in score computation.
protected SearchPredicate	build()
BooleanPredicateClausesStepImpl	constantScore()	Force the score of the predicate to a single constant, identical for all documents.
BooleanPredicateClausesStepImpl	filter(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)	Add a "filter" clause to be defined by the given function.
BooleanPredicateClausesStepImpl	filter(SearchPredicate searchPredicate)	Add a "filter" clause based on a previously-built SearchPredicate.
boolean	hasClause()	Checks if this predicate contains at least one clause.
MinimumShouldMatchConditionStep<BooleanPredicateClausesStepImpl>	minimumShouldMatch()
BooleanPredicateClausesStepImpl	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.
BooleanPredicateClausesStepImpl	must(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)	Add a "must" clause to be defined by the given function.
BooleanPredicateClausesStepImpl	must(SearchPredicate searchPredicate)	Add a "must" clause based on a previously-built SearchPredicate.
BooleanPredicateClausesStepImpl	mustNot(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)	Add a "must not" clause to be defined by the given function.
BooleanPredicateClausesStepImpl	mustNot(SearchPredicate searchPredicate)	Add a "must not" clause based on a previously-built SearchPredicate.
protected BooleanPredicateClausesStepImpl	self()
BooleanPredicateClausesStepImpl	should(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)	Add a "should" clause to be defined by the given function.
BooleanPredicateClausesStepImpl	should(SearchPredicate searchPredicate)	Add a "should" clause based on a previously-built SearchPredicate.
BooleanPredicateClausesStepImpl	with(Consumer<? super BooleanPredicateOptionsCollector<?>> contributor)	Delegates setting clauses and options to a given consumer.

Methods inherited from class org.hibernate.search.engine.search.predicate.dsl.spi.AbstractPredicateFinalStep

toPredicate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

hasClause

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

filter, filter, filter, minimumShouldMatch, minimumShouldMatch, minimumShouldMatchNumber, minimumShouldMatchPercent, must, must, must, mustNot, mustNot, mustNot, should, should, should, with

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

Constructor Details

BooleanPredicateClausesStepImpl

public BooleanPredicateClausesStepImpl(SearchPredicateDslContext<?> dslContext,
 SearchPredicateFactory factory)

Method Details

self

protected BooleanPredicateClausesStepImpl self()

boost

public BooleanPredicateClausesStepImpl boost(float boost)

Description copied from interface: PredicateScoreStep

Boost the weight of the predicate in score computation.

Specified by:

boost in interface PredicateScoreStep<S extends C>

Parameters:

boost - The boost factor. Higher than 1 increases the weight in score computation, between 0 and 1 lowers the weight. Lower than 0 is for experts only.

Returns:

this, for method chaining.

constantScore

public BooleanPredicateClausesStepImpl constantScore()

Description copied from interface: PredicateScoreStep

Force the score of the predicate to a single constant, identical for all documents.

By default, the score will be 1.0f, but boosts, if any, will still be applied to the predicate.

Specified by:

constantScore in interface PredicateScoreStep<S extends C>

Returns:

this, for method chaining.

with

public BooleanPredicateClausesStepImpl with(Consumer<? super BooleanPredicateOptionsCollector<?>> 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<S extends C>

Specified by:

with in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

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

public BooleanPredicateClausesStepImpl must(SearchPredicate searchPredicate)

Description copied from interface: BooleanPredicateOptionsCollector

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

Specified by:

must in interface BooleanPredicateOptionsCollector<S extends C>

Specified by:

must in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

Parameters:

searchPredicate - The predicate that must match.

Returns:

this, for method chaining.

mustNot

public BooleanPredicateClausesStepImpl 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<S extends C>

Specified by:

mustNot in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

Parameters:

searchPredicate - The predicate that must not match.

Returns:

this, for method chaining.

should

public BooleanPredicateClausesStepImpl should(SearchPredicate searchPredicate)

Description copied from interface: BooleanPredicateOptionsCollector

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

Specified by:

should in interface BooleanPredicateOptionsCollector<S extends C>

Specified by:

should in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

Parameters:

searchPredicate - The predicate that should match.

Returns:

this, for method chaining.

filter

public BooleanPredicateClausesStepImpl filter(SearchPredicate searchPredicate)

Description copied from interface: BooleanPredicateOptionsCollector

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

Specified by:

filter in interface BooleanPredicateOptionsCollector<S extends C>

Specified by:

filter in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

Parameters:

searchPredicate - The predicate that must match.

Returns:

this, for method chaining.

must

public BooleanPredicateClausesStepImpl must(Function<? super SearchPredicateFactory,? 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<S extends C>

Specified by:

must in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

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

public BooleanPredicateClausesStepImpl mustNot(Function<? super SearchPredicateFactory,? 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<S extends C>

Specified by:

mustNot in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

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

public BooleanPredicateClausesStepImpl should(Function<? super SearchPredicateFactory,? 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<S extends C>

Specified by:

should in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

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

public BooleanPredicateClausesStepImpl filter(Function<? super SearchPredicateFactory,? 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<S extends C>

Specified by:

filter in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

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.

minimumShouldMatch

public MinimumShouldMatchConditionStep<BooleanPredicateClausesStepImpl> minimumShouldMatch()

Specified by:

minimumShouldMatch in interface CommonMinimumShouldMatchOptionsStep<S extends C>

Specified by:

minimumShouldMatch in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

minimumShouldMatch

public BooleanPredicateClausesStepImpl 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<S extends C>

Specified by:

minimumShouldMatch in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>

Returns:

A MinimumShouldMatchConditionStep where constraints can be defined.

build

protected SearchPredicate build()

Specified by:

build in class AbstractPredicateFinalStep

hasClause

public boolean hasClause()

Description copied from interface: BooleanPredicateOptionsCollector

Checks if this predicate contains at least one clause.

Specified by:

hasClause in interface BooleanPredicateOptionsCollector<S extends C>

Returns:

true if any clauses were added, i.e. any of the must(..)/should(..)/mustNot(..)/filter(..) were called at least once, false otherwise.