ArithmeticOperators.ArithmeticOperatorFactory (Spring Data MongoDB 2.1.0.RELEASE API)

java.lang.Object
- org.springframework.data.mongodb.core.aggregation.ArithmeticOperators.ArithmeticOperatorFactory

Enclosing class:: ArithmeticOperators

public static class ArithmeticOperators.ArithmeticOperatorFactory
extends Object

Author:: Christoph Strobl

Constructor Summary

Constructors
Constructor and Description
`ArithmeticOperatorFactory(AggregationExpression expression)` Creates new `ArithmeticOperators.ArithmeticOperatorFactory` for given `AggregationExpression`.
`ArithmeticOperatorFactory(String fieldReference)` Creates new `ArithmeticOperators.ArithmeticOperatorFactory` for given fieldReference.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArithmeticOperators.Abs`	`abs()` Creates new `AggregationExpression` that returns the absolute value of the associated number.
`ArithmeticOperators.Add`	`add(AggregationExpression expression)` Creates new `AggregationExpression` that adds the resulting value of the given `AggregationExpression` to the associated number.
`ArithmeticOperators.Add`	`add(Number value)` Creates new `AggregationExpression` that adds the given value to the associated number.
`ArithmeticOperators.Add`	`add(String fieldReference)` Creates new `AggregationExpression` that adds the value of fieldReference to the associated number.
`AccumulatorOperators.Avg`	`avg()` Creates new `AggregationExpression` that returns the average value of the numeric values.
`ArithmeticOperators.Ceil`	`ceil()` Creates new `AggregationExpression` that returns the smallest integer greater than or equal to the assoicated number.
`ArithmeticOperators.Divide`	`divideBy(AggregationExpression expression)` Creates new `AggregationExpression` that divides the associated number by number extracted via expression.
`ArithmeticOperators.Divide`	`divideBy(Number value)` Creates new `AggregationExpression` that divides the associated number by given value.
`ArithmeticOperators.Divide`	`divideBy(String fieldReference)` Creates new `AggregationExpression` that ivides the associated number by number referenced via fieldReference.
`ArithmeticOperators.Exp`	`exp()` Creates new `AggregationExpression` that raises Euler’s number (i.e. e ) on the associated number.
`ArithmeticOperators.Floor`	`floor()` Creates new `AggregationExpression` that returns the largest integer less than or equal to the associated number.
`ArithmeticOperators.Ln`	`ln()` Creates new `AggregationExpression` that calculates the natural logarithm ln (i.e loge) of the assoicated number.
`ArithmeticOperators.Log`	`log(AggregationExpression expression)` Creates new `AggregationExpression` that calculates the log of the associated number in the specified base extracted by given `AggregationExpression`.
`ArithmeticOperators.Log`	`log(Number base)` Creates new `AggregationExpression` that calculates the log of a the associated number in the specified base.
`ArithmeticOperators.Log`	`log(String fieldReference)` Creates new `AggregationExpression` that calculates the log of the associated number in the specified base referenced via fieldReference.
`ArithmeticOperators.Log10`	`log10()` Creates new `AggregationExpression` that calculates the log base 10 for the associated number.
`AccumulatorOperators.Max`	`max()` Creates new `AggregationExpression` that returns the maximum value.
`AccumulatorOperators.Min`	`min()` Creates new `AggregationExpression` that returns the minimum value.
`ArithmeticOperators.Mod`	`mod(AggregationExpression expression)` Creates new `AggregationExpression` that divides the associated number by another and returns the remainder.
`ArithmeticOperators.Mod`	`mod(Number value)` Creates new `AggregationExpression` that divides the associated number by another and returns the remainder.
`ArithmeticOperators.Mod`	`mod(String fieldReference)` Creates new `AggregationExpression` that divides the associated number by another and returns the remainder.
`ArithmeticOperators.Multiply`	`multiplyBy(AggregationExpression expression)` Creates new `AggregationExpression` that multiplies the associated number with another.
`ArithmeticOperators.Multiply`	`multiplyBy(Number value)` Creates new `AggregationExpression` that multiplies the associated number with another.
`ArithmeticOperators.Multiply`	`multiplyBy(String fieldReference)` Creates new `AggregationExpression` that multiplies the associated number with another.
`ArithmeticOperators.Pow`	`pow(AggregationExpression expression)` Creates new `AggregationExpression` that raises the associated number to the specified exponent.
`ArithmeticOperators.Pow`	`pow(Number value)` Creates new `AggregationExpression` that raises the associated number to the specified exponent.
`ArithmeticOperators.Pow`	`pow(String fieldReference)` Creates new `AggregationExpression` that raises the associated number to the specified exponent.
`ArithmeticOperators.Sqrt`	`sqrt()` Creates new `AggregationExpression` that calculates the square root of the associated number.
`AccumulatorOperators.StdDevPop`	`stdDevPop()` Creates new `AggregationExpression` that calculates the population standard deviation of the input values.
`AccumulatorOperators.StdDevSamp`	`stdDevSamp()` Creates new `AggregationExpression` that calculates the sample standard deviation of the input values.
`ArithmeticOperators.Subtract`	`subtract(AggregationExpression expression)` Creates new `AggregationExpression` that subtracts value of given from the associated number.
`ArithmeticOperators.Subtract`	`subtract(Number value)` Creates new `AggregationExpression` that subtracts value from the associated number.
`ArithmeticOperators.Subtract`	`subtract(String fieldReference)` Creates new `AggregationExpression` that subtracts value of given from the associated number.
`AccumulatorOperators.Sum`	`sum()` Creates new `AggregationExpression` that calculates and returns the sum of numeric values.
`ArithmeticOperators.Trunc`	`trunc()` Creates new `AggregationExpression` that truncates a number to its integer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArithmeticOperatorFactory
```
public ArithmeticOperatorFactory(String fieldReference)
```
    Creates new ArithmeticOperators.ArithmeticOperatorFactory for given fieldReference.
    
    Parameters:
    
    fieldReference - must not be null.
  - ArithmeticOperatorFactory
```
public ArithmeticOperatorFactory(AggregationExpression expression)
```
    Creates new ArithmeticOperators.ArithmeticOperatorFactory for given AggregationExpression.
    
    Parameters:
    
    expression - must not be null.
- Method Detail
  - abs
```
public ArithmeticOperators.Abs abs()
```
    Creates new AggregationExpression that returns the absolute value of the associated number.
    
    Returns:
  - add
```
public ArithmeticOperators.Add add(String fieldReference)
```
    Creates new AggregationExpression that adds the value of fieldReference to the associated number.
    
    Parameters:
    
    fieldReference - must not be null.
    
    Returns:
  - add
```
public ArithmeticOperators.Add add(AggregationExpression expression)
```
    Creates new AggregationExpression that adds the resulting value of the given AggregationExpression to the associated number.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
  - add
```
public ArithmeticOperators.Add add(Number value)
```
    Creates new AggregationExpression that adds the given value to the associated number.
    
    Parameters:
    
    value - must not be null.
    
    Returns:
  - ceil
```
public ArithmeticOperators.Ceil ceil()
```
    Creates new AggregationExpression that returns the smallest integer greater than or equal to the assoicated number.
    
    Returns:
  - divideBy
```
public ArithmeticOperators.Divide divideBy(String fieldReference)
```
    Creates new AggregationExpression that ivides the associated number by number referenced via fieldReference.
    
    Parameters:
    
    fieldReference - must not be null.
    
    Returns:
  - divideBy
```
public ArithmeticOperators.Divide divideBy(AggregationExpression expression)
```
    Creates new AggregationExpression that divides the associated number by number extracted via expression.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
  - divideBy
```
public ArithmeticOperators.Divide divideBy(Number value)
```
    Creates new AggregationExpression that divides the associated number by given value.
    
    Parameters:
    
    value -
    
    Returns:
  - exp
```
public ArithmeticOperators.Exp exp()
```
    Creates new AggregationExpression that raises Euler’s number (i.e. e ) on the associated number.
    
    Returns:
  - floor
```
public ArithmeticOperators.Floor floor()
```
    Creates new AggregationExpression that returns the largest integer less than or equal to the associated number.
    
    Returns:
  - ln
```
public ArithmeticOperators.Ln ln()
```
    Creates new AggregationExpression that calculates the natural logarithm ln (i.e loge) of the assoicated number.
    
    Returns:
  - log
```
public ArithmeticOperators.Log log(String fieldReference)
```
    Creates new AggregationExpression that calculates the log of the associated number in the specified base referenced via fieldReference.
    
    Parameters:
    
    fieldReference - must not be null.
    
    Returns:
  - log
```
public ArithmeticOperators.Log log(AggregationExpression expression)
```
    Creates new AggregationExpression that calculates the log of the associated number in the specified base extracted by given AggregationExpression.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
  - log
```
public ArithmeticOperators.Log log(Number base)
```
    Creates new AggregationExpression that calculates the log of a the associated number in the specified base.
    
    Parameters:
    
    base - must not be null.
    
    Returns:
  - log10
```
public ArithmeticOperators.Log10 log10()
```
    Creates new AggregationExpression that calculates the log base 10 for the associated number.
    
    Returns:
  - mod
```
public ArithmeticOperators.Mod mod(String fieldReference)
```
    Creates new AggregationExpression that divides the associated number by another and returns the remainder.
    
    Parameters:
    
    fieldReference - must not be null.
    
    Returns:
  - mod
```
public ArithmeticOperators.Mod mod(AggregationExpression expression)
```
    Creates new AggregationExpression that divides the associated number by another and returns the remainder.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
  - mod
```
public ArithmeticOperators.Mod mod(Number value)
```
    Creates new AggregationExpression that divides the associated number by another and returns the remainder.
    
    Parameters:
    
    value - must not be null.
    
    Returns:
  - multiplyBy
```
public ArithmeticOperators.Multiply multiplyBy(String fieldReference)
```
    Creates new AggregationExpression that multiplies the associated number with another.
    
    Parameters:
    
    fieldReference - must not be null.
    
    Returns:
  - multiplyBy
```
public ArithmeticOperators.Multiply multiplyBy(AggregationExpression expression)
```
    Creates new AggregationExpression that multiplies the associated number with another.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
  - multiplyBy
```
public ArithmeticOperators.Multiply multiplyBy(Number value)
```
    Creates new AggregationExpression that multiplies the associated number with another.
    
    Parameters:
    
    value - must not be null.
    
    Returns:
  - pow
```
public ArithmeticOperators.Pow pow(String fieldReference)
```
    Creates new AggregationExpression that raises the associated number to the specified exponent.
    
    Parameters:
    
    fieldReference - must not be null.
    
    Returns:
  - pow
```
public ArithmeticOperators.Pow pow(AggregationExpression expression)
```
    Creates new AggregationExpression that raises the associated number to the specified exponent.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
  - pow
```
public ArithmeticOperators.Pow pow(Number value)
```
    Creates new AggregationExpression that raises the associated number to the specified exponent.
    
    Parameters:
    
    value - must not be null.
    
    Returns:
  - sqrt
```
public ArithmeticOperators.Sqrt sqrt()
```
    Creates new AggregationExpression that calculates the square root of the associated number.
    
    Returns:
  - subtract
```
public ArithmeticOperators.Subtract subtract(String fieldReference)
```
    Creates new AggregationExpression that subtracts value of given from the associated number.
    
    Parameters:
    
    fieldReference - must not be null.
    
    Returns:
  - subtract
```
public ArithmeticOperators.Subtract subtract(AggregationExpression expression)
```
    Creates new AggregationExpression that subtracts value of given from the associated number.
    
    Parameters:
    
    expression - must not be null.
    
    Returns:
  - subtract
```
public ArithmeticOperators.Subtract subtract(Number value)
```
    Creates new AggregationExpression that subtracts value from the associated number.
    
    Parameters:
    
    value -
    
    Returns:
  - trunc
```
public ArithmeticOperators.Trunc trunc()
```
    Creates new AggregationExpression that truncates a number to its integer.
    
    Returns:
  - sum
```
public AccumulatorOperators.Sum sum()
```
    Creates new AggregationExpression that calculates and returns the sum of numeric values.
    
    Returns:
  - avg
```
public AccumulatorOperators.Avg avg()
```
    Creates new AggregationExpression that returns the average value of the numeric values.
    
    Returns:
  - max
```
public AccumulatorOperators.Max max()
```
    Creates new AggregationExpression that returns the maximum value.
    
    Returns:
  - min
```
public AccumulatorOperators.Min min()
```
    Creates new AggregationExpression that returns the minimum value.
    
    Returns:
  - stdDevPop
```
public AccumulatorOperators.StdDevPop stdDevPop()
```
    Creates new AggregationExpression that calculates the population standard deviation of the input values.
    
    Returns:
  - stdDevSamp
```
public AccumulatorOperators.StdDevSamp stdDevSamp()
```
    Creates new AggregationExpression that calculates the sample standard deviation of the input values.
    
    Returns:

Class ArithmeticOperators.ArithmeticOperatorFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArithmeticOperatorFactory

ArithmeticOperatorFactory

Method Detail

abs

add

add

add

ceil

divideBy

divideBy

divideBy

exp

floor

ln

log

log

log

log10

mod

mod

mod

multiplyBy

multiplyBy

multiplyBy

pow

pow

pow

sqrt

subtract

subtract

subtract

trunc

sum

avg

max

min

stdDevPop

stdDevSamp