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

Interface RangePredicateMatchingStep<N extends RangePredicateOptionsStep<?>>

  • Type Parameters:
    N - The type of the next step.
    All Known Subinterfaces:
    RangePredicateFieldMoreStep<S,​N>
    public interface RangePredicateMatchingStep<N extends RangePredicateOptionsStep<?>>
    The step in a "range" predicate definition where the range to match can be set.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default N atLeast​(Object lowerBoundValue)
      Require at least one of the targeted fields to be "greater than or equal to" the given value, with no limit as to how high it can be.
      default N atLeast​(Object lowerBoundValue, ValueConvert convert)
      Require at least one of the targeted fields to be "greater than or equal to" the given value, with no limit as to how high it can be.
      default N atMost​(Object upperBoundValue)
      Require at least one of the targeted fields to be "lesser than or equal to" the given value, with no limit as to how low it can be.
      default N atMost​(Object upperBoundValue, ValueConvert convert)
      Require at least one of the targeted fields to be "lesser than or equal to" the given value, with no limit as to how low it can be.
      default N between​(Object lowerBound, Object upperBound)
      Require at least one of the targeted fields to be in the range defined by the given bounds.
      default N between​(Object lowerBound, Object upperBound, ValueConvert convert)
      Require at least one of the targeted fields to be in the range defined by the given bounds.
      default N between​(Object lowerBound, RangeBoundInclusion lowerBoundInclusion, Object upperBound, RangeBoundInclusion upperBoundInclusion)
      Require at least one of the targeted fields to be in the range defined by the given bounds.
      default N greaterThan​(Object lowerBoundValue)
      Require at least one of the targeted fields to be "strictly greater than" the given value, with no limit as to how high it can be.
      default N greaterThan​(Object lowerBoundValue, ValueConvert convert)
      Require at least one of the targeted fields to be "strictly greater than" the given value, with no limit as to how high it can be.
      default N lessThan​(Object upperBoundValue)
      Require at least one of the targeted fields to be "lesser than" the given value, with no limit as to how low it can be.
      default N lessThan​(Object upperBoundValue, ValueConvert convert)
      Require at least one of the targeted fields to be "lesser than" the given value, with no limit as to how low it can be.
      default N range​(Range<?> range)
      Require at least one of the targeted fields to be in the given range.
      N range​(Range<?> range, ValueConvert convert)
      Require at least one of the targeted fields to be in the given range.

    • Method Detail

      • between

        default N between​(Object lowerBound,
                  Object upperBound)
        Require at least one of the targeted fields to be in the range defined by the given bounds.
        Parameters:
        lowerBound - The lower bound of the range. null means -Infinity (no lower bound). 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.
        upperBound - The upper bound of the range. null means +Infinity (no upper bound). 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.

      • between

        default N between​(Object lowerBound,
                  Object upperBound,
                  ValueConvert convert)
        Require at least one of the targeted fields to be in the range defined by the given bounds.
        Parameters:
        lowerBound - The lower bound of the range. null means -Infinity (no lower bound). 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 convert parameter. See ValueConvert for more information.
        upperBound - The upper bound of the range. null means +Infinity (no upper bound). 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 convert parameter. See ValueConvert for more information.
        convert - Controls how lowerBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueConvert for more information.
        Returns:
        The next step.

      • between

        default N between​(Object lowerBound,
                  RangeBoundInclusion lowerBoundInclusion,
                  Object upperBound,
                  RangeBoundInclusion upperBoundInclusion)
        Require at least one of the targeted fields to be in the range defined by the given bounds.
        Parameters:
        lowerBound - The lower bound of the range. null means -Infinity (no lower bound). 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.
        lowerBoundInclusion - Whether the lower bound is included in the range or excluded.
        upperBound - The upper bound of the range. null means +Infinity (no upper bound). 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.
        upperBoundInclusion - Whether the upper bound is included in the range or excluded.
        Returns:
        The next step.

      • atLeast

        default N atLeast​(Object lowerBoundValue)
        Require at least one of the targeted fields to be "greater than or equal to" the given value, with no limit as to how high it can be.
        Parameters:
        lowerBoundValue - The lower bound of the range, included. Must not be null. 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.

      • atLeast

        default N atLeast​(Object lowerBoundValue,
                  ValueConvert convert)
        Require at least one of the targeted fields to be "greater than or equal to" the given value, with no limit as to how high it can be.
        Parameters:
        lowerBoundValue - The lower bound of the range, included. Must not be null. 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 convert parameter. See ValueConvert for more information.
        convert - Controls how lowerBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueConvert for more information.
        Returns:
        The next step.

      • greaterThan

        default N greaterThan​(Object lowerBoundValue)
        Require at least one of the targeted fields to be "strictly greater than" the given value, with no limit as to how high it can be.
        Parameters:
        lowerBoundValue - The lower bound of the range, excluded. Must not be null. 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.

      • greaterThan

        default N greaterThan​(Object lowerBoundValue,
                      ValueConvert convert)
        Require at least one of the targeted fields to be "strictly greater than" the given value, with no limit as to how high it can be.
        Parameters:
        lowerBoundValue - The lower bound of the range, excluded. Must not be null. 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 convert parameter. See ValueConvert for more information.
        convert - Controls how lowerBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueConvert for more information.
        Returns:
        The next step.

      • atMost

        default N atMost​(Object upperBoundValue)
        Require at least one of the targeted fields to be "lesser than or equal to" the given value, with no limit as to how low it can be.
        Parameters:
        upperBoundValue - The upper bound of the range, included. Must not be null. 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.

      • atMost

        default N atMost​(Object upperBoundValue,
                 ValueConvert convert)
        Require at least one of the targeted fields to be "lesser than or equal to" the given value, with no limit as to how low it can be.
        Parameters:
        upperBoundValue - The upper bound of the range, included. Must not be null. 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 convert parameter. See ValueConvert for more information.
        convert - Controls how upperBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueConvert for more information.
        Returns:
        The next step.

      • lessThan

        default N lessThan​(Object upperBoundValue)
        Require at least one of the targeted fields to be "lesser than" the given value, with no limit as to how low it can be.
        Parameters:
        upperBoundValue - The upper bound of the range, excluded. Must not be null. 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.

      • lessThan

        default N lessThan​(Object upperBoundValue,
                   ValueConvert convert)
        Require at least one of the targeted fields to be "lesser than" the given value, with no limit as to how low it can be.
        Parameters:
        upperBoundValue - The upper bound of the range, excluded. Must not be null. 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 convert parameter. See ValueConvert for more information.
        convert - Controls how upperBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueConvert for more information.
        Returns:
        The next step.

      • range

        default N range​(Range<?> range)
        Require at least one of the targeted fields to be in the given range.
        Parameters:
        range - The range to match. The signature of this method defines this parameter as a range with bounds of any type, but a specific type is expected depending on the targeted field. See ValueConvert.YES for more information.
        Returns:
        The next step.

      • range

        N range​(Range<?> range,
        ValueConvert convert)
        Require at least one of the targeted fields to be in the given range.
        Parameters:
        range - The range to match. The signature of this method defines this parameter as a range with bounds of any type, 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 range bounds should be converted before Hibernate Search attempts to interpret them as a field value. See ValueConvert for more information.
        Returns:
        The next step.