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

Interface RangePredicateToStep

All Known Subinterfaces:

RangePredicateFromToStep

public interface RangePredicateToStep

The step in a "range" predicate definition where the upper limit of the range can be set.

Method Summary

Modifier and Type	Method and Description
default RangePredicateLastLimitExcludeStep	to(Object value) Require at least one of the targeted fields to be "lower than" the given value, in addition to being "higher than" the value provided to the former from call.
RangePredicateLastLimitExcludeStep	to(Object value, ValueConvert convert) Require at least one of the targeted fields to be "lower than" the given value, in addition to being "higher than" the value provided to the former from call.

Method Detail

to

default RangePredicateLastLimitExcludeStep to(Object value)

Require at least one of the targeted fields to be "lower than" the given value, in addition to being "higher than" the value provided to the former from call.

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 upper bound of the range. May be null, in which case the range has no upper bound, but this is only possible if the lower bound (RangePredicateLimitsStep.from(Object)) was not 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. The upper bound is included in the range by default, but can be excluded by calling RangePredicateLimitExcludeStep.excludeLimit() on the next step.

Returns:

The next step.

to

RangePredicateLastLimitExcludeStep to(Object value,
                                      ValueConvert convert)

Require at least one of the targeted fields to be "lower than" the given value, in addition to being "higher than" the value provided to the former from call.

Parameters:

value - The upper bound of the range. May be null, in which case the range has no upper bound, but this is only possible if the lower bound (RangePredicateLimitsStep.from(Object)) was not 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 dslConverter parameter. See ValueConvert for more information. The upper bound is included in the range by default, but can be excluded by calling RangePredicateLimitExcludeStep.excludeLimit() on the next step.

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.