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

Class Top

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.Top

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, PostOptimizationVerificationAware, Resolvable, TwoOptionalArguments, SurrogateExpression, ToAggregator

public class Top
extends AggregateFunction
implements TwoOptionalArguments, ToAggregator, SurrogateExpression, PostOptimizationVerificationAware

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.xpack.esql.capabilities.PostOptimizationVerificationAware

PostOptimizationVerificationAware.CoordinatorOnly

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY

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

Constructor Summary

Constructors

Constructor	Description
Top(Source source, Expression field, Expression limit, Expression order, Expression outputField)
Top(Source source, Expression field, Expression filter, Expression window, Expression limit, Expression order, Expression outputField)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()
String	getWriteableName()
protected NodeInfo<Top>	info()
void	postOptimizationVerification(Failures failures)	Validates the implementing expression - discovered failures are reported to the given Failures class.
Top	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()
AggregatorFunctionSupplier	supplier()
Expression	surrogate()	Returns the expression to be replaced by or null if this cannot be replaced.
Top	withFilter(Expression filter)	Attach a filter to the aggregate function.

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

aggregateInputReferences, equals, field, filter, hasFilter, hashCode, hasWindow, parameters, postAnalysisPlanVerification, readWindow, window, 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, nodeName, nodeProperties, 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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

Top

public Top(Source source,
 Expression field,
 Expression limit,
 Expression order,
 Expression outputField)

Top

public Top(Source source,
 Expression field,
 Expression filter,
 Expression window,
 Expression limit,
 Expression order,
 @Nullable
 Expression outputField)

Method Details

withFilter

public Top withFilter(Expression filter)

Description copied from class: AggregateFunction

Attach a filter to the aggregate function.

Specified by:

withFilter in class AggregateFunction

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

resolveType

protected Expression.TypeResolution resolveType()

Overrides:

resolveType in class AggregateFunction

postOptimizationVerification

public void postOptimizationVerification(Failures failures)

Description copied from interface: PostOptimizationVerificationAware

Validates the implementing expression - discovered failures are reported to the given Failures class.

Example: the Bucket function, which produces buckets over a numerical or date field, based on a number of literal arguments needs to check if its arguments are all indeed literals. This is how this verification is performed:

     

      @Override
      public void postOptimizationVerification(Failures failures) {
          String operation = sourceText();

          failures.add(isFoldable(buckets, operation, SECOND))
              .add(from != null ? isFoldable(from, operation, THIRD) : null)
              .add(to != null ? isFoldable(to, operation, FOURTH) : null);
      }
     
     

Specified by:

postOptimizationVerification in interface PostOptimizationVerificationAware

dataType

public DataType dataType()

Specified by:

dataType in class Expression

info

protected NodeInfo<Top> info()

Specified by:

info in class Node<Expression>

replaceChildren

public Top replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

supplier

public AggregatorFunctionSupplier supplier()

Specified by:

supplier in interface ToAggregator

surrogate

public Expression surrogate()

Description copied from interface: SurrogateExpression

Returns the expression to be replaced by or null if this cannot be replaced.

Specified by:

surrogate in interface SurrogateExpression