org.apache.pig.builtin

Class GenericInvoker<T>

java.lang.Object

org.apache.pig.EvalFunc<T>

org.apache.pig.builtin.GenericInvoker<T>

Type Parameters:

T -

Direct Known Subclasses:

InvokeForDouble, InvokeForFloat, InvokeForInt, InvokeForLong, InvokeForString

public abstract class GenericInvoker<T>
extends EvalFunc<T>

The generic Invoker class does all the common grunt work of setting up an invoker. Class-specific non-generic extensions of this class are needed for Pig to know what type of return to expect from exec, and to find the appropriate classes through reflection. All they have to do is implement the constructors that call into super(). Note that the no-parameter constructor is required, if seemingly nonsensical, for Pig to do its work.

The Invoker family of udfs understand the following class names (all case-independent):

String Long Float Double Int

Invokers can also work with array arguments, represented in Pig as DataBags of single-tuple elements. Simply refer to string[], for example.

This UDF allows one to dynamically invoke Java methods that return a T

Usage of the Invoker family of UDFs (adjust as appropriate):

 
 -- invoking a static method
 DEFINE StringToLong InvokeForLong('java.lang.Long.valueOf', 'String')
 longs = FOREACH strings GENERATE StringToLong(some_chararray);

 -- invoking a method on an object
 DEFINE StringConcat InvokeForString('java.lang.String.concat', 'String String', 'false')
 concatenations = FOREACH strings GENERATE StringConcat(str1, str2); 
 
 

The first argument to the constructor is the full path to desired method.
The second argument is a list of classes of the method parameters.
If the method is not static, the first element in this list is the object to invoke the method on.
The second argument is optional (a no-argument static method is assumed if it is not supplied).
The third argument is the keyword "static" (or "true") to signify that the method is static.
The third argument is optional, and true by default.