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

Class SpatialContains

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

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

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

All Implemented Interfaces:

NamedWriteable, Writeable, TranslationAware, Resolvable, EvaluatorMapper, SurrogateExpression

public class SpatialContains
extends SpatialRelatesFunction

This is the primary class for supporting the function ST_CONTAINS. The bulk of the capabilities are within the parent class SpatialRelatesFunction, which supports all the relations in the ShapeField.QueryRelation enum. Here we simply wire the rules together specific to ST_CONTAINS and QueryRelation.CONTAINS.

Nested Class Summary

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

SpatialRelatesFunction.SpatialRelations

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

BinarySpatialFunction.BinarySpatialComparator<T>, BinarySpatialFunction.SpatialCrsType

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.xpack.esql.capabilities.TranslationAware

TranslationAware.FinishedTranslatable, TranslationAware.SingleValueTranslationAware, TranslationAware.Translatable

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 org.elasticsearch.xpack.esql.expression.function.scalar.spatial.SpatialContains.SpatialRelationsContains	CARTESIAN
static final NamedWriteableRegistry.Entry	ENTRY
static final org.elasticsearch.xpack.esql.expression.function.scalar.spatial.SpatialContains.SpatialRelationsContains	GEO

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

leftDocValues, 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_WIDTH

Constructor Summary

Constructors

Constructor	Description
SpatialContains(Source source, Expression left, Expression right)

Method Summary

Modifier and Type	Method	Description
BinarySpatialFunction.SpatialCrsType	crsType()
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.
Expression	left()
boolean	leftDocValues()
ShapeRelation	queryRelation()
protected SpatialContains	replaceChildren(Expression newLeft, Expression newRight)
Expression	right()
boolean	rightDocValues()
Source	source()
SpatialRelatesFunction	surrogate()	To keep the number of evaluators to a minimum, we swap the arguments to get the WITHIN relation.
SpatialContains	withDocValues(boolean foundLeft, boolean foundRight)	Mark the function as expecting the specified fields to arrive as doc-values.

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

asQuery, dataType, toEvaluator, translatable

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

crsType, equals, hashCode, leftDocValues, resolveType, rightDocValues, setCrsType, spatialCRSCompatible, writeTo

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

foldable, left, 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, 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

Methods inherited from interface org.elasticsearch.xpack.esql.capabilities.TranslationAware

asLuceneQuery

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

GEO

public static final org.elasticsearch.xpack.esql.expression.function.scalar.spatial.SpatialContains.SpatialRelationsContains GEO

CARTESIAN

public static final org.elasticsearch.xpack.esql.expression.function.scalar.spatial.SpatialContains.SpatialRelationsContains CARTESIAN

Constructor Details

SpatialContains

public SpatialContains(Source source,
 Expression left,
 Expression right)

Method Details

getWriteableName

public String getWriteableName()

queryRelation

public ShapeRelation queryRelation()

Specified by:

queryRelation in class SpatialRelatesFunction

withDocValues

public SpatialContains withDocValues(boolean foundLeft,
 boolean foundRight)

Description copied from class: BinarySpatialFunction

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

Specified by:

withDocValues in class BinarySpatialFunction

replaceChildren

protected SpatialContains replaceChildren(Expression newLeft,
 Expression newRight)

Specified by:

replaceChildren in class BinaryScalarFunction

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>

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

surrogate

public SpatialRelatesFunction surrogate()

To keep the number of evaluators to a minimum, we swap the arguments to get the WITHIN relation. This also makes other optimizations, like lucene-pushdown, simpler to develop.

Specified by:

surrogate in interface SurrogateExpression

Overrides:

surrogate in class SpatialRelatesFunction

source

Source source()

left

Expression left()

right

Expression right()

crsType

BinarySpatialFunction.SpatialCrsType crsType()

leftDocValues

boolean leftDocValues()

rightDocValues

boolean rightDocValues()