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

Interface RangeAggregationValueStep<SR,PDF extends TypedSearchPredicateFactory<SR>,F>

Type Parameters:
SR - Scope root type.
PDF - The type of factory used to create predicates in AggregationFilterStep.filter(Function).
F - The type of the targeted field.
All Known Subinterfaces:
RangeAggregationRangeMoreStep<SR,S,N,PDF,F,A>
@Incubating public interface RangeAggregationValueStep<SR,PDF extends TypedSearchPredicateFactory<SR>,F>
The step in a "range" aggregation definition where the aggregation value for the range can be set.

  • Method Details

    • value

      @Incubating <T> RangeAggregationOptionsStep<SR,?,PDF,F,Map<org.hibernate.search.util.common.data.Range<F>,T>> value(SearchAggregation<T> aggregation)
      Specify which aggregation to apply to the documents within the range.

      This allows to "group" the documents by "ranges" and then apply one of the aggregations from SearchAggregationFactory to the documents in that group.

      Type Parameters:
      T - The type of the aggregated results within a range.
      Parameters:
      aggregation - The aggregation to apply to the documents within each range.
      Returns:
      The next step in range aggregation definition.

    • value

      @Incubating default <T> RangeAggregationOptionsStep<SR,?,PDF,F,Map<org.hibernate.search.util.common.data.Range<F>,T>> value(AggregationFinalStep<T> aggregation)
      Specify which aggregation to apply to the documents within the range.

      This allows to "group" the documents by "ranges" and then apply one of the aggregations from SearchAggregationFactory to the documents in that group.

      Type Parameters:
      T - The type of the aggregated results within a range.
      Parameters:
      aggregation - The aggregation to apply to the documents within each range.
      Returns:
      The next step in range aggregation definition.