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

Class GenericUDAFRank.GenericUDAFHypotheticalSetRankEvaluator

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

GenericUDAFCumeDist.GenericUDAFHypotheticalSetCumeDistEvaluator, GenericUDAFDenseRank.GenericUDAFHypotheticalSetDenseRankEvaluator, GenericUDAFPercentRank.GenericUDAFHypotheticalSetPercentRankEvaluator

Enclosing class:

GenericUDAFRank

public static class GenericUDAFRank.GenericUDAFHypotheticalSetRankEvaluator
extends GenericUDAFEvaluator

Hypothetical rank calculation. Calculates the rank of a hypothetical row specified by the arguments of the function in a group of values specified by the order by clause. SELECT rank(expression1[, expressionn]*) WITHIN GROUP (ORDER BY col1[, coln]*) (the number of rows where col1 < expression1 [and coln < expressionn]*) + 1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GenericUDAFRank.GenericUDAFHypotheticalSetRankEvaluator.CompareResult
protected static class	GenericUDAFRank.GenericUDAFHypotheticalSetRankEvaluator.HypotheticalSetRankBuffer
protected static class	GenericUDAFRank.GenericUDAFHypotheticalSetRankEvaluator.RankAssets

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

Modifier and Type	Field and Description
static String	COUNT_FIELD
static ObjectInspector	PARTIAL_RANK_OI
static String	RANK_FIELD

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

partitionEvaluator

Constructor Summary

Constructors

Constructor and Description
GenericUDAFHypotheticalSetRankEvaluator()
GenericUDAFHypotheticalSetRankEvaluator(boolean allowEquality, ObjectInspector partialOutputOI, ObjectInspector finalOI)

Method Summary

Modifier and Type	Method and Description
protected GenericUDAFRank.GenericUDAFHypotheticalSetRankEvaluator.CompareResult	compare(Object[] parameters)
GenericUDAFEvaluator.AggregationBuffer	getNewAggregationBuffer() Get a new aggregation object.
ObjectInspector	init(GenericUDAFEvaluator.Mode m, ObjectInspector[] parameters) Initialize the evaluator.
protected void	initPartial2AndFinalOI(ObjectInspector[] parameters)
void	iterate(GenericUDAFEvaluator.AggregationBuffer agg, Object[] parameters) Iterate through original data.
void	merge(GenericUDAFEvaluator.AggregationBuffer agg, Object partial) Merge with partial aggregation result.
void	reset(GenericUDAFEvaluator.AggregationBuffer agg) Reset the aggregation.
Object	terminate(GenericUDAFEvaluator.AggregationBuffer agg) Get final aggregation result.
Object	terminatePartial(GenericUDAFEvaluator.AggregationBuffer agg) Get partial aggregation result.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

RANK_FIELD

public static final String RANK_FIELD

See Also:

Constant Field Values

COUNT_FIELD

public static final String COUNT_FIELD

See Also:

Constant Field Values

PARTIAL_RANK_OI

public static final ObjectInspector PARTIAL_RANK_OI

Constructor Detail

GenericUDAFHypotheticalSetRankEvaluator

public GenericUDAFHypotheticalSetRankEvaluator()

GenericUDAFHypotheticalSetRankEvaluator

public GenericUDAFHypotheticalSetRankEvaluator(boolean allowEquality,
                                               ObjectInspector partialOutputOI,
                                               ObjectInspector finalOI)

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 GenericUDAFEvaluator

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

initPartial2AndFinalOI

protected void initPartial2AndFinalOI(ObjectInspector[] parameters)

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

reset

public void reset(GenericUDAFEvaluator.AggregationBuffer agg)
           throws HiveException

Description copied from class: GenericUDAFEvaluator

Reset the aggregation. This is useful if we want to reuse the same aggregation.

Specified by:

reset in class GenericUDAFEvaluator

Throws:

HiveException

iterate

public void iterate(GenericUDAFEvaluator.AggregationBuffer agg,
                    Object[] parameters)
             throws HiveException

Description copied from class: GenericUDAFEvaluator

Iterate through original data.

Specified by:

iterate in class GenericUDAFEvaluator

parameters - The objects of parameters.

Throws:

HiveException

compare

protected GenericUDAFRank.GenericUDAFHypotheticalSetRankEvaluator.CompareResult compare(Object[] parameters)

terminatePartial

public Object terminatePartial(GenericUDAFEvaluator.AggregationBuffer agg)
                        throws HiveException

Description copied from class: GenericUDAFEvaluator

Get partial aggregation result.

Specified by:

terminatePartial in class GenericUDAFEvaluator

Returns:

partial aggregation result.

Throws:

HiveException

merge

public void merge(GenericUDAFEvaluator.AggregationBuffer agg,
                  Object partial)
           throws HiveException

Description copied from class: GenericUDAFEvaluator

Merge with partial aggregation result. NOTE: null might be passed in case there is no input data.

Specified by:

merge in class GenericUDAFEvaluator

partial - The partial aggregation result.

Throws:

HiveException

terminate

public Object terminate(GenericUDAFEvaluator.AggregationBuffer agg)
                 throws HiveException

Description copied from class: GenericUDAFEvaluator

Get final aggregation result.

Specified by:

terminate in class GenericUDAFEvaluator

Returns:

final aggregation result.

Throws:

HiveException