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

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

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

  • Method Details

    • field

      default <F> SumAggregationOptionsStep<SR,?,PDF,F> field(String fieldPath, Class<F> type)
      Target the given field in the sum 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

      <F> SumAggregationOptionsStep<SR,?,PDF,F> field(String fieldPath, Class<F> type, ValueModel valueModel)
      Target the given field in the sum 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 - The model of terms values, used to determine how term values fetched from the backend should be converted. See ValueModel.
      Returns:
      The next step.

    • field

      @Incubating default <F> SumAggregationOptionsStep<SR,?,PDF,F> field(SumAggregationFieldReference<SR,F> fieldReference)
      Target the given field in the sum 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.