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

Class FilteredExpression

java.lang.Object

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

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

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

public class FilteredExpression
extends Expression

Basic wrapper for expressions declared with a nested filter (typically in stats). Used during parsing to attach the filter to the nested expression - it is expected the two get fused later on.

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

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
FilteredExpression(StreamInput in)
FilteredExpression(Source source, Expression delegate, Expression filter)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
Expression	delegate()
Expression	filter()
String	getWriteableName()
protected NodeInfo<FilteredExpression>	info()	Normally, you want to use one of the static create methods to implement this.
Nullability	nullable()
Expression	replaceChildren(List<Expression> newChildren)
Expression	surrogate()
void	writeTo(StreamOutput out)

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

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

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

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, equals, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, hashCode, nodeName, nodeProperties, nodeString, 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

FilteredExpression

public FilteredExpression(Source source,
 Expression delegate,
 Expression filter)

FilteredExpression

public FilteredExpression(StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

surrogate

public Expression surrogate()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

delegate

public Expression delegate()

filter

public Expression filter()

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

nullable

public Nullability nullable()

Specified by:

nullable in class Expression

info

protected NodeInfo<FilteredExpression> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Specified by:

info in class Node<Expression>

replaceChildren

public Expression replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>