com.hazelcast.aggregation

Class Aggregators

java.lang.Object

com.hazelcast.aggregation.Aggregators

public final class Aggregators
extends Object

A utility class to create basic Aggregator instances.

Min/Max/Average aggregators are type specific, so an integerAvg() aggregator expects all elements to be integers. There is no conversion executed while accumulating, so if there is any other type met an exception will be thrown.

In order to operate on a generic Number type use the fixedPointSum(), floatingPointSum() and numberAvg() aggregators. All of them will convert the given number to either Long or Double during the accumulation phase. It will result in a lot of allocations since each number has to be converted, but it enables the user to operate on the whole family of numbers. It is especially useful if the numbers given to the aggregators may not be of one type only.

The attributePath given in the factory method allows the aggregator to operate on the value extracted by navigating to the given attributePath on each object that has been returned from a query. The attribute path may be simple, e.g. "name", or nested "address.city".

Since:

3.8

Method Summary

Modifier and Type	Method and Description
static <I> Aggregator<I,BigDecimal>	bigDecimalAvg()
static <I> Aggregator<I,BigDecimal>	bigDecimalAvg(String attributePath)
static <I> Aggregator<I,BigDecimal>	bigDecimalMax()
static <I> Aggregator<I,BigDecimal>	bigDecimalMax(String attributePath)
static <I> Aggregator<I,BigDecimal>	bigDecimalMin()
static <I> Aggregator<I,BigDecimal>	bigDecimalMin(String attributePath)
static <I> Aggregator<I,BigDecimal>	bigDecimalSum()
static <I> Aggregator<I,BigDecimal>	bigDecimalSum(String attributePath)
static <I> Aggregator<I,BigDecimal>	bigIntegerAvg()
static <I> Aggregator<I,BigDecimal>	bigIntegerAvg(String attributePath)
static <I> Aggregator<I,BigInteger>	bigIntegerMax()
static <I> Aggregator<I,BigInteger>	bigIntegerMax(String attributePath)
static <I> Aggregator<I,BigInteger>	bigIntegerMin()
static <I> Aggregator<I,BigInteger>	bigIntegerMin(String attributePath)
static <I> Aggregator<I,BigInteger>	bigIntegerSum()
static <I> Aggregator<I,BigInteger>	bigIntegerSum(String attributePath)
static <I,R extends Comparable> Aggregator<I,R>	comparableMax()
static <I,R extends Comparable> Aggregator<I,R>	comparableMax(String attributePath)
static <I,R extends Comparable> Aggregator<I,R>	comparableMin()
static <I,R extends Comparable> Aggregator<I,R>	comparableMin(String attributePath)
static <I> Aggregator<I,Long>	count()
static <I> Aggregator<I,Long>	count(String attributePath)
static <I,R> Aggregator<I,Set<R>>	distinct()
static <I,R> Aggregator<I,Set<R>>	distinct(String attributePath)
static <I> Aggregator<I,Double>	doubleAvg()
static <I> Aggregator<I,Double>	doubleAvg(String attributePath)
static <I> Aggregator<I,Double>	doubleMax()
static <I> Aggregator<I,Double>	doubleMax(String attributePath)
static <I> Aggregator<I,Double>	doubleMin()
static <I> Aggregator<I,Double>	doubleMin(String attributePath)
static <I> Aggregator<I,Double>	doubleSum()
static <I> Aggregator<I,Double>	doubleSum(String attributePath)
static <I> Aggregator<I,Long>	fixedPointSum()
static <I> Aggregator<I,Long>	fixedPointSum(String attributePath)
static <I> Aggregator<I,Double>	floatingPointSum()
static <I> Aggregator<I,Double>	floatingPointSum(String attributePath)
static <I> Aggregator<I,Double>	integerAvg()
static <I> Aggregator<I,Double>	integerAvg(String attributePath)
static <I> Aggregator<I,Integer>	integerMax()
static <I> Aggregator<I,Integer>	integerMax(String attributePath)
static <I> Aggregator<I,Integer>	integerMin()
static <I> Aggregator<I,Integer>	integerMin(String attributePath)
static <I> Aggregator<I,Long>	integerSum()
static <I> Aggregator<I,Long>	integerSum(String attributePath)
static <I> Aggregator<I,Double>	longAvg()
static <I> Aggregator<I,Double>	longAvg(String attributePath)
static <I> Aggregator<I,Long>	longMax()
static <I> Aggregator<I,Long>	longMax(String attributePath)
static <I> Aggregator<I,Long>	longMin()
static <I> Aggregator<I,Long>	longMin(String attributePath)
static <I> Aggregator<I,Long>	longSum()
static <I> Aggregator<I,Long>	longSum(String attributePath)
static <I> Aggregator<I,Double>	numberAvg()
static <I> Aggregator<I,Double>	numberAvg(String attributePath)

Methods inherited from class java.lang.Object

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

Method Detail

count

public static <I> Aggregator<I,Long> count()

count

public static <I> Aggregator<I,Long> count(String attributePath)

distinct

public static <I,R> Aggregator<I,Set<R>> distinct()

distinct

public static <I,R> Aggregator<I,Set<R>> distinct(String attributePath)

bigDecimalAvg

public static <I> Aggregator<I,BigDecimal> bigDecimalAvg()

bigDecimalAvg

public static <I> Aggregator<I,BigDecimal> bigDecimalAvg(String attributePath)

bigIntegerAvg

public static <I> Aggregator<I,BigDecimal> bigIntegerAvg()

bigIntegerAvg

public static <I> Aggregator<I,BigDecimal> bigIntegerAvg(String attributePath)

doubleAvg

public static <I> Aggregator<I,Double> doubleAvg()

doubleAvg

public static <I> Aggregator<I,Double> doubleAvg(String attributePath)

integerAvg

public static <I> Aggregator<I,Double> integerAvg()

integerAvg

public static <I> Aggregator<I,Double> integerAvg(String attributePath)

longAvg

public static <I> Aggregator<I,Double> longAvg()

longAvg

public static <I> Aggregator<I,Double> longAvg(String attributePath)

numberAvg

public static <I> Aggregator<I,Double> numberAvg()

numberAvg

public static <I> Aggregator<I,Double> numberAvg(String attributePath)

bigDecimalMax

public static <I> Aggregator<I,BigDecimal> bigDecimalMax()

bigDecimalMax

public static <I> Aggregator<I,BigDecimal> bigDecimalMax(String attributePath)

bigIntegerMax

public static <I> Aggregator<I,BigInteger> bigIntegerMax()

bigIntegerMax

public static <I> Aggregator<I,BigInteger> bigIntegerMax(String attributePath)

doubleMax

public static <I> Aggregator<I,Double> doubleMax()

doubleMax

public static <I> Aggregator<I,Double> doubleMax(String attributePath)

integerMax

public static <I> Aggregator<I,Integer> integerMax()

integerMax

public static <I> Aggregator<I,Integer> integerMax(String attributePath)

longMax

public static <I> Aggregator<I,Long> longMax()

longMax

public static <I> Aggregator<I,Long> longMax(String attributePath)

comparableMax

public static <I,R extends Comparable> Aggregator<I,R> comparableMax()

comparableMax

public static <I,R extends Comparable> Aggregator<I,R> comparableMax(String attributePath)

bigDecimalMin

public static <I> Aggregator<I,BigDecimal> bigDecimalMin()

bigDecimalMin

public static <I> Aggregator<I,BigDecimal> bigDecimalMin(String attributePath)

bigIntegerMin

public static <I> Aggregator<I,BigInteger> bigIntegerMin()

bigIntegerMin

public static <I> Aggregator<I,BigInteger> bigIntegerMin(String attributePath)

doubleMin

public static <I> Aggregator<I,Double> doubleMin()

doubleMin

public static <I> Aggregator<I,Double> doubleMin(String attributePath)

integerMin

public static <I> Aggregator<I,Integer> integerMin()

integerMin

public static <I> Aggregator<I,Integer> integerMin(String attributePath)

longMin

public static <I> Aggregator<I,Long> longMin()

longMin

public static <I> Aggregator<I,Long> longMin(String attributePath)

comparableMin

public static <I,R extends Comparable> Aggregator<I,R> comparableMin()

comparableMin

public static <I,R extends Comparable> Aggregator<I,R> comparableMin(String attributePath)

bigDecimalSum

public static <I> Aggregator<I,BigDecimal> bigDecimalSum()

bigDecimalSum

public static <I> Aggregator<I,BigDecimal> bigDecimalSum(String attributePath)

bigIntegerSum

public static <I> Aggregator<I,BigInteger> bigIntegerSum()

bigIntegerSum

public static <I> Aggregator<I,BigInteger> bigIntegerSum(String attributePath)

doubleSum

public static <I> Aggregator<I,Double> doubleSum()

doubleSum

public static <I> Aggregator<I,Double> doubleSum(String attributePath)

integerSum

public static <I> Aggregator<I,Long> integerSum()

integerSum

public static <I> Aggregator<I,Long> integerSum(String attributePath)

longSum

public static <I> Aggregator<I,Long> longSum()

longSum

public static <I> Aggregator<I,Long> longSum(String attributePath)

fixedPointSum

public static <I> Aggregator<I,Long> fixedPointSum()

fixedPointSum

public static <I> Aggregator<I,Long> fixedPointSum(String attributePath)

floatingPointSum

public static <I> Aggregator<I,Double> floatingPointSum()

floatingPointSum

public static <I> Aggregator<I,Double> floatingPointSum(String attributePath)