org.apache.datasketches.pig.tuple

Class UnionSketch<S extends org.apache.datasketches.tuple.Summary>

java.lang.Object

org.apache.pig.EvalFunc<org.apache.pig.data.Tuple>

org.apache.datasketches.pig.tuple.UnionSketch<S>

Type Parameters:

S - Summary type

All Implemented Interfaces:

org.apache.pig.Accumulator<org.apache.pig.data.Tuple>

Direct Known Subclasses:

UnionDoubleSummarySketch

public abstract class UnionSketch<S extends org.apache.datasketches.tuple.Summary>
extends org.apache.pig.EvalFunc<org.apache.pig.data.Tuple>
implements org.apache.pig.Accumulator<org.apache.pig.data.Tuple>

This is a generic implementation to be specialized in concrete UDFs

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
UnionSketch(int sketchSize, org.apache.datasketches.tuple.SummarySetOperations<S> summarySetOps, org.apache.datasketches.tuple.SummaryDeserializer<S> summaryDeserializer) Constructs a function given a sketch size, summary set operations and summary deserializer
UnionSketch(org.apache.datasketches.tuple.SummarySetOperations<S> summarySetOps, org.apache.datasketches.tuple.SummaryDeserializer<S> summaryDeserializer) Constructs a function given a summary set operations, summary deserializer and default sketch size

Method Summary

Modifier and Type	Method and Description
void	accumulate(org.apache.pig.data.Tuple inputTuple)
void	cleanup()
org.apache.pig.data.Tuple	exec(org.apache.pig.data.Tuple inputTuple)
org.apache.pig.data.Tuple	getValue()

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

UnionSketch

public UnionSketch(org.apache.datasketches.tuple.SummarySetOperations<S> summarySetOps,
                   org.apache.datasketches.tuple.SummaryDeserializer<S> summaryDeserializer)

Constructs a function given a summary set operations, summary deserializer and default sketch size

Parameters:

summarySetOps - an instance of SummarySetOperations

summaryDeserializer - an instance of SummaryDeserializer

UnionSketch

public UnionSketch(int sketchSize,
                   org.apache.datasketches.tuple.SummarySetOperations<S> summarySetOps,
                   org.apache.datasketches.tuple.SummaryDeserializer<S> summaryDeserializer)

Constructs a function given a sketch size, summary set operations and summary deserializer

Parameters:

sketchSize - parameter controlling the size of the sketch and the accuracy. It represents nominal number of entries in the sketch. Forced to the nearest power of 2 greater than given value.

summarySetOps - an instance of SummarySetOperations

summaryDeserializer - an instance of SummaryDeserializer

Method Detail

exec

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

Specified by:

exec in class org.apache.pig.EvalFunc<org.apache.pig.data.Tuple>

Throws:

IOException

accumulate

public void accumulate(org.apache.pig.data.Tuple inputTuple)
                throws IOException

Specified by:

accumulate in interface org.apache.pig.Accumulator<org.apache.pig.data.Tuple>

Throws:

IOException

getValue

public org.apache.pig.data.Tuple getValue()

Specified by:

getValue in interface org.apache.pig.Accumulator<org.apache.pig.data.Tuple>

cleanup

public void cleanup()

Specified by:

cleanup in interface org.apache.pig.Accumulator<org.apache.pig.data.Tuple>