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

Class GenericUDFToVarchar

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable, SettableUDF

public class GenericUDFToVarchar
extends GenericUDF
implements SettableUDF, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

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

GenericUDF.DeferredJavaObject, GenericUDF.DeferredObject

Constructor Summary

Constructors

Constructor and Description
GenericUDFToVarchar()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	evaluate(GenericUDF.DeferredObject[] arguments) Evaluate the GenericUDF with the arguments.
java.lang.String	getDisplayString(java.lang.String[] children) Get the String to be displayed in explain.
java.lang.Object	getParams()
ObjectInspector	initialize(ObjectInspector[] arguments) Initialize this GenericUDF.
void	setParams(java.lang.Object typeParams) Provide varchar type parameters for the output object inspector.

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

close, configure, getRequiredFiles, getRequiredJars, initializeAndFoldConstants

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericUDFToVarchar

public GenericUDFToVarchar()

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 java.lang.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

getDisplayString

public java.lang.String getDisplayString(java.lang.String[] children)

Description copied from class: GenericUDF

Get the String to be displayed in explain.

Specified by:

getDisplayString in class GenericUDF

setParams

public void setParams(java.lang.Object typeParams)
               throws UDFArgumentException

Provide varchar type parameters for the output object inspector. This should be done before the UDF is initialized.

Specified by:

setParams in interface SettableUDF

Parameters:

typeParams - UDF-specific data to add to the UDF

Throws:

UDFArgumentException

getParams

public java.lang.Object getParams()

Specified by:

getParams in interface SettableUDF