Package org.elasticsearch.xpack.esql.expression.predicate.operator.comparison

Class InsensitiveEquals

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.predicate.operator.comparison.InsensitiveBinaryComparison

org.elasticsearch.xpack.esql.expression.predicate.operator.comparison.InsensitiveEquals

All Implemented Interfaces:

NamedWriteable, Writeable, TranslationAware, TranslationAware.SingleValueTranslationAware, Resolvable

public class InsensitiveEquals
extends InsensitiveBinaryComparison

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.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 NamedWriteableRegistry.Entry	ENTRY

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
InsensitiveEquals(Source source, Expression left, Expression right)

Method Summary

Modifier and Type	Method	Description
Query	asQuery(LucenePushdownPredicates pushdownPredicates, TranslatorHandler handler)	Translates the implementing expression into a Query.
static org.apache.lucene.util.automaton.Automaton	automaton(org.apache.lucene.util.BytesRef val)
Boolean	fold(FoldContext ctx)	Evaluate this expression statically to a constant.
String	getWriteableName()
protected NodeInfo<InsensitiveEquals>	info()	Normally, you want to use one of the static create methods to implement this.
protected InsensitiveEquals	replaceChildren(Expression newLeft, Expression newRight)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
Expression	singleValueField()	Returns the field that only supports single-value semantics.
String	symbol()
TranslationAware.Translatable	translatable(LucenePushdownPredicates pushdownPredicates)	Can this instance be translated or not? Usually checks whether the expression arguments are actual fields that exist in Lucene.

Methods inherited from class org.elasticsearch.xpack.esql.expression.predicate.operator.comparison.InsensitiveBinaryComparison

dataType

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

foldable, left, replaceChildren, right, writeTo

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

arguments, equals, functionName, hashCode, 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.capabilities.TranslationAware

asLuceneQuery

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

InsensitiveEquals

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

Method Details

getWriteableName

public String getWriteableName()

info

protected NodeInfo<InsensitiveEquals> 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>

replaceChildren

protected InsensitiveEquals replaceChildren(Expression newLeft,
 Expression newRight)

Specified by:

replaceChildren in class BinaryScalarFunction

symbol

public String symbol()

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

automaton

public static org.apache.lucene.util.automaton.Automaton automaton(org.apache.lucene.util.BytesRef val)

fold

public Boolean 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

translatable

public TranslationAware.Translatable translatable(LucenePushdownPredicates pushdownPredicates)

Description copied from interface: TranslationAware

Can this instance be translated or not? Usually checks whether the expression arguments are actual fields that exist in Lucene. See TranslationAware.Translatable for precisely what can be signaled from this method.

asQuery

public Query asQuery(LucenePushdownPredicates pushdownPredicates,
 TranslatorHandler handler)

Description copied from interface: TranslationAware

Translates the implementing expression into a Query. If during translation a child needs to be translated first, the handler needs to be used even if the child implements this interface as well. This is to ensure that the child is wrapped in a SingleValueQuery if necessary.

So use this:

Query childQuery = handler.asQuery(child);

and not this:

Query childQuery = child.asQuery(handler);

singleValueField

public Expression singleValueField()

Description copied from interface: TranslationAware.SingleValueTranslationAware

Returns the field that only supports single-value semantics.