Module org.elasticsearch.compute.ann
Package org.elasticsearch.compute.ann

Annotation Interface GroupingAggregator

@Target(TYPE) @Retention(SOURCE) public @interface GroupingAggregator
Annotates a class that implements an aggregation function with grouping. See Aggregator for more information.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    processNulls
    When false (the default), the generated prepareProcessRawInputPage will return null — opting out of the callback loop — when all values in an input block are null, because there is nothing to aggregate.
    IntermediateState[]
    value
     
    Class<? extends Exception>[]
    warnExceptions
    Exceptions thrown by the `combine*(...)` methods to catch and convert into a warning and turn into a null value.

  • Element Details

    • value

      IntermediateState[] value
      Default:
      {}

    • warnExceptions

      Class<? extends Exception>[] warnExceptions
      Exceptions thrown by the `combine*(...)` methods to catch and convert into a warning and turn into a null value.
      Default:
      {}

    • processNulls

      boolean processNulls
      When false (the default), the generated prepareProcessRawInputPage will return null — opting out of the callback loop — when all values in an input block are null, because there is nothing to aggregate.

      Set to true for aggregations like FIRST and LAST that need to process null values to correctly track position-based semantics.

      Default:
      false