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

Interface CommonMinimumShouldMatchOptionsStep<S extends CommonMinimumShouldMatchOptionsStep<?>>

Type Parameters:
S - The "self" type (the actual exposed type of this step).
All Known Subinterfaces:
BooleanPredicateClausesStep<S>, BooleanPredicateOptionsCollector<S>, CommonQueryStringPredicateOptionsStep<S>, GenericBooleanPredicateClausesStep<S,C>, MatchPredicateOptionsStep<S>, QueryStringPredicateOptionsStep<S>, SimpleQueryStringPredicateOptionsStep<S>
public interface CommonMinimumShouldMatchOptionsStep<S extends CommonMinimumShouldMatchOptionsStep<?>>
The step in a predicate definition, where optional minimum should match parameters can be set.

  • Method Details

    • minimumShouldMatchNumber

      default S minimumShouldMatchNumber(int matchingClausesNumber)
      Add a default "minimumShouldMatch" constraint.
      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)
      Add a default "minimumShouldMatch" constraint.
      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<? extends S> minimumShouldMatch()

    • 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.

      See MinimumShouldMatchConditionStep.

      Returns:
      A MinimumShouldMatchConditionStep where constraints can be defined.