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

Interface MatchPredicateMatchingStep<N extends MatchPredicateOptionsStep<?>>

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

  • Method Summary

    Modifier and Type
    Method
    Description
    default N
    matching(Object value)
    Require at least one of the targeted fields to match the given value.
    N
    matching(Object value, ValueConvert convert)
    Require at least one of the targeted fields to match the given value.

  • Method Details

    • matching

      default N matching(Object value)
      Require at least one of the targeted fields to match the given value.

      This method will apply DSL converters to value before Hibernate Search attempts to interpret it as a field value. See ValueConvert.YES.

      Parameters:
      value - The value to match. The signature of this method defines this parameter as an Object, but a specific type is expected depending on the targeted field. See ValueConvert.YES for more information.
      Returns:
      The next step.
      See Also:

    • matching

      N matching(Object value, ValueConvert convert)
      Require at least one of the targeted fields to match the given value.
      Parameters:
      value - The value to match. The signature of this method defines this parameter as an Object, but a specific type is expected depending on the targeted field and on the dslConverter 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.
      See Also: