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

java.lang.Object
  org.apache.hadoop.hive.ql.udf.generic.GenericUDF
      org.apache.hadoop.hive.ql.udf.generic.GenericUDFBaseTrim

All Implemented Interfaces:

Closeable

Direct Known Subclasses:

GenericUDFLTrim, GenericUDFRTrim, GenericUDFTrim

public abstract class GenericUDFBaseTrim
extends GenericUDF

Nested Class Summary

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

GenericUDF.DeferredJavaObject, GenericUDF.DeferredObject

Constructor Summary

GenericUDFBaseTrim(String _udfName)

Method Summary

Object	evaluate(GenericUDF.DeferredObject[] arguments) Evaluate the GenericUDF with the arguments.
String	getDisplayString(String[] children) Get the String to be displayed in explain.
ObjectInspector	initialize(ObjectInspector[] arguments) Initialize this GenericUDF.

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

close, configure, copyToNewInstance, flip, getRequiredFiles, getRequiredJars, getUdfName, initializeAndFoldConstants

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericUDFBaseTrim

public GenericUDFBaseTrim(String _udfName)

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

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