org.apache.datasketches.pig.theta

Class SketchToString

java.lang.Object

org.apache.pig.EvalFunc<String>

org.apache.datasketches.pig.theta.SketchToString

public class SketchToString
extends org.apache.pig.EvalFunc<String>

This is a User Defined Function (UDF) for "pretty printing" the summary of a sketch from a Sketch Tuple.

Refer to DataToSketch.exec(Tuple) for the definition of a Sketch Tuple.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pig.EvalFunc

org.apache.pig.EvalFunc.SchemaType

Field Summary

Fields inherited from class org.apache.pig.EvalFunc

log, pigLogger, reporter, returnType

Constructor Summary

Constructors

Constructor and Description
SketchToString() Pretty prints only the sketch summary.
SketchToString(boolean outputDetail, long seed) Pretty prints all bucket detail plus the sketch summary based on outputDetail.
SketchToString(String outputDetailStr) Pretty prints all bucket detail plus the sketch summary based on outputDetail.
SketchToString(String outputDetailStr, String seedStr) Pretty prints all bucket detail plus the sketch summary based on outputDetail.

Method Summary

Modifier and Type	Method and Description
String	exec(org.apache.pig.data.Tuple sketchTuple)

Methods inherited from class org.apache.pig.EvalFunc

allowCompileTimeCalculation, finish, getArgToFuncMapping, getCacheFiles, getInputSchema, getLoadCaster, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, getSchemaType, getShipFiles, isAsynchronous, needEndOfAllInputProcessing, outputSchema, 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

SketchToString

public SketchToString()

Pretty prints only the sketch summary.

SketchToString

public SketchToString(String outputDetailStr)

Pretty prints all bucket detail plus the sketch summary based on outputDetail.

Parameters:

outputDetailStr - If the first character is a "T" or "t" the output will include the bucket detail. Otherwise only the sketch summary will be output.

SketchToString

public SketchToString(String outputDetailStr,
                      String seedStr)

Pretty prints all bucket detail plus the sketch summary based on outputDetail.

Parameters:

outputDetailStr - If the first character is a "T" or "t" the output will include the bucket detail. Otherwise only the sketch summary will be output.

seedStr - the seed string

SketchToString

public SketchToString(boolean outputDetail,
                      long seed)

Pretty prints all bucket detail plus the sketch summary based on outputDetail.

Parameters:

outputDetail - If the first character is a "T" or "t" the output will include the bucket detail. Otherwise only the sketch summary will be output.

seed - the seed string

Method Detail

exec

public String exec(org.apache.pig.data.Tuple sketchTuple)
            throws IOException

Specified by:

exec in class org.apache.pig.EvalFunc<String>

Throws:

IOException