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

Class BinarySpatialGeometryFunction

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

org.elasticsearch.xpack.esql.expression.function.scalar.spatial.BinarySpatialGeometryFunction

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper

Direct Known Subclasses:

StDifference, StIntersection, StSymDifference, StUnion

public abstract class BinarySpatialGeometryFunction
extends EsqlScalarFunction

Abstract base for spatial functions that combine two geometry arguments and return a new geometry (e.g. ST_UNION, ST_INTERSECTION, ST_DIFFERENCE, ST_SYMDIFFERENCE).

Unlike SpatialRelatesFunction, these functions are not predicates and cannot be pushed down to Lucene. They are expected to appear in EVAL commands and return geo_shape or cartesian_shape results.

Both arguments must be spatial and must share the same coordinate reference system (geo or cartesian). Either or both arguments may be point fields accessed via doc-values; in that case the function is marked using withDocValues(boolean, boolean) during local physical planning so that the correct evaluator variant is chosen.

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.xpack.esql.evaluator.mapper.EvaluatorMapper

EvaluatorMapper.ToEvaluator

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
protected final Expression	left
protected final boolean	leftDocValues
protected final Expression	right
protected final boolean	rightDocValues

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	BinarySpatialGeometryFunction(Source source, Expression left, Expression right, boolean leftDocValues, boolean rightDocValues)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
boolean	equals(Object obj)
Object	fold(FoldContext ctx)	Evaluate this expression statically to a constant.
boolean	foldable()	Whether the expression can be evaluated statically, aka "folded", or not.
int	hashCode()
protected abstract org.locationtech.jts.geom.Geometry	jtsOperation(org.locationtech.jts.geom.Geometry leftGeom, org.locationtech.jts.geom.Geometry rightGeom)	Apply the concrete JTS geometry operation (union, intersection, difference, or symDifference).
Expression	left()
boolean	leftDocValues()
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
Expression	right()
boolean	rightDocValues()
abstract BinarySpatialGeometryFunction	withDocValues(boolean foundLeft, boolean foundRight)	Return a copy of this function with the specified doc-values flags set.
void	writeTo(StreamOutput out)

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, propertiesToString, references, resolved, 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, replaceChildren, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, 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.xpack.esql.evaluator.mapper.EvaluatorMapper

fold, toEvaluator

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

getWriteableName

Field Details

left

protected final Expression left

right

protected final Expression right

leftDocValues

protected final boolean leftDocValues

rightDocValues

protected final boolean rightDocValues

Constructor Details

BinarySpatialGeometryFunction

protected BinarySpatialGeometryFunction(Source source,
 Expression left,
 Expression right,
 boolean leftDocValues,
 boolean rightDocValues)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

left

public Expression left()

right

public Expression right()

leftDocValues

public boolean leftDocValues()

rightDocValues

public boolean rightDocValues()

withDocValues

public abstract BinarySpatialGeometryFunction withDocValues(boolean foundLeft,
 boolean foundRight)

Return a copy of this function with the specified doc-values flags set. Only point types support doc-values access; shape types are always read from source.

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

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

jtsOperation

protected abstract org.locationtech.jts.geom.Geometry jtsOperation(org.locationtech.jts.geom.Geometry leftGeom,
 org.locationtech.jts.geom.Geometry rightGeom)

Apply the concrete JTS geometry operation (union, intersection, difference, or symDifference).

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

hashCode

public int hashCode()

Overrides:

hashCode in class Function

equals

public boolean equals(Object obj)

Overrides:

equals in class Function