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

Class StGeotile

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

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

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper, OptionalArgument, LicenseAware

public class StGeotile
extends SpatialGridFunction
implements EvaluatorMapper

Calculates the geotile of geo_point geometries.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	StGeotile.GeoTileBoundedGrid	When checking tiles with bounds, we need to check if the tile is valid (intersects with the bounds).

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.expression.function.scalar.spatial.SpatialGridFunction

SpatialGridFunction.BoundedGrid, SpatialGridFunction.UnboundedGrid

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
static final NamedWriteableRegistry.Entry	ENTRY
static final SpatialGridFunction.UnboundedGrid	unboundedGrid	For unbounded grids, we don't need to check if the tile is valid, just calculate the encoded long intersecting the point at that precision.

Fields inherited from class org.elasticsearch.xpack.esql.expression.function.scalar.spatial.SpatialGridFunction

bounds, parameter, spatialField

Fields inherited from class org.elasticsearch.xpack.esql.expression.function.scalar.spatial.SpatialDocValuesFunction

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

Constructor	Description
StGeotile(Source source, Expression field, Expression precision, Expression bounds)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
Object	fold(FoldContext ctx)	Evaluate this expression statically to a constant.
String	getWriteableName()
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
protected SpatialGridFunction	replaceChildren(Expression newSpatialField, Expression newParameter, Expression newBounds)
static org.apache.lucene.util.BytesRef	toBounds(long gridId)
EvalOperator.ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Convert this into an EvalOperator.ExpressionEvaluator.
SpatialGridFunction	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.spatial.SpatialGridFunction

addGrids, asGeoBoundingBox, asGeoBoundingBox, asRectangle, bounds, foldable, fromEncodedLong, fromEncodedLong, fromWKB, fromWKB, isGeoPoint, isGeoshape, licenseCheck, parameter, replaceChildren, resolveType, spatialField, writeTo

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

equals, hashCode, prefersDocValuesExtraction, spatialDocValues

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

fold

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

unboundedGrid

public static final SpatialGridFunction.UnboundedGrid unboundedGrid

For unbounded grids, we don't need to check if the tile is valid, just calculate the encoded long intersecting the point at that precision.

Constructor Details

StGeotile

public StGeotile(Source source,
 Expression field,
 Expression precision,
 Expression bounds)

Method Details

withDocValues

public SpatialGridFunction withDocValues(boolean useDocValues)

Description copied from class: SpatialDocValuesFunction

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

Specified by:

withDocValues in class SpatialDocValuesFunction

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

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

replaceChildren

protected SpatialGridFunction replaceChildren(Expression newSpatialField,
 Expression newParameter,
 Expression newBounds)

Specified by:

replaceChildren in class SpatialGridFunction

info

protected NodeInfo<? extends Expression> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Specified by:

info in class Node<Expression>

toEvaluator

public EvalOperator.ExpressionEvaluator.Factory toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)

Description copied from interface: EvaluatorMapper

Convert this into an EvalOperator.ExpressionEvaluator.

Note for implementors: If you are implementing this function, you should call the passed-in lambda on your children, after doing any other manipulation (casting, etc.) necessary.

Note for Callers: If you are attempting to call this method, and you have an Expression and a Layout, you likely want to call EvalMapper.toEvaluator(org.elasticsearch.xpack.esql.core.expression.FoldContext, org.elasticsearch.xpack.esql.core.expression.Expression, org.elasticsearch.xpack.esql.planner.Layout) instead. On the other hand, if you already have something that looks like the parameter for this method, you should call this method with that function.

Build an EvalOperator.ExpressionEvaluator.Factory for the tree of expressions rooted at this node. This is only guaranteed to return a sensible evaluator if this node has a valid type. If this node is a subclass of Expression then "valid type" means that Expression.typeResolved() returns a non-error resolution. If Expression.typeResolved() returns an error then this method may throw. Or return an evaluator that produces garbage. Or return an evaluator that throws when run.

Specified by:

toEvaluator in interface EvaluatorMapper

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

toBounds

public static org.apache.lucene.util.BytesRef toBounds(long gridId)