org.apache.hadoop.hive.ql.udf.generic

Class GenericUDFBaseArithmetic

java.lang.Object

org.apache.hadoop.hive.ql.udf.generic.GenericUDF

org.apache.hadoop.hive.ql.udf.generic.GenericUDFBaseBinary

org.apache.hadoop.hive.ql.udf.generic.GenericUDFBaseArithmetic

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

GenericUDFOPMinus, GenericUDFOPPlus

public abstract class GenericUDFBaseArithmetic
extends GenericUDFBaseBinary

Wrapper UDF that will instantiate the proper arithmetic UDF (numeric, date, etc) depending on the argument types

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDF

GenericUDF.DeferredJavaObject, GenericUDF.DeferredObject

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ansiSqlArithmetic
protected boolean	confLookupNeeded

Fields inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDFBaseBinary

opDisplayName, opName

Constructor Summary

Constructors

Constructor and Description
GenericUDFBaseArithmetic()

Method Summary

Methods

Modifier and Type	Method and Description
void	copyToNewInstance(Object newInstance) Some information may be set during initialize() which needs to be saved when the UDF is copied.
Object	evaluate(GenericUDF.DeferredObject[] arguments) Evaluate the GenericUDF with the arguments.
ObjectInspector	initialize(ObjectInspector[] arguments) Initialize this GenericUDF.
protected abstract GenericUDF	instantiateDTIUDF() Instantiate date-time/interval version of the arithmetic UDF
protected abstract GenericUDFBaseNumeric	instantiateNumericUDF() Instantiate numeric version of the arithmetic UDF

Methods inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDFBaseBinary

getDisplayString

Methods inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDF

checkArgGroups, checkArgPrimitive, checkArgsSize, close, configure, flip, getArgOrder, getConstantIntValue, getConstantLongValue, getConstantStringValue, getDateValue, getDoubleValue, getFuncName, getIntValue, getLongValue, getRequiredFiles, getRequiredJars, getStandardDisplayString, getStandardDisplayString, getStringValue, getTimestampValue, getUdfName, initializeAndFoldConstants, negative, obtainDateConverter, obtainDoubleConverter, obtainIntConverter, obtainLongConverter, obtainStringConverter, obtainTimestampConverter

Methods inherited from class java.lang.Object

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

Field Detail

confLookupNeeded

protected boolean confLookupNeeded

ansiSqlArithmetic

protected boolean ansiSqlArithmetic

Constructor Detail

GenericUDFBaseArithmetic

public GenericUDFBaseArithmetic()

Method Detail

initialize

public ObjectInspector initialize(ObjectInspector[] arguments)
                           throws UDFArgumentException

Description copied from class: GenericUDF

Initialize this GenericUDF. This will be called once and only once per GenericUDF instance.

Specified by:

initialize in class GenericUDF

Parameters:

arguments - The ObjectInspector for the arguments

Returns:

The ObjectInspector for the return value

Throws:

UDFArgumentException - Thrown when arguments have wrong types, wrong length, etc.

evaluate

public Object evaluate(GenericUDF.DeferredObject[] arguments)
                throws HiveException

Description copied from class: GenericUDF

Evaluate the GenericUDF with the arguments.

Specified by:

evaluate in class GenericUDF

Parameters:

arguments - The arguments as DeferedObject, use DeferedObject.get() to get the actual argument Object. The Objects can be inspected by the ObjectInspectors passed in the initialize call.

Returns:

The

Throws:

HiveException

copyToNewInstance

public void copyToNewInstance(Object newInstance)
                       throws UDFArgumentException

Description copied from class: GenericUDF

Some information may be set during initialize() which needs to be saved when the UDF is copied. This will be called by FunctionRegistry.cloneGenericUDF()

Overrides:

copyToNewInstance in class GenericUDF

Throws:

UDFArgumentException

instantiateNumericUDF

protected abstract GenericUDFBaseNumeric instantiateNumericUDF()

Instantiate numeric version of the arithmetic UDF

Returns:

arithmetic UDF for numeric types

instantiateDTIUDF

protected abstract GenericUDF instantiateDTIUDF()

Instantiate date-time/interval version of the arithmetic UDF

Returns:

arithmetic UDF for date-time/interval types