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

Class GenericUDAFBloomFilter.GenericUDAFBloomFilterEvaluator

java.lang.Object

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

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

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

GenericUDAFBloomFilter

public static class GenericUDAFBloomFilter.GenericUDAFBloomFilterEvaluator
extends GenericUDAFEvaluator

GenericUDAFBloomFilterEvaluator - Evaluator class for BloomFilter

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.GenericUDAFEvaluator

partitionEvaluator

Constructor Summary

Constructors

Constructor and Description
GenericUDAFBloomFilterEvaluator()

Method Summary

Modifier and Type	Method and Description
int	estimate() Although similar to AbstractAggregationBuffer::estimate(), it differs from it in 2 aspects 1) This avoids creation of AggregationBuffer which may result in large memory allocation 2) This is used only while compiling query as oppose to AbstractAggregationBuffer version which may be used in both runtime as well as compile time.
long	getExpectedEntries()
String	getExprString() Optional information to add to expression string.
float	getFactor()
long	getMinEntries()
GenericUDAFEvaluator.AggregationBuffer	getNewAggregationBuffer() Get a new aggregation object.
Operator<?>	getSourceOperator()
boolean	hasHintEntries()
ObjectInspector	init(GenericUDAFEvaluator.Mode m, ObjectInspector[] parameters) Initialize the evaluator.
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.
void	setFactor(float factor)
void	setHintEntries(long hintEntries)
void	setMaxEntries(long maxEntries)
void	setMinEntries(long minEntries)
void	setSourceOperator(SelectOperator sourceOperator)
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, evaluate, getPartitionWindowingEvaluator, getWindowingEvaluator, isEstimable

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericUDAFBloomFilterEvaluator

public GenericUDAFBloomFilterEvaluator()

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

estimate

public int estimate()

Description copied from class: GenericUDAFEvaluator

Although similar to AbstractAggregationBuffer::estimate(), it differs from it in 2 aspects 1) This avoids creation of AggregationBuffer which may result in large memory allocation 2) This is used only while compiling query as oppose to AbstractAggregationBuffer version which may be used in both runtime as well as compile time.

Overrides:

estimate in class GenericUDAFEvaluator

Returns:

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

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

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

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

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

getExpectedEntries

public long getExpectedEntries()

getSourceOperator

public Operator<?> getSourceOperator()

setSourceOperator

public void setSourceOperator(SelectOperator sourceOperator)

setHintEntries

public void setHintEntries(long hintEntries)

hasHintEntries

public boolean hasHintEntries()

setMaxEntries

public void setMaxEntries(long maxEntries)

setMinEntries

public void setMinEntries(long minEntries)

getMinEntries

public long getMinEntries()

setFactor

public void setFactor(float factor)

getFactor

public float getFactor()

getExprString

public String getExprString()

Description copied from class: GenericUDAFEvaluator

Optional information to add to expression string. Subclasses can override.

Overrides:

getExprString in class GenericUDAFEvaluator