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

Class BinarySpatialFunction

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

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

Direct Known Subclasses:

SpatialRelatesFunction, StDistance

public abstract class BinarySpatialFunction
extends BinaryScalarFunction

Spatial functions that take two arguments that must both be spatial types can inherit from this class. This provides common support for type resolution and validation. Ensuring that both arguments are spatial types and of compatible CRS. For example geo_point and geo_shape can be compared, but not geo_point and cartesian_point.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BinarySpatialFunction.BinarySpatialComparator<T>
static enum	BinarySpatialFunction.SpatialCrsType	For most spatial functions we only need to know if the CRS is geo or cartesian, not whether the type is point or shape.
protected static class	BinarySpatialFunction.SpatialTypeResolver

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
protected final boolean	leftDocValues
protected final boolean	rightDocValues
protected final BinarySpatialFunction.SpatialTypeResolver	spatialTypeResolver

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	BinarySpatialFunction(StreamInput in, boolean leftDocValues, boolean rightDocValues, boolean pointsOnly, boolean supportsGrid)
protected	BinarySpatialFunction(Source source, Expression left, Expression right, boolean leftDocValues, boolean rightDocValues, boolean pointsOnly, boolean supportsGrid)

Method Summary

Modifier and Type	Method	Description
BinarySpatialFunction.SpatialCrsType	crsType()
boolean	equals(Object obj)
protected abstract Object	fold(org.elasticsearch.geometry.Geometry leftGeom, org.elasticsearch.geometry.Geometry rightGeom)
Object	fold(FoldContext ctx)	Evaluate this expression statically to a constant.
int	hashCode()
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()
void	setCrsType(DataType dataType)
Source	source()
protected static boolean	spatialCRSCompatible(DataType spatialDataType, DataType otherDataType)
TranslationAware.Translatable	translatable(LucenePushdownPredicates pushdownPredicates)	Push-down to Lucene is only possible if one field is an indexed spatial field, and the other is a constant spatial or string column.
abstract BinarySpatialFunction	withDocValues(boolean foundLeft, boolean foundRight)	Mark the function as expecting the specified fields to arrive as doc-values.
void	writeTo(StreamOutput out)

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

foldable, left, replaceChildren, replaceChildren, right

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

Field Details

spatialTypeResolver

protected final BinarySpatialFunction.SpatialTypeResolver spatialTypeResolver

leftDocValues

protected final boolean leftDocValues

rightDocValues

protected final boolean rightDocValues

Constructor Details

BinarySpatialFunction

protected BinarySpatialFunction(Source source,
 Expression left,
 Expression right,
 boolean leftDocValues,
 boolean rightDocValues,
 boolean pointsOnly,
 boolean supportsGrid)

BinarySpatialFunction

protected BinarySpatialFunction(StreamInput in,
 boolean leftDocValues,
 boolean rightDocValues,
 boolean pointsOnly,
 boolean supportsGrid)
                         throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BinaryScalarFunction

Throws:

IOException

fold

protected abstract Object fold(org.elasticsearch.geometry.Geometry leftGeom,
 org.elasticsearch.geometry.Geometry rightGeom)

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 Expression

withDocValues

public abstract BinarySpatialFunction withDocValues(boolean foundLeft,
 boolean foundRight)

Mark the function as expecting the specified fields to arrive as doc-values.

hashCode

public int hashCode()

Overrides:

hashCode in class Function

equals

public boolean equals(Object obj)

Overrides:

equals in class Function

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

setCrsType

public void setCrsType(DataType dataType)

spatialCRSCompatible

protected static boolean spatialCRSCompatible(DataType spatialDataType,
 DataType otherDataType)

crsType

public BinarySpatialFunction.SpatialCrsType crsType()

leftDocValues

public boolean leftDocValues()

rightDocValues

public boolean rightDocValues()

translatable

public TranslationAware.Translatable translatable(LucenePushdownPredicates pushdownPredicates)

Push-down to Lucene is only possible if one field is an indexed spatial field, and the other is a constant spatial or string column.

source

Source source()

left

Expression left()

right

Expression right()