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

Interface TermsPredicateMatchingStep<N extends TermsPredicateOptionsStep<?>>

Type Parameters:
N - The type of the next step.
All Known Subinterfaces:
TermsPredicateFieldMoreStep<S,N>
public interface TermsPredicateMatchingStep<N extends TermsPredicateOptionsStep<?>>
The step in a "terms" predicate definition where the terms to match can be set.

  • Method Details

    • matchingAny

      default N matchingAny(Object firstTerm, Object... otherTerms)
      Require at least one of the targeted fields to match any of the provided terms.
      Parameters:
      firstTerm - The (first) term to match.
      otherTerms - The others (optional) terms to match. The signature of this method defines these parameter as a Object, but a specific type is expected depending on the targeted field. See ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • matchingAny

      default N matchingAny(Collection<?> terms)
      Require at least one of the targeted fields to match any of the provided terms.
      Parameters:
      terms - The terms to match. The signature of this method defines this parameter as a Collection of any Object, but a specific type is expected depending on the targeted field. See ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • matchingAny

      @Deprecated default N matchingAny(Collection<?> terms, ValueConvert convert)
      Deprecated.
      Use matchingAny(Collection, ValueModel) instead.
      Require at least one of the targeted fields to match any of the provided terms.
      Parameters:
      terms - The terms to match. The signature of this method defines this parameter as a Collection of any Object, but a specific type is expected depending on the targeted field and on the convert parameter. See ValueConvert for more information.
      convert - Controls how the value should be converted before Hibernate Search attempts to interpret it as a field value. See ValueConvert for more information.
      Returns:
      The next step.

    • matchingAny

      N matchingAny(Collection<?> terms, ValueModel valueModel)
      Require at least one of the targeted fields to match any of the provided terms.
      Parameters:
      terms - The terms to match. The signature of this method defines this parameter as a Collection of any Object, but a specific type is expected depending on the targeted field and on the valueModel parameter. See ValueModel for more information.
      valueModel - The model value, determines how the value should be converted before Hibernate Search attempts to interpret it as a field value. See ValueModel for more information.
      Returns:
      The next step.

    • matchingAll

      default N matchingAll(Object firstTerm, Object... otherTerms)
      Require at least one of the targeted fields to match all of the provided terms.
      Parameters:
      firstTerm - The (first) term to match.
      otherTerms - The others (optional) terms to match. The signature of this method defines these parameter as a Object, but a specific type is expected depending on the targeted field. See ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • matchingAll

      default N matchingAll(Collection<?> terms)
      Require at least one of the targeted fields to match all of the provided terms.
      Parameters:
      terms - The terms to match. The signature of this method defines this parameter as a Collection of any Object, but a specific type is expected depending on the targeted field. See ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • matchingAll

      @Deprecated default N matchingAll(Collection<?> terms, ValueConvert convert)
      Deprecated.
      Use matchingAll(Collection, ValueModel) instead.
      Require at least one of the targeted fields to match all of the provided terms.
      Parameters:
      terms - The terms to match. The signature of this method defines this parameter as a Collection of any Object, but a specific type is expected depending on the targeted field and on the convert parameter. See ValueConvert for more information.
      convert - Controls how the value should be converted before Hibernate Search attempts to interpret it as a field value. See ValueConvert for more information.
      Returns:
      The next step.

    • matchingAll

      N matchingAll(Collection<?> terms, ValueModel valueModel)
      Require at least one of the targeted fields to match all of the provided terms.
      Parameters:
      terms - The terms to match. The signature of this method defines this parameter as a Collection of any Object, but a specific type is expected depending on the targeted field and on the valueModel parameter. See ValueModel for more information.
      valueModel - The model of term values, determines how the terms should be converted before Hibernate Search attempts to interpret them as field values. See ValueModel for more information.
      Returns:
      The next step.