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

Class SpatialDocValuesFunction

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper

Direct Known Subclasses:

SpatialGridFunction, SpatialUnaryDocValuesFunction

public abstract class SpatialDocValuesFunction
extends EsqlScalarFunction

Spatial functions that can take doc values as an argument can inherit from this class. Examples: StGeohash, StGeotile, StGeohex and StSimplify

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.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 boolean	spatialDocValues

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	SpatialDocValuesFunction(Source source, List<Expression> expressions, boolean spatialDocValues)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	foldable()	Whether the expression can be evaluated statically, aka "folded", or not.
int	hashCode()
boolean	prefersDocValuesExtraction()	Indicates that this function prefers to have its spatial argument extracted from doc values.
boolean	spatialDocValues()
abstract Expression	spatialField()
abstract SpatialDocValuesFunction	withDocValues(boolean useDocValues)	Mark the function as expecting the specified field to arrive as doc-values.

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

fold

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

fold, toEvaluator

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

getWriteableName

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

writeTo

Field Details

spatialDocValues

protected final boolean spatialDocValues

Constructor Details

SpatialDocValuesFunction

protected SpatialDocValuesFunction(Source source,
 List<Expression> expressions,
 boolean spatialDocValues)

Method Details

withDocValues

public abstract SpatialDocValuesFunction withDocValues(boolean useDocValues)

Mark the function as expecting the specified field to arrive as doc-values. This only applies to geo_point and cartesian_point types.

hashCode

public int hashCode()

Overrides:

hashCode in class Function

equals

public boolean equals(Object obj)

Overrides:

equals in class Function

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

spatialField

public abstract Expression spatialField()

spatialDocValues

public boolean spatialDocValues()

prefersDocValuesExtraction

public boolean prefersDocValuesExtraction()

Indicates that this function prefers to have its spatial argument extracted from doc values. This is a hint to the planner that can be ignored if necessary. If a function does not prefer doc values extraction, it should override this method to return false. Examples of such functions are ST_X and ST_Y that should provide exact values from source. Note that if the original field is not dropped from the output, this request will be ignored.