Package org.hibernate.search.engine.search.aggregation.dsl

Interface RangeAggregationFieldStep<SR,PDF extends TypedSearchPredicateFactory<SR>>

Type Parameters:
SR - Scope root type.
PDF - The type of factory used to create predicates in AggregationFilterStep.filter(Function).
public interface RangeAggregationFieldStep<SR,PDF extends TypedSearchPredicateFactory<SR>>
The initial step in a "range" aggregation definition, where the target field can be set.

  • Method Details

    • field

      default <F> RangeAggregationRangeStep<SR,?,PDF,F,Long> field(String fieldPath, Class<F> type)
      Target the given field in the range aggregation.
      Type Parameters:
      F - The type of field values.
      Parameters:
      fieldPath - The path to the index field to aggregate.
      type - The type of field values.
      Returns:
      The next step.

    • field

      @Deprecated(since="7.2") default <F> RangeAggregationRangeStep<SR,?,PDF,F,Long> field(String fieldPath, Class<F> type, ValueConvert convert)
      Deprecated.
      Use field(String, Class, ValueModel) instead.
      Target the given field in the range aggregation.
      Type Parameters:
      F - The type of field values.
      Parameters:
      fieldPath - The path to the index field to aggregate.
      type - The type of field values.
      convert - Controls how the ranges passed to the next steps and fetched from the backend should be converted. See ValueConvert.
      Returns:
      The next step.

    • field

      <F> RangeAggregationRangeStep<SR,?,PDF,F,Long> field(String fieldPath, Class<F> type, ValueModel valueModel)
      Target the given field in the range aggregation.
      Type Parameters:
      F - The type of field values.
      Parameters:
      fieldPath - The path to the index field to aggregate.
      type - The type of field values.
      valueModel - valueModel The model of range values, used to determine how range values passed to the next steps and fetched from the backend should be converted. See ValueModel.
      Returns:
      The next step.

    • field

      default <F> RangeAggregationRangeStep<SR,?,PDF,F,Long> field(RangeAggregationFieldReference<? super SR,F> fieldReference)
      Target the given field in the range aggregation.
      Type Parameters:
      F - The type of field values.
      Parameters:
      fieldReference - The field reference representing a definition of the index field to aggregate.
      Returns:
      The next step.