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

Class GenericUDFCurrentDate

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable

public class GenericUDFCurrentDate
extends GenericUDF

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 DateWritable	currentDate

Constructor Summary

Constructors

Constructor and Description
GenericUDFCurrentDate()

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.
DateWritable	getCurrentDate()
String	getDisplayString(String[] children) Get the String to be displayed in explain.
ObjectInspector	initialize(ObjectInspector[] arguments) Initialize this GenericUDF.
void	setCurrentDate(DateWritable currentDate)

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

currentDate

protected DateWritable currentDate

Constructor Detail

GenericUDFCurrentDate

public GenericUDFCurrentDate()

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

getCurrentDate

public DateWritable getCurrentDate()

setCurrentDate

public void setCurrentDate(DateWritable currentDate)

getDisplayString

public String getDisplayString(String[] children)

Description copied from class: GenericUDF

Get the String to be displayed in explain.

Specified by:

getDisplayString in class GenericUDF

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