org.apache.druid.query.aggregation

Class SimpleLongAggregatorFactory

java.lang.Object

org.apache.druid.query.aggregation.AggregatorFactory

org.apache.druid.query.aggregation.NullableNumericAggregatorFactory<ColumnValueSelector>

org.apache.druid.query.aggregation.SimpleLongAggregatorFactory

All Implemented Interfaces:

Cacheable

Direct Known Subclasses:

LongMaxAggregatorFactory, LongMinAggregatorFactory, LongSumAggregatorFactory

public abstract class SimpleLongAggregatorFactory
extends NullableNumericAggregatorFactory<ColumnValueSelector>

This is an abstract class inherited by various AggregatorFactory implementations that consume long input and produce long output on aggregation. It extends "NullableAggregatorFactory" instead of "NullableAggregatorFactory" to additionally support aggregation on single/multi value string column types.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	expression
protected com.google.common.base.Supplier<Expr>	fieldExpression
protected String	fieldName
protected ExprMacroTable	macroTable
protected String	name

Constructor Summary

Constructors

Constructor and Description
SimpleLongAggregatorFactory(ExprMacroTable macroTable, String name, String fieldName, String expression)

Method Summary

Modifier and Type	Method and Description
protected abstract Aggregator	buildAggregator(BaseLongColumnValueSelector selector)
protected abstract BufferAggregator	buildBufferAggregator(BaseLongColumnValueSelector selector)
Object	deserialize(Object object) A method that knows how to "deserialize" the object from whatever form it might have been put into in order to transfer via JSON.
boolean	equals(Object o)
protected Aggregator	factorize(ColumnSelectorFactory metricFactory, ColumnValueSelector selector) Creates an Aggregator to aggregate values from several rows, by using the provided selector.
protected BufferAggregator	factorizeBuffered(ColumnSelectorFactory metricFactory, ColumnValueSelector selector) Creates an BufferAggregator to aggregate values from several rows into a ByteBuffer.
Object	finalizeComputation(Object object) "Finalizes" the computation of an object.
Comparator	getComparator()
String	getExpression()
String	getFieldName()
int	getMaxIntermediateSize() Returns the maximum size that this aggregator will require in bytes for intermediate storage of results.
AggregatorFactory	getMergingFactory(AggregatorFactory other) Returns an AggregatorFactory that can be used to combine the output of aggregators from this factory and another factory.
String	getName()
String	getTypeName() Get the type name of the intermediate type for this aggregator.
int	hashCode()
protected abstract long	nullValue()
List<String>	requiredFields() Get a list of fields that aggregators built by this factory will need to read.
protected ColumnValueSelector	selector(ColumnSelectorFactory metricFactory) Creates a ColumnValueSelector for the aggregated column.

Methods inherited from class org.apache.druid.query.aggregation.NullableNumericAggregatorFactory

factorize, factorizeBuffered, factorizeVector, factorizeVector, getMaxIntermediateSizeWithNulls, makeNullableAggregateCombiner, vectorSelector

Methods inherited from class org.apache.druid.query.aggregation.AggregatorFactory

canVectorize, combine, getCombiningFactory, getRequiredColumns, makeAggregateCombiner, mergeAggregators, optimizeForSegment

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.java.util.common.Cacheable

getCacheKey

Field Detail

name

protected final String name

fieldName

@Nullable
protected final String fieldName

expression

@Nullable
protected final String expression

macroTable

protected final ExprMacroTable macroTable

fieldExpression

protected final com.google.common.base.Supplier<Expr> fieldExpression

Constructor Detail

SimpleLongAggregatorFactory

public SimpleLongAggregatorFactory(ExprMacroTable macroTable,
                                   String name,
                                   @Nullable
                                   String fieldName,
                                   @Nullable
                                   String expression)

Method Detail

factorize

protected Aggregator factorize(ColumnSelectorFactory metricFactory,
                               ColumnValueSelector selector)

Description copied from class: NullableNumericAggregatorFactory

Creates an Aggregator to aggregate values from several rows, by using the provided selector.

Specified by:

factorize in class NullableNumericAggregatorFactory<ColumnValueSelector>

Parameters:

metricFactory - metricFactory

selector - ColumnValueSelector for the column to aggregate.

See Also:

Aggregator

factorizeBuffered

protected BufferAggregator factorizeBuffered(ColumnSelectorFactory metricFactory,
                                             ColumnValueSelector selector)

Description copied from class: NullableNumericAggregatorFactory

Creates an BufferAggregator to aggregate values from several rows into a ByteBuffer.

Specified by:

factorizeBuffered in class NullableNumericAggregatorFactory<ColumnValueSelector>

Parameters:

metricFactory - columnSelectorFactory in case any other columns are needed.

selector - ColumnValueSelector for the column to aggregate.

See Also:

BufferAggregator

selector

protected ColumnValueSelector selector(ColumnSelectorFactory metricFactory)

Description copied from class: NullableNumericAggregatorFactory

Creates a ColumnValueSelector for the aggregated column.

Specified by:

selector in class NullableNumericAggregatorFactory<ColumnValueSelector>

See Also:

ColumnValueSelector

deserialize

public Object deserialize(Object object)

Description copied from class: AggregatorFactory

A method that knows how to "deserialize" the object from whatever form it might have been put into in order to transfer via JSON.

Specified by:

deserialize in class AggregatorFactory

Parameters:

object - the object to deserialize

Returns:

the deserialized object

getTypeName

public String getTypeName()

Description copied from class: AggregatorFactory

Get the type name of the intermediate type for this aggregator. This is the same as the type returned by AggregatorFactory.deserialize(java.lang.Object) and the type accepted by AggregatorFactory.combine(java.lang.Object, java.lang.Object). However, it is *not* necessarily the same type returned by AggregatorFactory.finalizeComputation(java.lang.Object). If the type is complex (i.e. not a simple, numeric ValueType) then there must be a corresponding ComplexMetricSerde which was registered with ComplexMetrics.registerSerde(java.lang.String, org.apache.druid.segment.serde.ComplexMetricSerde) using this type name. If you need a ValueType enum corresponding to this aggregator, a good way to do that is:

   Optional.ofNullable(GuavaUtils.getEnumIfPresent(ValueType.class, aggregator.getTypeName()))
           .orElse(ValueType.COMPLEX);
 

Specified by:

getTypeName in class AggregatorFactory

getMaxIntermediateSize

public int getMaxIntermediateSize()

Description copied from class: AggregatorFactory

Returns the maximum size that this aggregator will require in bytes for intermediate storage of results.

Specified by:

getMaxIntermediateSize in class AggregatorFactory

Returns:

the maximum number of bytes that an aggregator of this type will require for intermediate result storage.

getComparator

public Comparator getComparator()

Specified by:

getComparator in class AggregatorFactory

finalizeComputation

@Nullable
public Object finalizeComputation(@Nullable
                                            Object object)

Description copied from class: AggregatorFactory

"Finalizes" the computation of an object. Primarily useful for complex types that have a different mergeable intermediate format than their final resultant output.

Specified by:

finalizeComputation in class AggregatorFactory

Parameters:

object - the object to be finalized

Returns:

the finalized value that should be returned for the initial query

requiredFields

public List<String> requiredFields()

Description copied from class: AggregatorFactory

Get a list of fields that aggregators built by this factory will need to read.

Specified by:

requiredFields in class AggregatorFactory

getMergingFactory

public AggregatorFactory getMergingFactory(AggregatorFactory other)
                                    throws AggregatorFactoryNotMergeableException

Description copied from class: AggregatorFactory

Returns an AggregatorFactory that can be used to combine the output of aggregators from this factory and another factory. It is used when we have some values produced by this aggregator factory, and some values produced by the "other" aggregator factory, and we want to do some additional combining of them. This happens, for example, when compacting two segments together that both have a metric column with the same name. (Even though the name of the column is the same, the aggregator factory used to create it may be different from segment to segment.) This method may throw AggregatorFactoryNotMergeableException, meaning that "this" and "other" are not compatible and values from one cannot sensibly be combined with values from the other.

Overrides:

getMergingFactory in class AggregatorFactory

Returns:

a new Factory that can be used for merging the output of aggregators from this factory and other.

Throws:

AggregatorFactoryNotMergeableException

See Also:

which is equivalent to {@code foo.getMergingFactory(foo)} (when "this" and "other" are the same instance).

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getName

public String getName()

Specified by:

getName in class AggregatorFactory

getFieldName

@Nullable
public String getFieldName()

getExpression

@Nullable
public String getExpression()

nullValue

protected abstract long nullValue()

buildAggregator

protected abstract Aggregator buildAggregator(BaseLongColumnValueSelector selector)

buildBufferAggregator

protected abstract BufferAggregator buildBufferAggregator(BaseLongColumnValueSelector selector)