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

Interface CompositeAggregationInnerStep

@Incubating public interface CompositeAggregationInnerStep
A step in a "multi-step" composite aggregation definition where one can define inner aggregations to get values from.

  • Method Details

    • from

      <V1> CompositeAggregationFrom1AsStep<V1> from(SearchAggregation<V1> aggregation)
      Defines one inner aggregation to get values from, based on a previously-built SearchAggregation.
      Type Parameters:
      V1 - The type of values returned by the inner aggregation.
      Parameters:
      aggregation - The inner aggregation.
      Returns:
      The next DSL step.

    • from

      default <V1> CompositeAggregationFrom1AsStep<V1> from(AggregationFinalStep<V1> dslFinalStep)
      Defines one inner aggregation to get values from, based on an almost-built SearchAggregation.
      Type Parameters:
      V1 - The type of values returned by the inner aggregation.
      Parameters:
      dslFinalStep - A final step in the aggregation DSL allowing the retrieval of the inner aggregation.
      Returns:
      The next DSL step.

    • from

      <V1, V2> CompositeAggregationFrom2AsStep<V1,V2> from(SearchAggregation<V1> aggregation1, SearchAggregation<V2> aggregation2)
      Defines two inner aggregations to get values from, based on previously-built SearchAggregations.
      Type Parameters:
      V1 - The type of values returned by the first inner aggregation.
      V2 - The type of values returned by the second inner aggregation.
      Parameters:
      aggregation1 - The first inner aggregation.
      aggregation2 - The second inner aggregation.
      Returns:
      The next DSL step.

    • from

      default <V1, V2> CompositeAggregationFrom2AsStep<V1,V2> from(AggregationFinalStep<V1> dslFinalStep1, AggregationFinalStep<V2> dslFinalStep2)
      Defines two inner aggregations to get values from, based on almost-built SearchAggregations.
      Type Parameters:
      V1 - The type of values returned by the first inner aggregation.
      V2 - The type of values returned by the second inner aggregation.
      Parameters:
      dslFinalStep1 - A final step in the aggregation DSL allowing the retrieval of the first inner aggregation.
      dslFinalStep2 - A final step in the aggregation DSL allowing the retrieval of the second inner aggregation.
      Returns:
      The next DSL step.

    • from

      <V1, V2, V3> CompositeAggregationFrom3AsStep<V1,V2,V3> from(SearchAggregation<V1> aggregation1, SearchAggregation<V2> aggregation2, SearchAggregation<V3> aggregation3)
      Defines three inner aggregations to get values from, based on previously-built SearchAggregations.
      Type Parameters:
      V1 - The type of values returned by the first inner aggregation.
      V2 - The type of values returned by the second inner aggregation.
      V3 - The type of values returned by the third inner aggregation.
      Parameters:
      aggregation1 - The first inner aggregation.
      aggregation2 - The second inner aggregation.
      aggregation3 - The third inner aggregation.
      Returns:
      The next DSL step.

    • from

      default <V1, V2, V3> CompositeAggregationFrom3AsStep<V1,V2,V3> from(AggregationFinalStep<V1> dslFinalStep1, AggregationFinalStep<V2> dslFinalStep2, AggregationFinalStep<V3> dslFinalStep3)
      Defines three inner aggregations to get values from, based on almost-built SearchAggregations.
      Type Parameters:
      V1 - The type of values returned by the first inner aggregation.
      V2 - The type of values returned by the second inner aggregation.
      V3 - The type of values returned by the third inner aggregation.
      Parameters:
      dslFinalStep1 - A final step in the aggregation DSL allowing the retrieval of the first inner aggregation.
      dslFinalStep2 - A final step in the aggregation DSL allowing the retrieval of the second inner aggregation.
      dslFinalStep3 - A final step in the aggregation DSL allowing the retrieval of the third inner aggregation.
      Returns:
      The next DSL step.

    • from

      CompositeAggregationFromAsStep from(SearchAggregation<?>... aggregations)
      Defines multiple inner aggregations to get values from, based on previously-built SearchAggregations.
      Parameters:
      aggregations - The inner aggregations, in order.
      Returns:
      The next DSL step.

    • from

      CompositeAggregationFromAsStep from(AggregationFinalStep<?>... dslFinalSteps)
      Defines multiple inner aggregations to get values from, based on almost-built SearchAggregations.
      Parameters:
      dslFinalSteps - The final steps in the aggregation DSL allowing the retrieval of inner aggregations, in order.
      Returns:
      The next DSL step.