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<?>>, 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`S`	`boost(float boost)`	Boost the weight of the predicate in score computation.
`protected SearchPredicate`	`build()`
`S`	`constantScore()`	Force the score of the predicate to a single constant, identical for all documents.
`S`	`filter(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)`	Add a "filter" clause to be defined by the given function.
`S`	`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<S>`	`minimumShouldMatch()`	Start defining the minimum number of "should" constraints that have to match in order for the boolean predicate to match.
`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.
`S`	`must(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)`	Add a "must" clause to be defined by the given function.
`S`	`must(SearchPredicate searchPredicate)`	Add a "must" clause based on a previously-built `SearchPredicate`.
`S`	`mustNot(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)`	Add a "must not" clause to be defined by the given function.
`S`	`mustNot(SearchPredicate searchPredicate)`	Add a "must not" clause based on a previously-built `SearchPredicate`.
`protected BooleanPredicateClausesStepImpl`	`self()`
`S`	`should(Function<? super SearchPredicateFactory,? extends PredicateFinalStep> clauseContributor)`	Add a "should" clause to be defined by the given function.
`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 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 Detail
  - BooleanPredicateClausesStepImpl
```
public BooleanPredicateClausesStepImpl(SearchPredicateDslContext<?> dslContext,
                                       SearchPredicateFactory factory)
```
- Method Detail
  - self
```
protected BooleanPredicateClausesStepImpl self()
```
  - boost
```
public S 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 S 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 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<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 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<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 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<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 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<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 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<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 S 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 S 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 S 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 S 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<S> minimumShouldMatch()
```
    Description copied from interface: BooleanPredicateOptionsCollector
    
    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 BooleanPredicateOptionsCollector<S extends C>
    
    Specified by:
    
    minimumShouldMatch in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>
    
    Returns:
    
    A MinimumShouldMatchConditionStep where constraints can be defined.
  - minimumShouldMatch
```
public S minimumShouldMatch(Consumer<? super MinimumShouldMatchConditionStep<?>> constraintContributor)
```
    Description copied from interface: BooleanPredicateOptionsCollector
    
    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 BooleanPredicateOptionsCollector<S extends C>
    
    Specified by:
    
    minimumShouldMatch in interface GenericBooleanPredicateClausesStep<S extends C,C extends BooleanPredicateOptionsCollector<?>>
    
    Parameters:
    
    constraintContributor - A consumer that will add constraints to the DSL step passed in parameter. Should generally be a lambda expression.
    
    Returns:
    
    this, for method chaining.
  - 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.

Class BooleanPredicateClausesStepImpl

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

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

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

Constructor Detail

BooleanPredicateClausesStepImpl

Method Detail

self

boost

constantScore

with

must

mustNot

should

filter

must

mustNot

should

filter

minimumShouldMatch

minimumShouldMatch

build

hasClause