org.apache.pig.builtin

Class FunctionWrapperEvalFunc

java.lang.Object

org.apache.pig.EvalFunc<OUT>

org.apache.pig.TypedOutputEvalFunc<OUT>

org.apache.pig.PrimitiveEvalFunc<java.lang.Object,java.lang.Object>

org.apache.pig.builtin.FunctionWrapperEvalFunc

public class FunctionWrapperEvalFunc
extends PrimitiveEvalFunc<java.lang.Object,java.lang.Object>

EvalFunc that wraps an implementation of the Function interface, which is passed as a String in the constructor. When resolving the Function class, the Pig UDF package import list is used.

The Function must have a default no-arg constructor, which will be used. For Functions that take args in the constructor, initialize the function in a subclass of this one and call super(function).

Example: DEFINE myUdf FunctionWrapperEvalFunc('MyFunction')

Nested Class Summary

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

EvalFunc.SchemaType

Field Summary

Fields inherited from class org.apache.pig.PrimitiveEvalFunc

inTypeClass

Fields inherited from class org.apache.pig.TypedOutputEvalFunc

outTypeClass

Fields inherited from class org.apache.pig.EvalFunc

log, pigLogger, reporter, returnType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FunctionWrapperEvalFunc(ExceptionalFunction function) Determines the input and output types of the Function and initializes the superclass.
protected	FunctionWrapperEvalFunc(com.google.common.base.Function function) Determines the input and output types of the Function and initializes the superclass.
	FunctionWrapperEvalFunc(java.lang.String functionClassName) Takes the class name of a Function, initializes it using the default constructor and passes it to FunctionWrapperEvalFunc(ExceptionalFunction function).

Method Summary

Modifier and Type	Method and Description
java.lang.Object	exec(java.lang.Object input)
protected java.lang.String	getCounterGroup() Incremented counters will use this as the counter group.

Methods inherited from class org.apache.pig.PrimitiveEvalFunc

exec, getInputTypeClass

Methods inherited from class org.apache.pig.TypedOutputEvalFunc

getOutputTypeClass, getTypeArguments, safeIncrCounter, verifyInput, verifyUdfInput

Methods inherited from class org.apache.pig.EvalFunc

addCredentials, allowCompileTimeCalculation, finish, getArgToFuncMapping, getCacheFiles, getInputSchema, getLoadCaster, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, getSchemaType, getShipFiles, isAsynchronous, needEndOfAllInputProcessing, outputSchema, 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

FunctionWrapperEvalFunc

public FunctionWrapperEvalFunc(java.lang.String functionClassName)
                        throws java.lang.ClassNotFoundException,
                               java.lang.NoSuchMethodException,
                               java.lang.IllegalAccessException,
                               java.lang.InstantiationException,
                               java.io.IOException

Takes the class name of a Function, initializes it using the default constructor and passes it to FunctionWrapperEvalFunc(ExceptionalFunction function). Functions must implement either com.google.common.base.Function or ExceptionalFunction.

Parameters:

functionClassName - function class to initialize

Throws:

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.InstantiationException

java.io.IOException

FunctionWrapperEvalFunc

protected FunctionWrapperEvalFunc(com.google.common.base.Function function)
                           throws java.io.IOException,
                                  java.lang.ClassNotFoundException,
                                  java.lang.NoSuchMethodException

Determines the input and output types of the Function and initializes the superclass. Subclass and call this constructor if a Function with a non-default constructor is required.

Parameters:

function - Function to be used by the UDF.

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

FunctionWrapperEvalFunc

protected FunctionWrapperEvalFunc(ExceptionalFunction function)
                           throws java.io.IOException,
                                  java.lang.ClassNotFoundException,
                                  java.lang.NoSuchMethodException

Determines the input and output types of the Function and initializes the superclass. Subclass and call this constructor if a Function with a non-default constructor is required.

Parameters:

function - Function to be used by the UDF.

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.NoSuchMethodException

Method Detail

exec

public java.lang.Object exec(java.lang.Object input)
                      throws java.io.IOException

Specified by:

exec in class PrimitiveEvalFunc<java.lang.Object,java.lang.Object>

Throws:

java.io.IOException

getCounterGroup

protected java.lang.String getCounterGroup()

Description copied from class: TypedOutputEvalFunc

Incremented counters will use this as the counter group. Typically this works fine, since the subclass name is enough to identify the UDF. In some cases though (i.e. a UDF wrapper that is a facade to a number of different transformation functions), a more specific group name is needed.

Overrides:

getCounterGroup in class TypedOutputEvalFunc<java.lang.Object>