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

Interface RangePredicateMatchingStep<N extends RangePredicateOptionsStep<?>>

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

  • Method Summary

    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)
    Deprecated.
    Use atLeast(Object, ValueModel) instead.
    default N
    atLeast(Object lowerBoundValue, ValueModel valueModel)
    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)
    Deprecated.
    Use atMost(Object, ValueModel) instead.
    default N
    atMost(Object upperBoundValue, ValueModel valueModel)
    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 lowerBoundValue, Object upperBoundValue, ValueConvert convert)
    Deprecated.
    Use between(Object, Object, ValueModel) instead.
    default N
    between(Object lowerBoundValue, Object upperBoundValue, ValueModel valueModel)
    Require at least one of the targeted fields to be in the range defined by the given bounds.
    default N
    between(Object lowerBound, org.hibernate.search.util.common.data.RangeBoundInclusion lowerBoundInclusion, Object upperBound, org.hibernate.search.util.common.data.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)
    Deprecated.
    Use greaterThan(Object, ValueModel) instead.
    default N
    greaterThan(Object lowerBoundValue, ValueModel valueModel)
    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)
    Deprecated.
    default N
    lessThan(Object upperBoundValue, ValueModel valueModel)
    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(org.hibernate.search.util.common.data.Range<?> range)
    Deprecated.
    Use within(Range) instead.
    default N
    range(org.hibernate.search.util.common.data.Range<?> range, ValueConvert convert)
    Deprecated.
    Use within(Range, org.hibernate.search.engine.search.common.ValueConvert) instead.
    default N
    within(org.hibernate.search.util.common.data.Range<?> range)
    Require at least one of the targeted fields to be in the given range.
    default N
    within(org.hibernate.search.util.common.data.Range<?> range, ValueConvert convert)
    Deprecated.
    Use within(Range, ValueModel) instead.
    N
    within(org.hibernate.search.util.common.data.Range<?> range, ValueModel valueModel)
    Require at least one of the targeted fields to be in the given range.
    default N
    withinAny(Collection<? extends org.hibernate.search.util.common.data.Range<?>> ranges)
    Require at least one of the targeted fields to be in any of the given ranges.
    default N
    withinAny(Collection<? extends org.hibernate.search.util.common.data.Range<?>> ranges, ValueConvert convert)
    Deprecated.
    Use withinAny(Collection, ValueModel) instead.
    N
    withinAny(Collection<? extends org.hibernate.search.util.common.data.Range<?>> ranges, ValueModel valueModel)
    Require at least one of the targeted fields to be in any of the given ranges.
    default N
    withinAny(org.hibernate.search.util.common.data.Range<?>... ranges)
    Require at least one of the targeted fields to be in any of the given ranges.

  • Method Details

    • 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.
      Specified by:
      between in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      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 ValueModel.MAPPING 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 ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • between

      @Deprecated(since="7.2") default N between(Object lowerBoundValue, Object upperBoundValue, ValueConvert convert)
      Deprecated.
      Use between(Object, Object, ValueModel) instead.
      Require at least one of the targeted fields to be in the range defined by the given bounds.
      Parameters:
      lowerBoundValue - 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.
      upperBoundValue - 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 the lowerBoundValue/upperBoundValue 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 lowerBoundValue, Object upperBoundValue, ValueModel valueModel)
      Require at least one of the targeted fields to be in the range defined by the given bounds.
      Parameters:
      lowerBoundValue - 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 valueModel parameter. See ValueModel for more information.
      upperBoundValue - 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 valueModel parameter. See ValueModel for more information.
      valueModel - The model value, determines how the lowerBoundValue/upperBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueModel for more information.
      Returns:
      The next step.

    • between

      default N between(Object lowerBound, org.hibernate.search.util.common.data.RangeBoundInclusion lowerBoundInclusion, Object upperBound, org.hibernate.search.util.common.data.RangeBoundInclusion upperBoundInclusion)
      Require at least one of the targeted fields to be in the range defined by the given bounds.
      Specified by:
      between in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      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 ValueModel.MAPPING 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 ValueModel.MAPPING 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.
      Specified by:
      atLeast in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      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 ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • atLeast

      @Deprecated(since="7.2") default N atLeast(Object lowerBoundValue, ValueConvert convert)
      Deprecated.
      Use atLeast(Object, ValueModel) instead.
      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.

    • atLeast

      default N atLeast(Object lowerBoundValue, ValueModel valueModel)
      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 valueModel parameter. See ValueModel for more information.
      valueModel - The model value, determines how the lowerBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueModel 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.
      Specified by:
      greaterThan in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      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 ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • greaterThan

      @Deprecated(since="7.2") default N greaterThan(Object lowerBoundValue, ValueConvert convert)
      Deprecated.
      Use greaterThan(Object, ValueModel) instead.
      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.

    • greaterThan

      default N greaterThan(Object lowerBoundValue, ValueModel valueModel)
      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 valueModel parameter. See ValueModel for more information.
      valueModel - The model value, determines how the lowerBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueModel 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.
      Specified by:
      atMost in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      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 ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • atMost

      @Deprecated(since="7.2") default N atMost(Object upperBoundValue, ValueConvert convert)
      Deprecated.
      Use atMost(Object, ValueModel) instead.
      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.

    • atMost

      default N atMost(Object upperBoundValue, ValueModel valueModel)
      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 valueModel parameter. See ValueModel for more information.
      valueModel - The model value, determines how the upperBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueModel 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.
      Specified by:
      lessThan in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      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 ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • lessThan

      @Deprecated(since="7.2") default N lessThan(Object upperBoundValue, ValueConvert convert)
      Deprecated.
      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.

    • lessThan

      default N lessThan(Object upperBoundValue, ValueModel valueModel)
      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 valueModel parameter. See ValueModel for more information.
      valueModel - The model value, determines how the upperBoundValue should be converted before Hibernate Search attempts to interpret it as a field value. See ValueModel for more information.
      Returns:
      The next step.

    • range

      @Deprecated(since="7.2") default N range(org.hibernate.search.util.common.data.Range<?> range)
      Deprecated.
      Use within(Range) instead.
      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 ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • range

      @Deprecated(since="7.2") default N range(org.hibernate.search.util.common.data.Range<?> range, ValueConvert convert)
      Deprecated.
      Use within(Range, org.hibernate.search.engine.search.common.ValueConvert) instead.
      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.

    • within

      default N within(org.hibernate.search.util.common.data.Range<?> range)
      Require at least one of the targeted fields to be in the given range.
      Specified by:
      within in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      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 ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • within

      @Deprecated(since="7.2") default N within(org.hibernate.search.util.common.data.Range<?> range, ValueConvert convert)
      Deprecated.
      Use within(Range, ValueModel) instead.
      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.

    • within

      N within(org.hibernate.search.util.common.data.Range<?> range, ValueModel valueModel)
      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 ValueModel for more information.
      valueModel - The model value, determines how the range bounds should be converted before Hibernate Search attempts to interpret them as a field value. See ValueModel for more information.
      Returns:
      The next step.

    • withinAny

      default N withinAny(org.hibernate.search.util.common.data.Range<?>... ranges)
      Require at least one of the targeted fields to be in any of the given ranges.
      Specified by:
      withinAny in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      Parameters:
      ranges - The ranges 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 ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • withinAny

      default N withinAny(Collection<? extends org.hibernate.search.util.common.data.Range<?>> ranges)
      Require at least one of the targeted fields to be in any of the given ranges.
      Specified by:
      withinAny in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      Parameters:
      ranges - The ranges 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 ValueModel.MAPPING for more information.
      Returns:
      The next step.

    • withinAny

      @Deprecated(since="7.2") default N withinAny(Collection<? extends org.hibernate.search.util.common.data.Range<?>> ranges, ValueConvert convert)
      Deprecated.
      Use withinAny(Collection, ValueModel) instead.
      Require at least one of the targeted fields to be in any of the given ranges.
      Parameters:
      ranges - The ranges 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.

    • withinAny

      N withinAny(Collection<? extends org.hibernate.search.util.common.data.Range<?>> ranges, ValueModel valueModel)
      Require at least one of the targeted fields to be in any of the given ranges.
      Specified by:
      withinAny in interface RangePredicateMatchingGenericStep<Object,N extends RangePredicateOptionsStep<?>>
      Parameters:
      ranges - The ranges 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 valueModel parameter. See ValueModel for more information.
      valueModel - The model value, determines how the range bounds should be converted before Hibernate Search attempts to interpret them as a field value. See ValueModel for more information.
      Returns:
      The next step.