Package org.elasticsearch.xpack.esql.expression.predicate.logical

Class BinaryLogic

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.core.expression.predicate.BinaryPredicate<Boolean,Boolean,Boolean,BinaryLogicOperation>

org.elasticsearch.xpack.esql.core.expression.predicate.BinaryOperator<Boolean,Boolean,Boolean,BinaryLogicOperation>

org.elasticsearch.xpack.esql.expression.predicate.logical.BinaryLogic

All Implemented Interfaces:

NamedWriteable, Writeable, TranslationAware, Resolvable, EvaluatorMapper, ExpressionScoreMapper

Direct Known Subclasses:

And, Or

public abstract class BinaryLogic
extends BinaryOperator<Boolean,Boolean,Boolean,BinaryLogicOperation>
implements TranslationAware, ExpressionScoreMapper, EvaluatorMapper

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

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.score.ExpressionScoreMapper

ExpressionScoreMapper.ToScorer

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 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_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BinaryLogic(StreamInput in, BinaryLogicOperation op)
protected	BinaryLogic(Source source, Expression left, Expression right, BinaryLogicOperation operation)

Method Summary

Modifier and Type	Method	Description
Query	asQuery(LucenePushdownPredicates pushdownPredicates, TranslatorHandler handler)	Translates the implementing expression into a Query.
static Query	boolQuery(Source source, Query left, Query right, boolean isAnd)
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
protected boolean	isCommutative()
Nullability	nullable()
protected Expression.TypeResolution	resolveInputType(Expression e, TypeResolutions.ParamOrdinal paramOrdinal)
ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Convert this into an ExpressionEvaluator.
ScoreOperator.ExpressionScorer.Factory	toScorer(ExpressionScoreMapper.ToScorer toScorer)
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.
final void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.predicate.BinaryOperator

canonicalize, collectCommutative, resolveType, swapLeftAndRight

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.predicate.BinaryPredicate

equals, fold, function, hashCode, nodeString, symbol

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

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, childrenResolved, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, nodeName, nodeProperties, nodeString, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, 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.common.io.stream.NamedWriteable

getWriteableName

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

asLuceneQuery

Constructor Details

BinaryLogic

protected BinaryLogic(Source source,
 Expression left,
 Expression right,
 BinaryLogicOperation operation)

BinaryLogic

protected BinaryLogic(StreamInput in,
 BinaryLogicOperation op)
               throws IOException

Throws:

IOException

Method Details

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BinaryScalarFunction

Throws:

IOException

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

resolveInputType

protected Expression.TypeResolution resolveInputType(Expression e,
 TypeResolutions.ParamOrdinal paramOrdinal)

Specified by:

resolveInputType in class BinaryOperator<Boolean,Boolean,Boolean,BinaryLogicOperation>

nullable

public Nullability nullable()

Overrides:

nullable in class Function

isCommutative

protected boolean isCommutative()

Overrides:

isCommutative in class BinaryOperator<Boolean,Boolean,Boolean,BinaryLogicOperation>

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.

Specified by:

translatable in interface TranslationAware

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);

Specified by:

asQuery in interface TranslationAware

boolQuery

public static Query boolQuery(Source source,
 Query left,
 Query right,
 boolean isAnd)

toScorer

public ScoreOperator.ExpressionScorer.Factory toScorer(ExpressionScoreMapper.ToScorer toScorer)

Specified by:

toScorer in interface ExpressionScoreMapper

toEvaluator

public ExpressionEvaluator.Factory toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)

Description copied from interface: EvaluatorMapper

Convert this into an 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 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