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

Class GenericUDFInFile

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable

public class GenericUDFInFile
extends GenericUDF

IN_FILE(str, filename) returns true if 'str' appears in the file specified by 'filename'. A string is considered to be in the file if it that string appears as a line in the file. If either argument is NULL then NULL is returned.

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
GenericUDFInFile()

Method Summary

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

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

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

Constructor Detail

GenericUDFInFile

public GenericUDFInFile()

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.

getRequiredFiles

public String[] getRequiredFiles()

Overrides:

getRequiredFiles in class GenericUDF

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

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

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