org.apache.pig.piggybank.evaluation

Class MaxTupleBy1stField

java.lang.Object

org.apache.pig.EvalFunc<Tuple>

org.apache.pig.piggybank.evaluation.MaxTupleBy1stField

All Implemented Interfaces:

Accumulator<Tuple>, Algebraic

public class MaxTupleBy1stField
extends EvalFunc<Tuple>
implements Algebraic, Accumulator<Tuple>

MaxTupleBy1stField UDF returns a tuple with max value of the first field in a given bag. Caveat: first field assumed to have type 'long'. You may need to enforece this via schema when loading data, as sown in sample usage below. Sample usage: A = load 'test.tsv' as (first: long, second, third); B = GROUP A by second; C = FOREACH B GENERATE group, MaxTupleBy1stField(A);

Author:

Vadim Zaliva

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaxTupleBy1stField.Final
static class	MaxTupleBy1stField.Initial
static class	MaxTupleBy1stField.Intermediate

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

Method Summary

Modifier and Type	Method and Description
void	accumulate(Tuple b) Accumulate implementation - calls max() on the incoming tuple set including intermediate tuple if already exists
void	cleanup() Called after getValue() to prepare processing for next key.
Tuple	exec(Tuple input) This callback method must be implemented by all subclasses.
java.lang.String	getFinal() Get the final function.
java.lang.String	getInitial() Get the initial function.
java.lang.String	getIntermed() Get the intermediate function.
Tuple	getValue() Called when all tuples from current key have been passed to accumulate.
protected static Tuple	max(DataBag values, PigProgressable reporter)
protected static Tuple	max(Tuple input, PigProgressable reporter)
Schema	outputSchema(Schema input) Report the schema of the output of this UDF.

Methods inherited from class org.apache.pig.EvalFunc

allowCompileTimeCalculation, 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

MaxTupleBy1stField

public MaxTupleBy1stField()

Method Detail

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<Tuple>

Parameters:

input - Schema of the input

Returns:

Schema of the output

exec

public Tuple exec(Tuple input)
           throws java.io.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<Tuple>

Parameters:

input - the Tuple to be processed.

Returns:

result, of type T.

Throws:

java.io.IOException

max

protected static Tuple max(Tuple input,
                           PigProgressable reporter)
                    throws ExecException

Throws:

ExecException

max

protected static Tuple max(DataBag values,
                           PigProgressable reporter)
                    throws ExecException

Throws:

ExecException

getInitial

public java.lang.String getInitial()

Description copied from interface: Algebraic

Get the initial function.

Specified by:

getInitial in interface Algebraic

Returns:

A function name of f_init. f_init should be an eval func. The return type of f_init.exec() has to be Tuple

getIntermed

public java.lang.String getIntermed()

Description copied from interface: Algebraic

Get the intermediate function.

Specified by:

getIntermed in interface Algebraic

Returns:

A function name of f_intermed. f_intermed should be an eval func. The return type of f_intermed.exec() has to be Tuple

getFinal

public java.lang.String getFinal()

Description copied from interface: Algebraic

Get the final function.

Specified by:

getFinal in interface Algebraic

Returns:

A function name of f_final. f_final should be an eval func parametrized by the same datum as the eval func implementing this interface.

accumulate

public void accumulate(Tuple b)
                throws java.io.IOException

Accumulate implementation - calls max() on the incoming tuple set including intermediate tuple if already exists

Specified by:

accumulate in interface Accumulator<Tuple>

Parameters:

b - A tuple containing a single field, which is a bag. The bag will contain the set

Throws:

java.io.IOException

getValue

public Tuple getValue()

Description copied from interface: Accumulator

Called when all tuples from current key have been passed to accumulate.

Specified by:

getValue in interface Accumulator<Tuple>

Returns:

the value for the UDF for this key.

cleanup

public void cleanup()

Description copied from interface: Accumulator

Called after getValue() to prepare processing for next key.

Specified by:

cleanup in interface Accumulator<Tuple>