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

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

Type Parameters:
N - The type of the next step.
public interface SpatialWithinPredicateFieldStep<SR,N extends SpatialWithinPredicateFieldMoreStep<SR,?,?>>
The initial step in a "within" predicate definition, where the target field can be set.

  • Method Summary

    Modifier and Type
    Method
    Description
    default N
    field(String fieldPath)
    Target the given field in the "within" predicate.
    default N
    field(SpatialPredicateFieldReference<? super SR> fieldReference)
    Target the given field in the "within" predicate.
    N
    fields(String... fieldPaths)
    Target the given fields in the "within" predicate.
    N
    fields(SpatialPredicateFieldReference<? super SR>... fieldReferences)
    Target the given fields in the "within" predicate.

  • Method Details

    • field

      default N field(String fieldPath)
      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:
      fieldPath - The path to the index field to apply the predicate on.
      Returns:
      The next step.

    • fields

      N fields(String... fieldPaths)
      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:
      fieldPaths - The paths to the index fields to apply the predicate on.
      Returns:
      The next step.
      See Also:

    • field

      default N field(SpatialPredicateFieldReference<? super SR> fieldReference)
      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:
      fieldReference - The field reference representing a definition of the index field to apply the predicate on.
      Returns:
      The next step.

    • fields

      N fields(SpatialPredicateFieldReference<? super SR>... fieldReferences)
      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:
      fieldReferences - The field references representing paths to the index fields to apply the predicate on.
      Returns:
      The next step.
      See Also: