org.apache.hadoop.hive.ql.parse.type

Class ExprFactory<T>

java.lang.Object

org.apache.hadoop.hive.ql.parse.type.ExprFactory<T>

Direct Known Subclasses:

ExprNodeDescExprFactory, RexNodeExprFactory

public abstract class ExprFactory<T>
extends Object

Generic expressions factory.

Constructor Summary

Constructors

Constructor and Description
ExprFactory()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addExprToExprsList(T columnList, T expr) Adds expression to list of expressions (list needs to be mutable).
protected abstract TypeInfo	adjustConstantType(PrimitiveTypeInfo targetType, Object constantValue) Adjust type of constant value based on input type, e.g., adjust precision and scale of decimal value based on type information.
protected abstract boolean	convertCASEIntoCOALESCEFuncCallExpr(FunctionInfo fi, List<T> inputs) Returns true if a CASE expression can be converted into a COALESCE function call.
protected boolean	convertCASEIntoIFFuncCallExpr(FunctionInfo fi, List<T> inputs) Returns true if a CASE expression can be converted into an IF function call.
protected abstract T	createBigintConstantExpr(String value) Creates a bigint constant expression from input value.
protected abstract T	createBooleanConstantExpr(String value) Creates a boolean constant expression from input value.
protected abstract T	createColumnRefExpr(ColumnInfo colInfo, List<RowResolver> rowResolverList) Creates column expression.
protected abstract T	createColumnRefExpr(ColumnInfo colInfo, RowResolver rowResolver, int offset) Creates column expression.
protected T	createConstantExpr(String value) Default generator for constant expression when type cannot be inferred from input query.
protected abstract T	createConstantExpr(TypeInfo typeInfo, Object constantValue) Creates a constant expression from input value with given type.
protected abstract T	createDateConstantExpr(String value) Creates a date constant expression from input value.
protected abstract T	createDecimalConstantExpr(String value, boolean allowNullValueConstantExpr) Creates a decimal constant expression from input value.
protected abstract T	createDoubleConstantExpr(String value) Creates a double constant expression from input value.
protected abstract T	createDynamicParamExpr(int index) Creates a dynamic parameter expression with void type.
protected abstract T	createExprsListExpr() Creates list of expressions.
protected abstract T	createFloatConstantExpr(String value) Creates a float constant expression from input value.
protected abstract T	createFuncCallExpr(TypeInfo typeInfo, FunctionInfo fi, String funcText, List<T> inputs) Creates function call expression.
protected abstract T	createIntConstantExpr(String value) Creates a int constant expression from input value.
protected abstract T	createIntervalDayConstantExpr(String value) Creates a interval day constant expression from input value.
protected abstract T	createIntervalDayTimeConstantExpr(String value) Creates a interval day-time constant expression from input value.
protected abstract T	createIntervalHourConstantExpr(String value) Creates a interval hour constant expression from input value.
protected abstract T	createIntervalMinuteConstantExpr(String value) Creates a interval minute constant expression from input value.
protected abstract T	createIntervalMonthConstantExpr(String value) Creates a interval month constant expression from input value.
protected abstract T	createIntervalSecondConstantExpr(String value) Creates a interval second constant expression from input value.
protected abstract T	createIntervalYearConstantExpr(String value) Creates a interval year constant expression from input value.
protected abstract T	createIntervalYearMonthConstantExpr(String value) Creates a interval year-month constant expression from input value.
protected abstract T	createNestedColumnRefExpr(TypeInfo typeInfo, T expr, String fieldName, Boolean isList) Creates a reference to a nested field.
protected abstract T	createNullConstantExpr() Creates a null constant expression with void type.
protected abstract T	createSmallintConstantExpr(String value) Creates a smallint constant expression from input value.
protected abstract T	createStringConstantExpr(String value) Creates a string constant expression from input value.
protected abstract T	createStructExpr(TypeInfo typeInfo, List<T> operands) Creates a struct with given type.
protected abstract T	createSubqueryExpr(TypeCheckCtx ctx, ASTNode subqueryOp, SubqueryType subqueryType, Object[] inputs) Creates subquery expression.
protected abstract T	createTimestampConstantExpr(String value) Creates a timestamp constant expression from input value.
protected abstract T	createTimestampLocalTimeZoneConstantExpr(String value, ZoneId zoneId) Creates a timestamp with local time zone constant expression from input value.
protected abstract T	createTinyintConstantExpr(String value) Creates a tinyint constant expression from input value.
protected abstract T	foldExpr(T expr) Folds the input expression and returns resulting expression.
protected abstract String	getColumnName(T expr, RowResolver rowResolver) Returns column name referenced by a column expression.
protected abstract Object	getConstantValue(T expr) Returns value stored in a constant expression.
protected abstract String	getConstantValueAsString(T expr) Returns value stored in a constant expression as String.
protected abstract List<T>	getExprChildren(T expr) Returns the children from the input expression (if any).
protected abstract FunctionInfo	getFunctionInfo(String funcName) Returns the FunctionInfo given the name
protected abstract List<String>	getStructNameList(T expr) Returns the list of names in the input struct expression.
protected abstract List<TypeInfo>	getStructTypeInfoList(T expr) Returns the list of types in the input struct expression.
protected abstract TypeInfo	getTypeInfo(T expr) Returns the type for the input expression.
protected abstract Object	interpretConstantAsPrimitive(PrimitiveTypeInfo targetType, Object constantValue, PrimitiveTypeInfo sourceType, boolean isEqual) Interpret the input constant value of source type as target type.
protected boolean	isAllConstants(List<T> exprs) Returns whether all input expressions are constant expressions.
protected abstract boolean	isANDFuncCallExpr(T expr) Returns whether the input expression is an AND function call.
protected abstract boolean	isAndFunction(FunctionInfo fi)
protected abstract boolean	isColumnRefExpr(Object o) Returns whether the input object is a column reference expression.
protected abstract boolean	isCompareFunction(FunctionInfo fi)
protected abstract boolean	isConsistentWithinQuery(FunctionInfo fi)
protected abstract boolean	isConstantExpr(Object o) Returns whether the input expression is a constant expression.
protected abstract boolean	isConstantStruct(T expr) Returns whether the input expression is a struct of constant expressions (all of them).
protected abstract boolean	isEqualFunction(FunctionInfo fi)
protected abstract boolean	isExprInstance(Object o) Returns whether the input is an instance of the expression class.
protected abstract boolean	isExprsListExpr(Object o) Returns whether the input expression is a list of expressions.
protected abstract boolean	isFuncCallExpr(Object o) Returns whether the input expression is a function call.
protected abstract boolean	isInFunction(FunctionInfo fi)
protected abstract boolean	isNEGATIVEFuncCallExpr(T expr) Returns whether the input expression is a NEGATIVE function call.
protected abstract boolean	isNSCompareFunction(FunctionInfo fi)
protected abstract boolean	isORFuncCallExpr(T expr) Returns whether the input expression is an OR function call.
protected abstract boolean	isOrFunction(FunctionInfo fi)
protected abstract boolean	isPOSITIVEFuncCallExpr(T expr) Returns whether the input expression is a POSITIVE function call.
protected abstract boolean	isStateful(FunctionInfo fi)
protected abstract boolean	isSTRUCTFuncCallExpr(T expr) Returns whether the input expression is a STRUCT function call.
protected abstract T	replaceFieldNamesInStruct(T expr, List<String> newFieldNames)
protected abstract T	setTypeInfo(T expr, TypeInfo type) Changes the type of the input expression to the input type and returns resulting expression.
protected abstract T	toExpr(ColumnInfo colInfo, RowResolver rowResolver, int offset) Generates an expression from the input column.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExprFactory

public ExprFactory()

Method Detail

isExprInstance

protected abstract boolean isExprInstance(Object o)

Returns whether the input is an instance of the expression class.

toExpr

protected abstract T toExpr(ColumnInfo colInfo,
                            RowResolver rowResolver,
                            int offset)
                     throws SemanticException

Generates an expression from the input column. This may not necessarily be a column expression, e.g., if the column is a constant. For position based expression factories (e.g., Calcite), an offset that will be added to the input references position can be provided. For instance, this is useful to generate expressions for right side of a join output.

Throws:

SemanticException

isColumnRefExpr

protected abstract boolean isColumnRefExpr(Object o)

Returns whether the input object is a column reference expression.

createColumnRefExpr

protected abstract T createColumnRefExpr(ColumnInfo colInfo,
                                         RowResolver rowResolver,
                                         int offset)
                                  throws SemanticException

Creates column expression. For position based expression factories (e.g., Calcite), an offset that will be added to the input references position can be provided. For instance, this is useful to generate expressions for right side of a join output.

Throws:

SemanticException

createColumnRefExpr

protected abstract T createColumnRefExpr(ColumnInfo colInfo,
                                         List<RowResolver> rowResolverList)
                                  throws SemanticException

Creates column expression.

Throws:

SemanticException

getColumnName

protected abstract String getColumnName(T expr,
                                        RowResolver rowResolver)

Returns column name referenced by a column expression.

isConstantExpr

protected abstract boolean isConstantExpr(Object o)

Returns whether the input expression is a constant expression.

isAllConstants

protected boolean isAllConstants(List<T> exprs)

Returns whether all input expressions are constant expressions.

isConstantStruct

protected abstract boolean isConstantStruct(T expr)

Returns whether the input expression is a struct of constant expressions (all of them).

createNullConstantExpr

protected abstract T createNullConstantExpr()

Creates a null constant expression with void type.

createDynamicParamExpr

protected abstract T createDynamicParamExpr(int index)

Creates a dynamic parameter expression with void type.

createBooleanConstantExpr

protected abstract T createBooleanConstantExpr(String value)

Creates a boolean constant expression from input value.

createBigintConstantExpr

protected abstract T createBigintConstantExpr(String value)

Creates a bigint constant expression from input value.

createIntConstantExpr

protected abstract T createIntConstantExpr(String value)

Creates a int constant expression from input value.

createSmallintConstantExpr

protected abstract T createSmallintConstantExpr(String value)

Creates a smallint constant expression from input value.

createTinyintConstantExpr

protected abstract T createTinyintConstantExpr(String value)

Creates a tinyint constant expression from input value.

createFloatConstantExpr

protected abstract T createFloatConstantExpr(String value)

Creates a float constant expression from input value.

createDoubleConstantExpr

protected abstract T createDoubleConstantExpr(String value)
                                       throws SemanticException

Creates a double constant expression from input value.

Throws:

SemanticException

createDecimalConstantExpr

protected abstract T createDecimalConstantExpr(String value,
                                               boolean allowNullValueConstantExpr)

Creates a decimal constant expression from input value. If the constant created from the input value is null, we return: 1) a constant expression containing null value if allowNullValueConstantExpr is true, or 2) null if allowNullValueConstantExpr is false.

createStringConstantExpr

protected abstract T createStringConstantExpr(String value)

Creates a string constant expression from input value.

createDateConstantExpr

protected abstract T createDateConstantExpr(String value)

Creates a date constant expression from input value.

createTimestampConstantExpr

protected abstract T createTimestampConstantExpr(String value)

Creates a timestamp constant expression from input value.

createTimestampLocalTimeZoneConstantExpr

protected abstract T createTimestampLocalTimeZoneConstantExpr(String value,
                                                              ZoneId zoneId)

Creates a timestamp with local time zone constant expression from input value. ZoneId is the local time zone.

createIntervalYearMonthConstantExpr

protected abstract T createIntervalYearMonthConstantExpr(String value)

Creates a interval year-month constant expression from input value.

createIntervalDayTimeConstantExpr

protected abstract T createIntervalDayTimeConstantExpr(String value)

Creates a interval day-time constant expression from input value.

createIntervalYearConstantExpr

protected abstract T createIntervalYearConstantExpr(String value)

Creates a interval year constant expression from input value.

createIntervalMonthConstantExpr

protected abstract T createIntervalMonthConstantExpr(String value)

Creates a interval month constant expression from input value.

createIntervalDayConstantExpr

protected abstract T createIntervalDayConstantExpr(String value)

Creates a interval day constant expression from input value.

createIntervalHourConstantExpr

protected abstract T createIntervalHourConstantExpr(String value)

Creates a interval hour constant expression from input value.

createIntervalMinuteConstantExpr

protected abstract T createIntervalMinuteConstantExpr(String value)

Creates a interval minute constant expression from input value.

createIntervalSecondConstantExpr

protected abstract T createIntervalSecondConstantExpr(String value)

Creates a interval second constant expression from input value.

createConstantExpr

protected T createConstantExpr(String value)
                        throws SemanticException

Default generator for constant expression when type cannot be inferred from input query.

Throws:

SemanticException

createStructExpr

protected abstract T createStructExpr(TypeInfo typeInfo,
                                      List<T> operands)
                               throws SemanticException

Creates a struct with given type.

Throws:

SemanticException

createConstantExpr

protected abstract T createConstantExpr(TypeInfo typeInfo,
                                        Object constantValue)
                                 throws SemanticException

Creates a constant expression from input value with given type.

Throws:

SemanticException

adjustConstantType

protected abstract TypeInfo adjustConstantType(PrimitiveTypeInfo targetType,
                                               Object constantValue)

Adjust type of constant value based on input type, e.g., adjust precision and scale of decimal value based on type information.

interpretConstantAsPrimitive

protected abstract Object interpretConstantAsPrimitive(PrimitiveTypeInfo targetType,
                                                       Object constantValue,
                                                       PrimitiveTypeInfo sourceType,
                                                       boolean isEqual)

Interpret the input constant value of source type as target type.

getConstantValue

protected abstract Object getConstantValue(T expr)

Returns value stored in a constant expression.

getConstantValueAsString

protected abstract String getConstantValueAsString(T expr)

Returns value stored in a constant expression as String.

createNestedColumnRefExpr

protected abstract T createNestedColumnRefExpr(TypeInfo typeInfo,
                                               T expr,
                                               String fieldName,
                                               Boolean isList)
                                        throws SemanticException

Creates a reference to a nested field.

Throws:

SemanticException

isFuncCallExpr

protected abstract boolean isFuncCallExpr(Object o)

Returns whether the input expression is a function call.

createFuncCallExpr

protected abstract T createFuncCallExpr(TypeInfo typeInfo,
                                        FunctionInfo fi,
                                        String funcText,
                                        List<T> inputs)
                                 throws SemanticException

Creates function call expression.

Throws:

SemanticException

isORFuncCallExpr

protected abstract boolean isORFuncCallExpr(T expr)

Returns whether the input expression is an OR function call.

isANDFuncCallExpr

protected abstract boolean isANDFuncCallExpr(T expr)

Returns whether the input expression is an AND function call.

isPOSITIVEFuncCallExpr

protected abstract boolean isPOSITIVEFuncCallExpr(T expr)

Returns whether the input expression is a POSITIVE function call.

isNEGATIVEFuncCallExpr

protected abstract boolean isNEGATIVEFuncCallExpr(T expr)

Returns whether the input expression is a NEGATIVE function call.

isSTRUCTFuncCallExpr

protected abstract boolean isSTRUCTFuncCallExpr(T expr)

Returns whether the input expression is a STRUCT function call.

isAndFunction

protected abstract boolean isAndFunction(FunctionInfo fi)

isOrFunction

protected abstract boolean isOrFunction(FunctionInfo fi)

isInFunction

protected abstract boolean isInFunction(FunctionInfo fi)

isCompareFunction

protected abstract boolean isCompareFunction(FunctionInfo fi)

isEqualFunction

protected abstract boolean isEqualFunction(FunctionInfo fi)

isNSCompareFunction

protected abstract boolean isNSCompareFunction(FunctionInfo fi)

isConsistentWithinQuery

protected abstract boolean isConsistentWithinQuery(FunctionInfo fi)

isStateful

protected abstract boolean isStateful(FunctionInfo fi)

convertCASEIntoCOALESCEFuncCallExpr

protected abstract boolean convertCASEIntoCOALESCEFuncCallExpr(FunctionInfo fi,
                                                               List<T> inputs)

Returns true if a CASE expression can be converted into a COALESCE function call.

convertCASEIntoIFFuncCallExpr

protected boolean convertCASEIntoIFFuncCallExpr(FunctionInfo fi,
                                                List<T> inputs)

Returns true if a CASE expression can be converted into an IF function call.

createSubqueryExpr

protected abstract T createSubqueryExpr(TypeCheckCtx ctx,
                                        ASTNode subqueryOp,
                                        SubqueryType subqueryType,
                                        Object[] inputs)
                                 throws SemanticException

Creates subquery expression.

Throws:

SemanticException

isExprsListExpr

protected abstract boolean isExprsListExpr(Object o)

Returns whether the input expression is a list of expressions.

createExprsListExpr

protected abstract T createExprsListExpr()

Creates list of expressions.

addExprToExprsList

protected abstract void addExprToExprsList(T columnList,
                                           T expr)

Adds expression to list of expressions (list needs to be mutable).

getTypeInfo

protected abstract TypeInfo getTypeInfo(T expr)

Returns the type for the input expression.

getStructTypeInfoList

protected abstract List<TypeInfo> getStructTypeInfoList(T expr)

Returns the list of types in the input struct expression.

setTypeInfo

protected abstract T setTypeInfo(T expr,
                                 TypeInfo type)
                          throws SemanticException

Changes the type of the input expression to the input type and returns resulting expression. If the input expression is mutable, it will not create a copy of the expression.

Throws:

SemanticException

foldExpr

protected abstract T foldExpr(T expr)

Folds the input expression and returns resulting expression. If the input expression is mutable, it will not create a copy of the expression.

getExprChildren

protected abstract List<T> getExprChildren(T expr)

Returns the children from the input expression (if any).

getStructNameList

protected abstract List<String> getStructNameList(T expr)

Returns the list of names in the input struct expression.

getFunctionInfo

protected abstract FunctionInfo getFunctionInfo(String funcName)
                                         throws SemanticException

Returns the FunctionInfo given the name

Throws:

SemanticException

replaceFieldNamesInStruct

protected abstract T replaceFieldNamesInStruct(T expr,
                                               List<String> newFieldNames)