org.apache.pig.builtin

Class INDEXOF

java.lang.Object

org.apache.pig.EvalFunc<java.lang.Integer>

org.apache.pig.builtin.INDEXOF

Direct Known Subclasses:

INDEXOF

public class INDEXOF
extends EvalFunc<java.lang.Integer>

INDEXOF implements eval function to search for a string Example: A = load 'mydata' as (name); B = foreach A generate INDEXOF(name, ",");

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pig.EvalFunc

EvalFunc.SchemaType

Field Summary

Fields inherited from class org.apache.pig.EvalFunc

pigLogger, reporter, returnType

Constructor Summary

Constructors

Constructor and Description
INDEXOF()

Method Summary

Modifier and Type	Method and Description
boolean	allowCompileTimeCalculation() Whether the UDF should be evaluated at compile time if all inputs are constant.
java.lang.Integer	exec(Tuple input) Method invoked on every tuple during foreach evaluation
Schema	outputSchema(Schema input) Report the schema of the output of this UDF.

Methods inherited from class org.apache.pig.EvalFunc

finish, getArgToFuncMapping, getCacheFiles, getInputSchema, getLoadCaster, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, getSchemaType, getShipFiles, isAsynchronous, needEndOfAllInputProcessing, progress, setEndOfAllInput, setInputSchema, setPigLogger, setReporter, setUDFContextSignature, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

INDEXOF

public INDEXOF()

Method Detail

exec

public java.lang.Integer exec(Tuple input)
                       throws java.io.IOException

Method invoked on every tuple during foreach evaluation

Specified by:

exec in class EvalFunc<java.lang.Integer>

Parameters:

input - tuple; first column is assumed to have the column to convert the second column is the string we search for the third is an optional column from where to start the search

Returns:

index of first occurrence, or null in case of processing error

Throws:

java.io.IOException

outputSchema

public Schema outputSchema(Schema input)

Description copied from class: EvalFunc

Report the schema of the output of this UDF. Pig will make use of this in error checking, optimization, and planning. The schema of input data to this UDF is provided.

The default implementation interprets the OutputSchema annotation, if one is present. Otherwise, it returns null (no known output schema).

Overrides:

outputSchema in class EvalFunc<java.lang.Integer>

Parameters:

input - Schema of the input

Returns:

Schema of the output

allowCompileTimeCalculation

public boolean allowCompileTimeCalculation()

Description copied from class: EvalFunc

Whether the UDF should be evaluated at compile time if all inputs are constant. This is applicable for most UDF, however, if a UDF will access hdfs file which is not available at compile time, it has to be false

Overrides:

allowCompileTimeCalculation in class EvalFunc<java.lang.Integer>

Returns:

Whether or not compile time calculation is allowed, default to false to ensure legacy UDF will get the right behavior