Package org.apache.druid.math.expr

Class ExprMacroTable.BaseMacroFunctionExpr

java.lang.Object

org.apache.druid.math.expr.ExprMacroTable.BaseMacroFunctionExpr

All Implemented Interfaces:

Cacheable, Expr, ExprMacroTable.ExprMacroFunctionExpr

Direct Known Subclasses:

ExprMacroTable.BaseScalarMacroFunctionExpr

Enclosing class:

ExprMacroTable

public abstract static class ExprMacroTable.BaseMacroFunctionExpr
extends Object
implements ExprMacroTable.ExprMacroFunctionExpr

Base class for Expr from ExprMacroTable.ExprMacro.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.druid.math.expr.Expr

Expr.BindingAnalysis, Expr.InputBindingInspector, Expr.ObjectBinding, Expr.Shuttle, Expr.VectorInputBinding, Expr.VectorInputBindingInspector

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Expr>	args
protected ExprMacroTable.ExprMacro	macro

Fields inherited from interface org.apache.druid.math.expr.Expr

ARG_JOINER, NULL_LITERAL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseMacroFunctionExpr(ExprMacroTable.ExprMacro macro, List<Expr> macroArgs)	Constructor for subclasses.

Method Summary

Modifier and Type	Method	Description
Expr.BindingAnalysis	analyzeInputs()	Examine the usage of IdentifierExpr children of an Expr, constructing a Expr.BindingAnalysis
<T> ExprVectorProcessor<T>	asVectorProcessor(Expr.VectorInputBindingInspector inspector)	Builds a 'vectorized' expression processor, that can operate on batches of input values for use in vectorized query engines.
boolean	canVectorize(Expr.InputBindingInspector inspector)	Check if an expression can be 'vectorized', for a given set of inputs.
boolean	equals(Object o)
List<Expr>	getArgs()
int	hashCode()
String	stringify()	Convert the Expr back into parseable string that when parsed with Parser.parse(String, ExprMacroTable) will produce an equivalent Expr.
protected abstract Expr.BindingAnalysis	supplyAnalyzeInputs()	Implemented by subclasses to provide the value for analyzeInputs(), which uses a memoized supplier.
String	toString()
Expr	visit(Expr.Shuttle shuttle)	Programatically rewrite the Expr tree with a Expr.Shuttle.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.druid.math.expr.Expr

asColumnIndexSupplier, asSingleThreaded, canFallbackVectorize, decorateCacheKeyBuilder, eval, getBindingIfIdentifier, getCacheKey, getIdentifierExprIfIdentifierExpr, getIdentifierIfIdentifier, getLiteralValue, getOutputType, isIdentifier, isLiteral, isNullLiteral

Field Detail

macro

protected final ExprMacroTable.ExprMacro macro

args

protected final List<Expr> args

Constructor Detail

BaseMacroFunctionExpr

protected BaseMacroFunctionExpr(ExprMacroTable.ExprMacro macro,
                                List<Expr> macroArgs)

Constructor for subclasses.

Parameters:

macro - macro that created this expr

macroArgs - original args to the macro (not the ones this will be evaled with)

Method Detail

getArgs

public List<Expr> getArgs()

Specified by:

getArgs in interface ExprMacroTable.ExprMacroFunctionExpr

stringify

public String stringify()

Description copied from interface: Expr

Convert the Expr back into parseable string that when parsed with Parser.parse(String, ExprMacroTable) will produce an equivalent Expr.

Specified by:

stringify in interface Expr

visit

public Expr visit(Expr.Shuttle shuttle)

Description copied from interface: Expr

Programatically rewrite the Expr tree with a Expr.Shuttle. Each Expr is responsible for ensuring the Expr.Shuttle can visit all of its Expr children, as well as updating its children Expr with the results from the Expr.Shuttle, before finally visiting an updated form of itself. When this Expr is the result of ExprMacroTable.ExprMacro.apply(java.util.List<org.apache.druid.math.expr.Expr>), all of the original arguments to the macro must be visited, including arguments that may have been "baked in" to this Expr.

Specified by:

visit in interface Expr

analyzeInputs

public Expr.BindingAnalysis analyzeInputs()

Description copied from interface: Expr

Examine the usage of IdentifierExpr children of an Expr, constructing a Expr.BindingAnalysis

Specified by:

analyzeInputs in interface Expr

canVectorize

public boolean canVectorize(Expr.InputBindingInspector inspector)

Description copied from interface: Expr

Check if an expression can be 'vectorized', for a given set of inputs. If this method returns true, Expr.asVectorProcessor(org.apache.druid.math.expr.Expr.VectorInputBindingInspector) is expected to produce a ExprVectorProcessor which can evaluate values in batches to use with vectorized query engines.

Specified by:

canVectorize in interface Expr

asVectorProcessor

public <T> ExprVectorProcessor<T> asVectorProcessor(Expr.VectorInputBindingInspector inspector)

Description copied from interface: Expr

Builds a 'vectorized' expression processor, that can operate on batches of input values for use in vectorized query engines.

Specified by:

asVectorProcessor in interface Expr

supplyAnalyzeInputs

protected abstract Expr.BindingAnalysis supplyAnalyzeInputs()

Implemented by subclasses to provide the value for analyzeInputs(), which uses a memoized supplier.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object