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

Class BaseMaskUDF

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

GenericUDFMask, GenericUDFMaskFirstN, GenericUDFMaskHash, GenericUDFMaskLastN, GenericUDFMaskShowFirstN, GenericUDFMaskShowLastN

public abstract class BaseMaskUDF
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 String	displayName
protected org.apache.hadoop.hive.ql.udf.generic.AbstractTransformer	transformer
protected org.apache.hadoop.hive.ql.udf.generic.AbstractTransformerAdapter	transformerAdapter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseMaskUDF(org.apache.hadoop.hive.ql.udf.generic.AbstractTransformer transformer, String displayName)

Method Summary

Modifier and Type	Method and Description
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

checkArgGroups, checkArgPrimitive, checkArgsSize, close, configure, copyToNewInstance, flip, getArgOrder, getConstantBooleanValue, getConstantIntValue, getConstantStringValue, getDateValue, getDoubleValue, getFuncName, getIntervalDayTimeValue, getIntervalYearMonthValue, 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

transformer

protected final org.apache.hadoop.hive.ql.udf.generic.AbstractTransformer transformer

displayName

protected final String displayName

transformerAdapter

protected org.apache.hadoop.hive.ql.udf.generic.AbstractTransformerAdapter transformerAdapter

Constructor Detail

BaseMaskUDF

protected BaseMaskUDF(org.apache.hadoop.hive.ql.udf.generic.AbstractTransformer transformer,
                      String displayName)

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