Package org.hibernate.search.engine.search.projection.dsl

Interface DistanceToFieldProjectionValueStep<N extends DistanceToFieldProjectionOptionsStep<?,T>,T>

Type Parameters:
N - The next step if a method other than multi() is called, i.e. the return type of methods defined in FieldProjectionOptionsStep when called directly on this object.
T - The type of projected distances.
All Superinterfaces:
DistanceToFieldProjectionOptionsStep<N,T>, ProjectionFinalStep<T>
public interface DistanceToFieldProjectionValueStep<N extends DistanceToFieldProjectionOptionsStep<?,T>,T> extends DistanceToFieldProjectionOptionsStep<N,T>
The initial step in a "distance to field" projection definition, where the projection (optionally) can be marked as multi-valued (returning Lists), and where optional parameters can be set.

By default (if multi() is not called), the projection is considered single-valued, and its creation will fail if the field is multi-valued.

  • Method Details

    • multi

      DistanceToFieldProjectionOptionsStep<?,List<T>> multi()
      Defines the projection as multi-valued, i.e. returning List<T> instead of T.

      Calling multi() is mandatory for multi-valued fields, otherwise the projection will throw an exception upon creating the query.

      Returns:
      A new step to define optional parameters for the multi-valued projections.