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 Detail

      • 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 ValueConvert.YES 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 ValueConvert.YES for more information.
        Returns:
        The next step.

      • matchingAny

        N matchingAny​(Collection<?> terms,
              ValueConvert convert)
        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.

      • 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 ValueConvert.YES 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 ValueConvert.YES for more information.
        Returns:
        The next step.

      • matchingAll

        N matchingAll​(Collection<?> terms,
              ValueConvert convert)
        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.