org.apache.datasketches.pig.cpc

Class SketchToString

java.lang.Object

org.apache.pig.EvalFunc<String>

org.apache.datasketches.pig.cpc.SketchToString

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

This is a User Defined Function (UDF) for printing a human-readable summary of a given CpcSketch

Author:

Alexander Saydakov

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() Prints only the sketch summary using the default seed.
SketchToString(String isDetailed) Prints the summary and details using the default seed.
SketchToString(String isDetailed, String seed) Prints the summary and details using a given seed.

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

Prints only the sketch summary using the default seed.

SketchToString

public SketchToString(String isDetailed)

Prints the summary and details using the default seed.

Parameters:

isDetailed - flag to print the sketch detail

SketchToString

public SketchToString(String isDetailed,
                      String seed)

Prints the summary and details using a given seed.

Parameters:

isDetailed - flag to print the sketch detail

seed - parameter for the hash function

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