Package org.elasticsearch.xpack.esql.expression.function.aggregate

Class NumericAggregate

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

org.elasticsearch.xpack.esql.expression.function.aggregate.NumericAggregate

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, Resolvable, ToAggregator

Direct Known Subclasses:

MedianAbsoluteDeviation, Percentile, Sum

public abstract class NumericAggregate
extends AggregateFunction
implements ToAggregator

Aggregate function that receives a numeric, signed field, and returns a single double value.

Implement the supplier methods to return the correct AggregatorFunctionSupplier.

Some methods can be optionally overridden to support different variations:

• supportsDates(): override to also support dates. Defaults to false.
• resolveType(): override to support different parameters. Call super.resolveType() to add extra checks.
• dataType(): override to return a different datatype. You can return field().dataType() to propagate the parameter type.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

NO_WINDOW, WINDOW_INTERVAL

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_WIDTH

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
protected abstract AggregatorFunctionSupplier	doubleSupplier()
protected abstract AggregatorFunctionSupplier	intSupplier()
protected abstract AggregatorFunctionSupplier	longSupplier()
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
final AggregatorFunctionSupplier	supplier()
protected boolean	supportsDates()

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

aggregateInputReferences, equals, field, filter, hasFilter, hashCode, hasWindow, parameters, postAnalysisPlanVerification, readWindow, window, withFilter, withParameters, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, functionName, nodeString, nullable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, fold, foldable, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, nodeName, nodeProperties, replaceChildren, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Method Details

resolveType

protected Expression.TypeResolution resolveType()

Description copied from class: Expression

The implementation of Expression.typeResolved(), which is just a caching wrapper around this method. See it's javadoc for what this method should return.

Implementations will rarely interact with the Expression.TypeResolution class directly, instead usually calling the utility methods on TypeResolutions.

Implementations should fail if Expression.childrenResolved() returns false.

Overrides:

resolveType in class AggregateFunction

supportsDates

protected boolean supportsDates()

dataType

public DataType dataType()

Description copied from class: Expression

The DataType returned by executing the tree rooted at this expression. If Expression.typeResolved() returns an error then the behavior of this method is undefined. It may return a valid type. Or it may throw an exception. Or it may return a totally nonsensical type.

Specified by:

dataType in class Expression

supplier

public final AggregatorFunctionSupplier supplier()

Specified by:

supplier in interface ToAggregator

longSupplier

protected abstract AggregatorFunctionSupplier longSupplier()

intSupplier

protected abstract AggregatorFunctionSupplier intSupplier()

doubleSupplier

protected abstract AggregatorFunctionSupplier doubleSupplier()