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

Class HiveFunctionHelper

java.lang.Object

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

All Implemented Interfaces:

FunctionHelper

public class HiveFunctionHelper
extends Object
implements FunctionHelper

Function helper for Hive.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hive.ql.parse.type.FunctionHelper

FunctionHelper.AggregateInfo, FunctionHelper.FieldCollation

Constructor Summary

Constructors

Constructor and Description
HiveFunctionHelper(org.apache.calcite.rex.RexBuilder rexBuilder)

Method Summary

Modifier and Type	Method and Description
List<org.apache.calcite.rex.RexNode>	convertInputs(FunctionInfo fi, List<org.apache.calcite.rex.RexNode> inputs, org.apache.calcite.rel.type.RelDataType returnType) Given function information, the inputs to that function, and the expected return type, it will return the list of inputs with any necessary adjustments, e.g., casting of expressions.
org.apache.calcite.rex.RexNode	foldExpression(org.apache.calcite.rex.RexNode expr) Folds expression according to function semantics.
FunctionHelper.AggregateInfo	getAggregateFunctionInfo(boolean isDistinct, boolean isAllColumns, String aggregateName, List<org.apache.calcite.rex.RexNode> aggregateParameters, List<FunctionHelper.FieldCollation> fieldCollations) Returns aggregation information based on given parameters.
org.apache.calcite.rex.RexNode	getExpression(String functionText, FunctionInfo fi, List<org.apache.calcite.rex.RexNode> inputs, org.apache.calcite.rel.type.RelDataType returnType) Given function information and text, inputs to a function, and the expected return type, it will return an expression node containing the function call.
FunctionInfo	getFunctionInfo(String functionText) Returns function information based on function text.
org.apache.calcite.rel.type.RelDataType	getReturnType(FunctionInfo fi, List<org.apache.calcite.rex.RexNode> inputs) Given function information and its inputs, it returns the type of the output of the function.
org.apache.calcite.rex.RexCall	getUDTFFunction(String functionName, List<org.apache.calcite.rex.RexNode> operands) Returns RexCall for UDTF from the appropriate function registry based on given parameters
FunctionHelper.AggregateInfo	getWindowAggregateFunctionInfo(boolean isDistinct, boolean isAllColumns, String aggregateName, List<org.apache.calcite.rex.RexNode> aggregateParameters) Returns aggregation information for analytical function based on given parameters.
boolean	isAndFunction(FunctionInfo fi) returns true if FunctionInfo is an And function.
boolean	isCompareFunction(FunctionInfo fi) returns true if FunctionInfo is a compare function (e.g.
boolean	isConsistentWithinQuery(FunctionInfo fi) Returns whether the expression, for a single query, returns the same result given the same arguments/children.
boolean	isEqualFunction(FunctionInfo fi) returns true if FunctionInfo is an == function.
boolean	isInFunction(FunctionInfo fi) returns true if FunctionInfo is an In function.
boolean	isNSCompareFunction(FunctionInfo fi)
boolean	isOrFunction(FunctionInfo fi) returns true if FunctionInfo is an Or function.
boolean	isStateful(FunctionInfo fi) returns true if FunctionInfo is a stateful function.

Methods inherited from class java.lang.Object

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

Constructor Detail

HiveFunctionHelper

public HiveFunctionHelper(org.apache.calcite.rex.RexBuilder rexBuilder)

Method Detail

getFunctionInfo

public FunctionInfo getFunctionInfo(String functionText)
                             throws SemanticException

Returns function information based on function text.

Specified by:

getFunctionInfo in interface FunctionHelper

Throws:

SemanticException

getReturnType

public org.apache.calcite.rel.type.RelDataType getReturnType(FunctionInfo fi,
                                                             List<org.apache.calcite.rex.RexNode> inputs)
                                                      throws SemanticException

Given function information and its inputs, it returns the type of the output of the function.

Specified by:

getReturnType in interface FunctionHelper

Throws:

SemanticException

convertInputs

public List<org.apache.calcite.rex.RexNode> convertInputs(FunctionInfo fi,
                                                          List<org.apache.calcite.rex.RexNode> inputs,
                                                          org.apache.calcite.rel.type.RelDataType returnType)
                                                   throws SemanticException

Given function information, the inputs to that function, and the expected return type, it will return the list of inputs with any necessary adjustments, e.g., casting of expressions.

Specified by:

convertInputs in interface FunctionHelper

Throws:

SemanticException

getExpression

public org.apache.calcite.rex.RexNode getExpression(String functionText,
                                                    FunctionInfo fi,
                                                    List<org.apache.calcite.rex.RexNode> inputs,
                                                    org.apache.calcite.rel.type.RelDataType returnType)
                                             throws SemanticException

Given function information and text, inputs to a function, and the expected return type, it will return an expression node containing the function call.

Specified by:

getExpression in interface FunctionHelper

Throws:

SemanticException

getAggregateFunctionInfo

public FunctionHelper.AggregateInfo getAggregateFunctionInfo(boolean isDistinct,
                                                             boolean isAllColumns,
                                                             String aggregateName,
                                                             List<org.apache.calcite.rex.RexNode> aggregateParameters,
                                                             List<FunctionHelper.FieldCollation> fieldCollations)
                                                      throws SemanticException

Returns aggregation information based on given parameters.

Specified by:

getAggregateFunctionInfo in interface FunctionHelper

Throws:

SemanticException

getWindowAggregateFunctionInfo

public FunctionHelper.AggregateInfo getWindowAggregateFunctionInfo(boolean isDistinct,
                                                                   boolean isAllColumns,
                                                                   String aggregateName,
                                                                   List<org.apache.calcite.rex.RexNode> aggregateParameters)
                                                            throws SemanticException

Returns aggregation information for analytical function based on given parameters.

Specified by:

getWindowAggregateFunctionInfo in interface FunctionHelper

Throws:

SemanticException

getUDTFFunction

public org.apache.calcite.rex.RexCall getUDTFFunction(String functionName,
                                                      List<org.apache.calcite.rex.RexNode> operands)
                                               throws SemanticException

Description copied from interface: FunctionHelper

Returns RexCall for UDTF from the appropriate function registry based on given parameters

Specified by:

getUDTFFunction in interface FunctionHelper

Throws:

SemanticException

foldExpression

public org.apache.calcite.rex.RexNode foldExpression(org.apache.calcite.rex.RexNode expr)

Folds expression according to function semantics.

Specified by:

foldExpression in interface FunctionHelper

isAndFunction

public boolean isAndFunction(FunctionInfo fi)

returns true if FunctionInfo is an And function.

Specified by:

isAndFunction in interface FunctionHelper

isOrFunction

public boolean isOrFunction(FunctionInfo fi)

returns true if FunctionInfo is an Or function.

Specified by:

isOrFunction in interface FunctionHelper

isInFunction

public boolean isInFunction(FunctionInfo fi)

returns true if FunctionInfo is an In function.

Specified by:

isInFunction in interface FunctionHelper

isCompareFunction

public boolean isCompareFunction(FunctionInfo fi)

returns true if FunctionInfo is a compare function (e.g. '<=')

Specified by:

isCompareFunction in interface FunctionHelper

isEqualFunction

public boolean isEqualFunction(FunctionInfo fi)

returns true if FunctionInfo is an == function.

Specified by:

isEqualFunction in interface FunctionHelper

isNSCompareFunction

public boolean isNSCompareFunction(FunctionInfo fi)

Specified by:

isNSCompareFunction in interface FunctionHelper

isConsistentWithinQuery

public boolean isConsistentWithinQuery(FunctionInfo fi)

Returns whether the expression, for a single query, returns the same result given the same arguments/children. This includes deterministic functions as well as runtime constants (which may not be deterministic across queries).

Specified by:

isConsistentWithinQuery in interface FunctionHelper

isStateful

public boolean isStateful(FunctionInfo fi)

returns true if FunctionInfo is a stateful function.

Specified by:

isStateful in interface FunctionHelper