org.apache.hadoop.hive.ql.udf.generic

Class GenericUDAFAverage.GenericUDAFAverageEvaluatorDecimal

java.lang.Object

org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator

org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.GenericUDAFAverageEvaluatorDecimal

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

GenericUDAFAverage

public static class GenericUDAFAverage.GenericUDAFAverageEvaluatorDecimal
extends GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator

GenericUDAFEvaluator.AbstractAggregationBuffer, GenericUDAFEvaluator.AggregationBuffer, GenericUDAFEvaluator.AggregationType, GenericUDAFEvaluator.Mode

Field Summary

Fields inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator

avgDistinct, copiedOI, inputOI, isWindowing, partialResult, sumFieldOI

Fields inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator

partitionEvaluator

Constructor Summary

Constructors

Constructor and Description
GenericUDAFAverageEvaluatorDecimal()

Method Summary

Modifier and Type	Method and Description
protected BasePartitionEvaluator	createPartitionEvaluator(WindowFrameDef winFrame, PTFPartition partition, List<PTFExpressionDef> parameters, ObjectInspector outputOI, boolean nullsLast) This class needs to be overridden by the child class to implement function specific evaluator.
static DecimalTypeInfo	deriveResultDecimalTypeInfo(int precision, int scale, GenericUDAFEvaluator.Mode mode)
protected void	doIterate(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation, PrimitiveObjectInspector oi, Object parameter)
protected void	doMerge(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation, Long partialCount, ObjectInspector sumFieldOI, Object partialSum)
protected void	doMergeAdd(HiveDecimal sum, ObjectInspectorUtils.ObjectInspectorObject obj)
void	doReset(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation)
protected Object	doTerminate(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation)
protected void	doTerminatePartial(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation)
GenericUDAFEvaluator.AggregationBuffer	getNewAggregationBuffer() Get a new aggregation object.
protected ObjectInspector	getSumFieldJavaObjectInspector()
protected ObjectInspector	getSumFieldWritableObjectInspector()
GenericUDAFEvaluator	getWindowingEvaluator(WindowFrameDef wFrameDef) When evaluating an aggregates over a fixed Window, the naive way to compute results is to compute the aggregate for each row.
ObjectInspector	init(GenericUDAFEvaluator.Mode m, ObjectInspector[] parameters) Initialize the evaluator.

Methods inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator

isWindowingDistinct, iterate, merge, reset, terminate, terminatePartial

Methods inherited from class org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator

aggregate, close, configure, estimate, evaluate, getExprString, getPartitionWindowingEvaluator, isEstimable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericUDAFAverageEvaluatorDecimal

public GenericUDAFAverageEvaluatorDecimal()

Method Detail

init

public ObjectInspector init(GenericUDAFEvaluator.Mode m,
                            ObjectInspector[] parameters)
                     throws HiveException

Description copied from class: GenericUDAFEvaluator

Initialize the evaluator.

Overrides:

init in class GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

Parameters:

m - The mode of aggregation.

parameters - The ObjectInspector for the parameters: In PARTIAL1 and COMPLETE mode, the parameters are original data; In PARTIAL2 and FINAL mode, the parameters are just partial aggregations (in that case, the array will always have a single element).

Returns:

The ObjectInspector for the return value. In PARTIAL1 and PARTIAL2 mode, the ObjectInspector for the return value of terminatePartial() call; In FINAL and COMPLETE mode, the ObjectInspector for the return value of terminate() call. NOTE: We need ObjectInspector[] (in addition to the TypeInfo[] in GenericUDAFResolver) for 2 reasons: 1. ObjectInspector contains more information than TypeInfo; and GenericUDAFEvaluator.init at execution time. 2. We call GenericUDAFResolver.getEvaluator at compilation time,

Throws:

HiveException

doReset

public void doReset(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation)
             throws HiveException

Specified by:

doReset in class GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

Throws:

HiveException

getSumFieldJavaObjectInspector

protected ObjectInspector getSumFieldJavaObjectInspector()

Specified by:

getSumFieldJavaObjectInspector in class GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

getSumFieldWritableObjectInspector

protected ObjectInspector getSumFieldWritableObjectInspector()

Specified by:

getSumFieldWritableObjectInspector in class GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

deriveResultDecimalTypeInfo

public static DecimalTypeInfo deriveResultDecimalTypeInfo(int precision,
                                                          int scale,
                                                          GenericUDAFEvaluator.Mode mode)

doIterate

protected void doIterate(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation,
                         PrimitiveObjectInspector oi,
                         Object parameter)

Specified by:

doIterate in class GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

doMerge

protected void doMerge(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation,
                       Long partialCount,
                       ObjectInspector sumFieldOI,
                       Object partialSum)

Specified by:

doMerge in class GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

doMergeAdd

protected void doMergeAdd(HiveDecimal sum,
                          ObjectInspectorUtils.ObjectInspectorObject obj)

Specified by:

doMergeAdd in class GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

doTerminatePartial

protected void doTerminatePartial(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation)

Specified by:

doTerminatePartial in class GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

doTerminate

protected Object doTerminate(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFAverage.AverageAggregationBuffer<HiveDecimal> aggregation)

Specified by:

doTerminate in class GenericUDAFAverage.AbstractGenericUDAFAverageEvaluator<HiveDecimal>

getNewAggregationBuffer

public GenericUDAFEvaluator.AggregationBuffer getNewAggregationBuffer()
                                                               throws HiveException

Description copied from class: GenericUDAFEvaluator

Get a new aggregation object.

Specified by:

getNewAggregationBuffer in class GenericUDAFEvaluator

Throws:

HiveException

getWindowingEvaluator

public GenericUDAFEvaluator getWindowingEvaluator(WindowFrameDef wFrameDef)

Description copied from class: GenericUDAFEvaluator

When evaluating an aggregates over a fixed Window, the naive way to compute results is to compute the aggregate for each row. But often there is a way to compute results in a more efficient manner. This method enables the basic evaluator to provide a function object that does the job in a more efficient manner.

This method is called after this Evaluator is initialized. The returned Function must be initialized. It is passed the 'window' of aggregation for each row.

Overrides:

getWindowingEvaluator in class GenericUDAFEvaluator

Parameters:

wFrameDef - the Window definition in play for this evaluation.

Returns:

null implies that this fn cannot be processed in Streaming mode. So each row is evaluated independently.

createPartitionEvaluator

protected BasePartitionEvaluator createPartitionEvaluator(WindowFrameDef winFrame,
                                                          PTFPartition partition,
                                                          List<PTFExpressionDef> parameters,
                                                          ObjectInspector outputOI,
                                                          boolean nullsLast)

Description copied from class: GenericUDAFEvaluator

This class needs to be overridden by the child class to implement function specific evaluator.

Overrides:

createPartitionEvaluator in class GenericUDAFEvaluator