org.apache.pig.builtin

Class SPRINTF

java.lang.Object

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

org.apache.pig.builtin.SPRINTF

public class SPRINTF
extends EvalFunc<java.lang.String>

Formatted strings using java.util.Formatter See http://docs.oracle.com/javase/7/docs/api/java/util/Formatter.html ex: SPRINTF('%2$10s %1$-17s %2$,10d %2$8x %3$10.3f %4$1TFT%

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

Method Summary

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

SPRINTF

public SPRINTF()

Method Detail

exec

public java.lang.String 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<java.lang.String>

Parameters:

input - the Tuple to be processed.

Returns:

result, of type T.

Throws:

java.io.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.

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.String>

Parameters:

input - Schema of the input

Returns:

Schema of the output

getSchemaType

public EvalFunc.SchemaType getSchemaType()

Description copied from class: EvalFunc

Returns the EvalFunc.SchemaType of the EvalFunc. User defined functions can override this method to return EvalFunc.SchemaType.VARARG. In this case the last FieldSchema added to the Schema in EvalFunc.getArgToFuncMapping() will be considered as a vararg field.

Overrides:

getSchemaType in class EvalFunc<java.lang.String>

Returns:

the schema type of the UDF

allowCompileTimeCalculation

public boolean allowCompileTimeCalculation()

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.String>

Returns:

Whether or not compile time calculation is allowed, default to false to ensure legacy UDF will get the right behavior