Package org.elasticsearch.xpack.esql.expression

Class Order

java.lang.Object

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

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

org.elasticsearch.xpack.esql.expression.Order

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

public class Order
extends Expression

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Order.NullsPosition
static enum	Order.OrderDirection

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
Order(StreamInput in)
Order(Source source, Expression child, Order.OrderDirection direction, Order.NullsPosition nulls)

Method Summary

Modifier and Type	Method	Description
Expression	child()
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
Order.OrderDirection	direction()
boolean	equals(Object obj)
String	getWriteableName()
int	hashCode()
protected NodeInfo<Order>	info()	Normally, you want to use one of the static create methods to implement this.
Nullability	nullable()
Order.NullsPosition	nullsPosition()
Order	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
void	writeTo(StreamOutput out)

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, 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

Order

public Order(Source source,
 Expression child,
 Order.OrderDirection direction,
 Order.NullsPosition nulls)

Order

public Order(StreamInput in)
      throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

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 Expression

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

replaceChildren

public Order replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

info

protected NodeInfo<Order> 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>

nullable

public Nullability nullable()

Specified by:

nullable in class Expression

child

public Expression child()

direction

public Order.OrderDirection direction()

nullsPosition

public Order.NullsPosition nullsPosition()

hashCode

public int hashCode()

Overrides:

hashCode in class Node<Expression>

equals

public boolean equals(Object obj)

Overrides:

equals in class Node<Expression>