org.apache.pig.builtin

Class ARITY

java.lang.Object

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

org.apache.pig.builtin.ARITY

Deprecated.

Use SIZE instead.

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

Find the number of fields in a tuple. Expected input is a tuple, output is an integer.

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

log, pigLogger, reporter, returnType

Constructor Summary

Constructors

Constructor and Description
ARITY() Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	allowCompileTimeCalculation() Deprecated. Whether the UDF should be evaluated at compile time if all inputs are constant.
java.lang.Integer	exec(Tuple input) Deprecated. This callback method must be implemented by all subclasses.
Schema	outputSchema(Schema input) Deprecated. 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

ARITY

public ARITY()

Deprecated.

Method Detail

exec

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

Deprecated.

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<java.lang.Integer>

Parameters:

input - the Tuple to be processed.

Returns:

result, of type T.

Throws:

java.io.IOException

outputSchema

public Schema outputSchema(Schema input)

Deprecated.

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

Deprecated.

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