org.apache.pig.scripting.js
Class JsFunction

java.lang.Object
  org.apache.pig.EvalFunc<Object>
      org.apache.pig.scripting.js.JsFunction

public class JsFunction
extends EvalFunc<Object>

Field Summary

Fields inherited from class org.apache.pig.EvalFunc

log, pigLogger, reporter, returnType

Constructor Summary

JsFunction(String functionName)

Method Summary

Object	exec(Tuple tuple) This callback method must be implemented by all subclasses.
Schema	outputSchema(Schema input) Report the schema of the output of this UDF.

Methods inherited from class org.apache.pig.EvalFunc

finish, getArgToFuncMapping, getCacheFiles, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, isAsynchronous, progress, setPigLogger, setReporter, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

JsFunction

public JsFunction(String functionName)

Method Detail

exec

public Object exec(Tuple tuple)
            throws IOException

Description copied from class: EvalFunc

This callback method must be implemented by all subclasses. This is the method that will be invoked on every Tuple of a given dataset. Since the dataset may be divided up in a variety of ways the programmer should not make assumptions about state that is maintained between invocations of this method.

Specified by:

exec in class EvalFunc<Object>

Parameters:

tuple - the Tuple to be processed.

Returns:

result, of type T.

Throws:

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.

Overrides:

outputSchema in class EvalFunc<Object>

Parameters:

input - Schema of the input

Returns:

Schema of the output