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

Interface RangePredicateFieldSetContext

All Superinterfaces:

MultiFieldPredicateFieldSetContext<RangePredicateFieldSetContext>

public interface RangePredicateFieldSetContext
extends MultiFieldPredicateFieldSetContext<RangePredicateFieldSetContext>

The context used when defining a range predicate, after at least one field was mentioned.

Method Summary

Modifier and Type	Method and Description
default RangePredicateLimitTerminalContext	above(Object value) Require at least one of the targeted fields to be "higher than" the given value, with no limit as to how high it can be.
RangePredicateLimitTerminalContext	above(Object value, DslConverter dslConverter) Require at least one of the targeted fields to be "higher than" the given value, with no limit as to how high it can be.
default RangePredicateLimitTerminalContext	below(Object value) Require at least one of the targeted fields to be "lower than" the given value, with no limit as to how low it can be.
RangePredicateLimitTerminalContext	below(Object value, DslConverter dslConverter) Require at least one of the targeted fields to be "lower than" the given value, with no limit as to how low it can be.
default RangePredicateFromContext	from(Object value) Require at least one of the targeted fields to be "higher than" the given value, and "lower than" another value (to be provided in following calls).
RangePredicateFromContext	from(Object value, DslConverter dslConverter) Require at least one of the targeted fields to be "higher than" the given value, and "lower than" another value (to be provided in following calls).
default RangePredicateFieldSetContext	orField(String absoluteFieldPath) Target the given field in the range predicate, as an alternative to the already-targeted fields.
RangePredicateFieldSetContext	orFields(String... absoluteFieldPaths) Target the given fields in the range predicate, as an alternative to the already-targeted fields.

Methods inherited from interface org.hibernate.search.engine.search.dsl.predicate.MultiFieldPredicateFieldSetContext

boostedTo

Method Detail

orField

default RangePredicateFieldSetContext orField(String absoluteFieldPath)

Target the given field in the range predicate, as an alternative to the already-targeted fields.

See RangePredicateContext.onField(String) for more information about targeting fields.

Parameters:

absoluteFieldPath - The absolute path (from the document root) of the targeted field.

Returns:

this, for method chaining.

See Also:

RangePredicateContext.onField(String)

orFields

RangePredicateFieldSetContext orFields(String... absoluteFieldPaths)

Target the given fields in the range predicate, as an alternative to the already-targeted fields.

See RangePredicateContext.onFields(String...) for more information about targeting fields.

Parameters:

absoluteFieldPaths - The absolute paths (from the document root) of the targeted fields.

Returns:

this, for method chaining.

See Also:

RangePredicateContext.onFields(String...)

from

default RangePredicateFromContext from(Object value)

Require at least one of the targeted fields to be "higher than" the given value, and "lower than" another value (to be provided in following calls).

This syntax is essentially used like this: .from( lowerBound ).to( upperBound ).

Parameters:

value - The lower bound of the range. May be null, in which case the range has no lower bound and the upper bound (passed to RangePredicateFromContext.to(Object)) 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 DslConverter.ENABLED for more information. Lower bound is included by default in the range.

Returns:

A context allowing to exclude the lower bound from the range or to set the upper bound of the range.

from

RangePredicateFromContext from(Object value,
                               DslConverter dslConverter)

Require at least one of the targeted fields to be "higher than" the given value, and "lower than" another value (to be provided in following calls).

This syntax is essentially used like this: .from( lowerBound ).to( upperBound ).

Parameters:

value - The lower bound of the range. May be null, in which case the range has no lower bound and the upper bound (passed to RangePredicateFromContext.to(Object)) 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 dslConverter parameter. See DslConverter for more information.

dslConverter - Controls how the value should be converted before Hibernate Search attempts to interpret it as a field value. See DslConverter for more information. Lower bound is included by default in the range.

Returns:

A context allowing to exclude the lower bound from the range or to set the upper bound of the range.

above

default RangePredicateLimitTerminalContext above(Object value)

Require at least one of the targeted fields to be "higher than" the given value, with no limit as to how high it can be.

Parameters:

value - The lower bound of the range. 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 DslConverter.ENABLED for more information. Lower bound is included by default in the range.

Returns:

A context allowing to exclude the lower bound from the range, to set options or to get the resulting predicate.

above

RangePredicateLimitTerminalContext above(Object value,
                                         DslConverter dslConverter)

Require at least one of the targeted fields to be "higher than" the given value, with no limit as to how high it can be.

Parameters:

value - The lower bound of the range. 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 dslConverter parameter. See DslConverter for more information.

dslConverter - Controls how the value should be converted before Hibernate Search attempts to interpret it as a field value. See DslConverter for more information. Lower bound is included by default in the range.

Returns:

A context allowing to exclude the lower bound from the range, to set options or to get the resulting predicate.

below

default RangePredicateLimitTerminalContext below(Object value)

Require at least one of the targeted fields to be "lower than" the given value, with no limit as to how low it can be.

Parameters:

value - The upper bound of the range. 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 DslConverter.ENABLED for more information. Upper bound is included by default in the range.

Returns:

A context allowing to exclude the upper bound from the range, to set options or to get the resulting predicate.

below

RangePredicateLimitTerminalContext below(Object value,
                                         DslConverter dslConverter)

Require at least one of the targeted fields to be "lower than" the given value, with no limit as to how low it can be.

Parameters:

value - The upper bound of the range. 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 dslConverter parameter. See DslConverter for more information.

dslConverter - Controls how the value should be converted before Hibernate Search attempts to interpret it as a field value. See DslConverter for more information. Upper bound is included by default in the range.

Returns:

A context allowing to exclude the upper bound from the range, to set options or to get the resulting predicate.