Package org.elasticsearch.xpack.esql.core.expression.function.scalar

Class UnaryScalarFunction

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.core.expression.function.scalar.ScalarFunction

org.elasticsearch.xpack.esql.core.expression.function.scalar.UnaryScalarFunction

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

Direct Known Subclasses:

IsNotNull, IsNull, Magnitude, Neg, Not, RegexMatch

public abstract class UnaryScalarFunction
extends ScalarFunction

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.core.expression.function.scalar.ScalarFunction

MAX_BYTES_REF_RESULT_SIZE

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UnaryScalarFunction(StreamInput in)
protected	UnaryScalarFunction(Source source, Expression field)

Method Summary

Modifier and Type	Method	Description
Expression	field()
abstract Object	fold(FoldContext ctx)	Evaluate this expression statically to a constant.
boolean	foldable()	Whether the expression can be evaluated statically, aka "folded", or not.
protected abstract UnaryScalarFunction	replaceChild(Expression newChild)
final UnaryScalarFunction	replaceChildren(List<Expression> newChildren)
void	writeTo(StreamOutput out)

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

arguments, equals, functionName, hashCode, nodeString, nullable

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

canonical, canonicalize, childrenResolved, dataType, 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, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, 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

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

getWriteableName

Constructor Details

UnaryScalarFunction

protected UnaryScalarFunction(Source source,
 Expression field)

UnaryScalarFunction

protected UnaryScalarFunction(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

replaceChildren

public final UnaryScalarFunction replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

replaceChild

protected abstract UnaryScalarFunction replaceChild(Expression newChild)

field

public Expression field()

foldable

public boolean foldable()

Description copied from class: Expression

Whether the expression can be evaluated statically, aka "folded", or not.

Overrides:

foldable in class Expression

fold

public abstract Object fold(FoldContext ctx)

Description copied from class: Expression

Evaluate this expression statically to a constant. It is an error to call this if Expression.foldable() returns false.

Overrides:

fold in class Expression