Package org.springframework.data.mongodb.core.aggregation

Class AccumulatorOperators.AccumulatorOperatorFactory

java.lang.Object

org.springframework.data.mongodb.core.aggregation.AccumulatorOperators.AccumulatorOperatorFactory

Enclosing class:

AccumulatorOperators

public static class AccumulatorOperators.AccumulatorOperatorFactory
extends Object

Author:

Christoph Strobl, Julia Lee

Constructor Summary

Constructors

Constructor	Description
AccumulatorOperatorFactory(String fieldReference)	Creates new AccumulatorOperators.AccumulatorOperatorFactory for given fieldReference.
AccumulatorOperatorFactory(AggregationExpression expression)	Creates new AccumulatorOperators.AccumulatorOperatorFactory for given AggregationExpression.

Method Summary

Modifier and Type	Method	Description
AccumulatorOperators.Avg	avg()	Creates new AggregationExpression that takes the associated numeric value expression and returns the average value.
AccumulatorOperators.CovariancePop	covariancePop(String fieldReference)	Creates new AggregationExpression that uses the previous input (field/expression) and the value of the given field to calculate the population covariance of the two.
AccumulatorOperators.CovariancePop	covariancePop(AggregationExpression expression)	Creates new AggregationExpression that uses the previous input (field/expression) and the result of the given expression to calculate the population covariance of the two.
AccumulatorOperators.CovarianceSamp	covarianceSamp(String fieldReference)	Creates new AggregationExpression that uses the previous input (field/expression) and the value of the given field to calculate the sample covariance of the two.
AccumulatorOperators.CovarianceSamp	covarianceSamp(AggregationExpression expression)	Creates new AggregationExpression that uses the previous input (field/expression) and the result of the given expression to calculate the sample covariance of the two.
AccumulatorOperators.ExpMovingAvgBuilder	expMovingAvg()	Creates new AccumulatorOperators.ExpMovingAvgBuilder that to build expMovingAvg that calculates the exponential moving average of numeric values
AccumulatorOperators.Max	max()	Creates new AggregationExpression that takes the associated numeric value expression and returns the maximum value.
AccumulatorOperators.Max	max(int numberOfResults)	Creates new AggregationExpression that takes the associated numeric value expression and returns the requested number of maximum values.
AccumulatorOperators.Median	median()	Creates new AggregationExpression that calculates the median of the associated numeric value expression.
AccumulatorOperators.Min	min()	Creates new AggregationExpression that takes the associated numeric value expression and returns the minimum value.
AccumulatorOperators.Min	min(int numberOfResults)	Creates new AggregationExpression that takes the associated numeric value expression and returns the requested number of maximum values.
AccumulatorOperators.Percentile	percentile(Double... percentages)	Creates new AggregationExpression that calculates the requested percentile(s) of the associated numeric value expression.
AccumulatorOperators.StdDevPop	stdDevPop()	Creates new AggregationExpression that takes the associated numeric value expression and calculates the population standard deviation of the input values.
AccumulatorOperators.StdDevSamp	stdDevSamp()	Creates new AggregationExpression that takes the associated numeric value expression and calculates the sample standard deviation of the input values.
AccumulatorOperators.Sum	sum()	Creates new AggregationExpression that takes the associated numeric value expression and calculates and returns the sum.

Methods inherited from class java.lang.Object

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

Constructor Details

AccumulatorOperatorFactory

public AccumulatorOperatorFactory(String fieldReference)

Creates new AccumulatorOperators.AccumulatorOperatorFactory for given fieldReference.

Parameters:

fieldReference - must not be null.

AccumulatorOperatorFactory

public AccumulatorOperatorFactory(AggregationExpression expression)

Creates new AccumulatorOperators.AccumulatorOperatorFactory for given AggregationExpression.

Parameters:

expression - must not be null.

Method Details

sum

public AccumulatorOperators.Sum sum()

Creates new AggregationExpression that takes the associated numeric value expression and calculates and returns the sum.

Returns:

new instance of AccumulatorOperators.Sum.

avg

public AccumulatorOperators.Avg avg()

Creates new AggregationExpression that takes the associated numeric value expression and returns the average value.

Returns:

new instance of AccumulatorOperators.Avg.

max

public AccumulatorOperators.Max max()

Creates new AggregationExpression that takes the associated numeric value expression and returns the maximum value.

Returns:

new instance of AccumulatorOperators.Max.

max

public AccumulatorOperators.Max max(int numberOfResults)

Creates new AggregationExpression that takes the associated numeric value expression and returns the requested number of maximum values.

Returns:

new instance of AccumulatorOperators.Max.

Since:

4.0

min

public AccumulatorOperators.Min min()

Creates new AggregationExpression that takes the associated numeric value expression and returns the minimum value.

Returns:

new instance of AccumulatorOperators.Min.

min

public AccumulatorOperators.Min min(int numberOfResults)

Creates new AggregationExpression that takes the associated numeric value expression and returns the requested number of maximum values.

Returns:

new instance of AccumulatorOperators.Max.

Since:

4.0

stdDevPop

public AccumulatorOperators.StdDevPop stdDevPop()

Creates new AggregationExpression that takes the associated numeric value expression and calculates the population standard deviation of the input values.

Returns:

new instance of AccumulatorOperators.StdDevPop.

stdDevSamp

public AccumulatorOperators.StdDevSamp stdDevSamp()

Creates new AggregationExpression that takes the associated numeric value expression and calculates the sample standard deviation of the input values.

Returns:

new instance of AccumulatorOperators.StdDevSamp.

covariancePop

public AccumulatorOperators.CovariancePop covariancePop(String fieldReference)

Creates new AggregationExpression that uses the previous input (field/expression) and the value of the given field to calculate the population covariance of the two.

Parameters:

fieldReference - must not be null.

Returns:

new instance of AccumulatorOperators.CovariancePop.

Since:

3.3

covariancePop

public AccumulatorOperators.CovariancePop covariancePop(AggregationExpression expression)

Creates new AggregationExpression that uses the previous input (field/expression) and the result of the given expression to calculate the population covariance of the two.

Parameters:

expression - must not be null.

Returns:

new instance of AccumulatorOperators.CovariancePop.

Since:

3.3

covarianceSamp

public AccumulatorOperators.CovarianceSamp covarianceSamp(String fieldReference)

Creates new AggregationExpression that uses the previous input (field/expression) and the value of the given field to calculate the sample covariance of the two.

Parameters:

fieldReference - must not be null.

Returns:

new instance of AccumulatorOperators.CovariancePop.

Since:

3.3

covarianceSamp

public AccumulatorOperators.CovarianceSamp covarianceSamp(AggregationExpression expression)

Creates new AggregationExpression that uses the previous input (field/expression) and the result of the given expression to calculate the sample covariance of the two.

Parameters:

expression - must not be null.

Returns:

new instance of AccumulatorOperators.CovariancePop.

Since:

3.3

expMovingAvg

public AccumulatorOperators.ExpMovingAvgBuilder expMovingAvg()

Creates new AccumulatorOperators.ExpMovingAvgBuilder that to build expMovingAvg that calculates the exponential moving average of numeric values

Returns:

new instance of AccumulatorOperators.ExpMovingAvg.

Since:

3.3

percentile

public AccumulatorOperators.Percentile percentile(Double... percentages)

Creates new AggregationExpression that calculates the requested percentile(s) of the associated numeric value expression.

Parameters:

percentages - must not be null.

Returns:

new instance of AccumulatorOperators.Percentile.

Since:

4.2

median

public AccumulatorOperators.Median median()

Creates new AggregationExpression that calculates the median of the associated numeric value expression.

Returns:

new instance of AccumulatorOperators.Median.

Since:

4.2