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

Class GenericUDFBridge

java.lang.Object

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

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

All Implemented Interfaces:

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

public class GenericUDFBridge
extends GenericUDF
implements java.io.Serializable

GenericUDFBridge encapsulates UDF to provide the same interface as GenericUDF. Note that GenericUDFBridge implements Serializable because the name of the UDF class needs to be serialized with the plan.

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
GenericUDFBridge()
GenericUDFBridge(java.lang.String udfName, boolean isOperator, java.lang.Class<? extends UDF> udfClass) Greate a new GenericUDFBridge object.

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.String[]	getRequiredFiles()
java.lang.String[]	getRequiredJars() The following two functions can be overridden to automatically include additional resources required by this UDF.
java.lang.Class<? extends UDF>	getUdfClass()
java.lang.String	getUdfClassName()
java.lang.String	getUdfName()
ObjectInspector	initialize(ObjectInspector[] arguments) Initialize this GenericUDF.
boolean	isOperator()
void	setOperator(boolean isOperator)
void	setUdfClass(java.lang.Class<? extends UDF> udfClass)
void	setUdfClassName(java.lang.String udfClassName)
void	setUdfName(java.lang.String udfName)

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

close, configure, initializeAndFoldConstants

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericUDFBridge

public GenericUDFBridge(java.lang.String udfName,
                        boolean isOperator,
                        java.lang.Class<? extends UDF> udfClass)

Greate a new GenericUDFBridge object.

Parameters:

udfName - The name of the corresponding udf.

isOperator -

udfClass -

GenericUDFBridge

public GenericUDFBridge()

Method Detail

setUdfName

public void setUdfName(java.lang.String udfName)

getUdfName

public java.lang.String getUdfName()

getUdfClassName

public java.lang.String getUdfClassName()

setUdfClassName

public void setUdfClassName(java.lang.String udfClassName)

isOperator

public boolean isOperator()

setOperator

public void setOperator(boolean isOperator)

setUdfClass

public void setUdfClass(java.lang.Class<? extends UDF> udfClass)

getUdfClass

public java.lang.Class<? extends UDF> getUdfClass()

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

getRequiredJars

public java.lang.String[] getRequiredJars()

Description copied from class: GenericUDF

The following two functions can be overridden to automatically include additional resources required by this UDF. The return types should be arrays of paths.

Overrides:

getRequiredJars in class GenericUDF

getRequiredFiles

public java.lang.String[] getRequiredFiles()

Overrides:

getRequiredFiles in class GenericUDF