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

Interface SpatialWithinPredicateFieldStep<N extends SpatialWithinPredicateFieldMoreStep<?,?>>

Type Parameters:

N - The type of the next step.

public interface SpatialWithinPredicateFieldStep<N extends SpatialWithinPredicateFieldMoreStep<?,?>>

The initial step in a "within" predicate definition, where the target field can be set.

Method Summary

Modifier and Type	Method and Description
default N	field(String absoluteFieldPath) Target the given field in the "within" predicate.
N	fields(String... absoluteFieldPaths) Target the given fields in the "within" predicate.

Method Detail

field

default N field(String absoluteFieldPath)

Target the given field in the "within" predicate.

Multiple fields may be targeted by the same predicate: the predicate will match if any targeted field matches.

Parameters:

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

Returns:

The next step.

fields

N fields(String... absoluteFieldPaths)

Target the given fields in the "within" predicate.

Equivalent to field(String) followed by multiple calls to RangePredicateFieldMoreStep.field(String), the only difference being that calls to MultiFieldPredicateFieldBoostStep.boost(float) and other field-specific settings on the returned step will only need to be done once and will apply to all the fields passed to this method.

Parameters:

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

Returns:

The next step.

See Also:

field(String)