Package org.apache.druid.query.aggregation

Class LongSumAggregatorFactory

java.lang.Object

org.apache.druid.query.aggregation.AggregatorFactory

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

org.apache.druid.query.aggregation.SimpleLongAggregatorFactory

org.apache.druid.query.aggregation.LongSumAggregatorFactory

All Implemented Interfaces:

Cacheable

public class LongSumAggregatorFactory
extends SimpleLongAggregatorFactory

A null-aware aggregator factory. Note that the nullness is handled by NullableNumericAggregatorFactory, the LongSumAggregator, LongSumBufferAggregator, and LongSumVectorAggregator only aggregates non-null values, and returns 0 if no data has been aggregated.

If forceNotNullable is set to true, the aggregator factory will not allow null values.

Field Summary

Fields inherited from class org.apache.druid.query.aggregation.SimpleLongAggregatorFactory

expression, fieldExpression, fieldName, macroTable, name

Constructor Summary

Constructors

Constructor	Description
LongSumAggregatorFactory(String name, String fieldName)
LongSumAggregatorFactory(String name, String fieldName, String expression, ExprMacroTable macroTable)
LongSumAggregatorFactory(String name, String fieldName, String expression, ExprMacroTable macroTable, boolean forceNotNullable)

Method Summary

Modifier and Type	Method	Description
protected Aggregator	buildAggregator(BaseLongColumnValueSelector selector)
protected BufferAggregator	buildBufferAggregator(BaseLongColumnValueSelector selector)
Object	combine(Object lhs, Object rhs)	A method that knows how to combine the outputs of Aggregator.get() produced via AggregatorFactory.factorize(org.apache.druid.segment.ColumnSelectorFactory) or BufferAggregator.get(java.nio.ByteBuffer, int) produced via AggregatorFactory.factorizeBuffered(org.apache.druid.segment.ColumnSelectorFactory).
protected VectorAggregator	factorizeVector(VectorColumnSelectorFactory columnSelectorFactory, VectorValueSelector selector)	Creates a VectorAggregator to aggregate values from several rows into a ByteBuffer.
boolean	forceNotNullable()	If true, this aggregator will not check for null inputs, instead directly delegating to the underlying aggregator.
byte[]	getCacheKey()	Get a byte array used as a cache key.
AggregatorFactory	getCombiningFactory()	Returns an AggregatorFactory that can be used to combine the output of aggregators from this factory.
AggregateCombiner	makeAggregateCombiner()	Creates an AggregateCombiner to fold rollup aggregation results from serveral "rows" of different indexes during index merging.
protected long	nullValue()
String	toString()
AggregatorFactory	withName(String newName)	Used in cases where we want to change the output name of the aggregator to something else.

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

canVectorize, deserialize, equals, factorize, factorizeBuffered, finalizeComputation, getComparator, getExpression, getFieldName, getIntermediateType, getMaxIntermediateSize, getMergingFactory, getName, hashCode, requiredFields, selector, useGetObject, vectorSelector

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

factorize, factorizeBuffered, factorizeVector, getMaxIntermediateSizeWithNulls, getResultType, makeNullableAggregateCombiner

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

factorizeWithSize, getComplexTypeName, getFinalizedType, getRequiredColumns, getType, guessAggregatorHeapFootprint, mergeAggregators, optimizeForSegment, substituteCombiningFactory

Methods inherited from class java.lang.Object

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

Constructor Details

LongSumAggregatorFactory

public LongSumAggregatorFactory(String name,
 String fieldName)

LongSumAggregatorFactory

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

LongSumAggregatorFactory

public LongSumAggregatorFactory(String name,
 String fieldName,
 @Nullable
 String expression,
 ExprMacroTable macroTable,
 boolean forceNotNullable)

Method Details

forceNotNullable

public boolean forceNotNullable()

Description copied from class: NullableNumericAggregatorFactory

If true, this aggregator will not check for null inputs, instead directly delegating to the underlying aggregator. Currently, this is only used by CountAggregatorFactory.getCombiningFactory(). This isn't entirely safe, as some selectors might throw an exception when attempting to retrieve a primitive value from `null`.

Overrides:

forceNotNullable in class NullableNumericAggregatorFactory<ColumnValueSelector>

nullValue

protected long nullValue()

Specified by:

nullValue in class SimpleLongAggregatorFactory

buildAggregator

protected Aggregator buildAggregator(BaseLongColumnValueSelector selector)

Specified by:

buildAggregator in class SimpleLongAggregatorFactory

buildBufferAggregator

protected BufferAggregator buildBufferAggregator(BaseLongColumnValueSelector selector)

Specified by:

buildBufferAggregator in class SimpleLongAggregatorFactory

factorizeVector

protected VectorAggregator factorizeVector(VectorColumnSelectorFactory columnSelectorFactory,
 VectorValueSelector selector)

Description copied from class: NullableNumericAggregatorFactory

Creates a VectorAggregator to aggregate values from several rows into a ByteBuffer.

Overrides:

factorizeVector in class NullableNumericAggregatorFactory<ColumnValueSelector>

Parameters:

columnSelectorFactory - columnSelectorFactory in case any other columns are needed.

selector - VectorValueSelector for the column to aggregate.

See Also:

• BufferAggregator

combine

@Nullable
public Object combine(@Nullable
 Object lhs,
 @Nullable
 Object rhs)

Description copied from class: AggregatorFactory

A method that knows how to combine the outputs of Aggregator.get() produced via AggregatorFactory.factorize(org.apache.druid.segment.ColumnSelectorFactory) or BufferAggregator.get(java.nio.ByteBuffer, int) produced via AggregatorFactory.factorizeBuffered(org.apache.druid.segment.ColumnSelectorFactory). Note, even though this method is called "combine", this method's contract *does* allow for mutation of the input objects. Thus, any use of lhs or rhs after calling this method is highly discouraged.

Specified by:

combine in class AggregatorFactory

Parameters:

lhs - The left hand side of the combine

rhs - The right hand side of the combine

Returns:

an object representing the combination of lhs and rhs, this can be a new object or a mutation of the inputs

makeAggregateCombiner

public AggregateCombiner makeAggregateCombiner()

Description copied from class: AggregatorFactory

Creates an AggregateCombiner to fold rollup aggregation results from serveral "rows" of different indexes during index merging. AggregateCombiner implements the same logic as AggregatorFactory.combine(java.lang.Object, java.lang.Object), with the difference that it uses ColumnValueSelector and it's subinterfaces to get inputs and implements ColumnValueSelector to provide output.

Overrides:

makeAggregateCombiner in class AggregatorFactory

See Also:

• AggregateCombiner
• IndexMerger

withName

public AggregatorFactory withName(String newName)

Description copied from class: AggregatorFactory

Used in cases where we want to change the output name of the aggregator to something else. For eg: if we have a query `select a, sum(b) as total group by a from table` the aggregator returned from the native group by query is "a0" set in

invalid reference

org.apache.druid.sql.calcite.rel.DruidQuery#computeAggregations

. We can use withName("total") to set the output name of the aggregator to "total".

As all implementations of this interface method may not exist, callers of this method are advised to handle such a case.

Overrides:

withName in class AggregatorFactory

Parameters:

newName - newName of the output for aggregator factory

Returns:

AggregatorFactory with the output name set as the input param.

getCombiningFactory

public AggregatorFactory getCombiningFactory()

Description copied from class: AggregatorFactory

Returns an AggregatorFactory that can be used to combine the output of aggregators from this factory. It is used when we know we have some values that were produced with this aggregator factory, and want to do some additional combining of them. This happens, for example, when merging query results from two different segments, or two different servers. For simple aggregators, the combining factory may be computed by simply creating a new factory that is the same as the current, except with its input column renamed to the same as the output column. For example, this aggregator: {"type": "longSum", "fieldName": "foo", "name": "bar"} Would become: {"type": "longSum", "fieldName": "bar", "name": "bar"} Sometimes, the type or other parameters of the combining aggregator will be different from the original aggregator. For example, the CountAggregatorFactory getCombiningFactory method will return a LongSumAggregatorFactory, because counts are combined by summing. No matter what, `foo.getCombiningFactory()` and `foo.getCombiningFactory().getCombiningFactory()` should return the same result.

Specified by:

getCombiningFactory in class AggregatorFactory

Returns:

a new Factory that can be used for operations on top of data output from the current factory.

getCacheKey

public byte[] getCacheKey()

Description copied from interface: Cacheable

Get a byte array used as a cache key.

Returns:

bytes to be used as cache key - or null if this object should not be cached.

toString

public String toString()

Overrides:

toString in class Object