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

Class BinaryScalarFunction

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

Direct Known Subclasses:

BinaryPredicate, BinarySpatialFunction, InsensitiveBinaryComparison, MvConcat, MvContains, MvIntersects, MvSetOperationFunction, Split, VectorSimilarityFunction

public abstract class BinaryScalarFunction
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 class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BinaryScalarFunction(StreamInput in)
protected	BinaryScalarFunction(Source source, Expression left, Expression right)

Method Summary

Modifier and Type	Method	Description
boolean	foldable()	Whether the expression can be evaluated statically, aka "folded", or not.
Expression	left()
final BinaryScalarFunction	replaceChildren(List<Expression> newChildren)
protected abstract BinaryScalarFunction	replaceChildren(Expression newLeft, Expression newRight)
Expression	right()
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, fold, propertiesToString, references, resolved, resolveType, semanticEquals, semanticHash, toString, toString, typeResolved

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

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, nodeName, nodeProperties, nodeString, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, 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

BinaryScalarFunction

protected BinaryScalarFunction(Source source,
 Expression left,
 Expression right)

BinaryScalarFunction

protected BinaryScalarFunction(StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

replaceChildren

public final BinaryScalarFunction replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

replaceChildren

protected abstract BinaryScalarFunction replaceChildren(Expression newLeft,
 Expression newRight)

left

public Expression left()

right

public Expression right()

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