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

Interface CommonQueryStringPredicateOptionsStep<S extends CommonQueryStringPredicateOptionsStep<?>>

Type Parameters:
S - The "self" type (the actual exposed type of this step).
All Superinterfaces:
PredicateFinalStep, PredicateScoreStep<S>
All Known Subinterfaces:
QueryStringPredicateOptionsStep<S>, SimpleQueryStringPredicateOptionsStep<S>
public interface CommonQueryStringPredicateOptionsStep<S extends CommonQueryStringPredicateOptionsStep<?>> extends PredicateFinalStep, PredicateScoreStep<S>
The final step in a query string predicate definition, where optional parameters can be set.

  • Method Details

    • defaultOperator

      S defaultOperator(BooleanOperator operator)
      Define the default operator.

      By default, unless the query string contains explicit operators, documents will match if any term mentioned in the query string is present in the document (OR operator). This can be used to change the default behavior to AND, making document match if all terms mentioned in the query string are present in the document.

      Parameters:
      operator - The default operator (OR or AND).
      Returns:
      this, for method chaining.

    • analyzer

      S analyzer(String analyzerName)
      Define an analyzer to use at query time to interpret the value to match.

      If this method is not called, the analyzer defined on the field will be used.

      Parameters:
      analyzerName - The name of the analyzer to use in the query for this predicate.
      Returns:
      this, for method chaining.

    • skipAnalysis

      S skipAnalysis()
      Any analyzer or normalizer defined on any field will be ignored to interpret the value to match.
      Returns:
      this, for method chaining.

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