org.springframework.data.mongodb.core.aggregation

Class ArithmeticOperators

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ArithmeticOperators

public class ArithmeticOperators
extends Object

Gateway to Arithmetic aggregation operations that perform math operations on numbers.

Since:

1.10

Author:

Christoph Strobl, Mark Paluch, Mushtaq Ahmed

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArithmeticOperators.Abs AggregationExpression for $abs.
static class	ArithmeticOperators.Add AggregationExpression for $add.
static class	ArithmeticOperators.AngularUnit The unit of measure for computations that operate upon angles.
static class	ArithmeticOperators.ArithmeticOperatorFactory
static class	ArithmeticOperators.ASin An expression that calculates the inverse sine of a value.
static class	ArithmeticOperators.ASinh An expression that calculates the inverse hyperbolic sine of a value
static class	ArithmeticOperators.ATan An expression that calculates the inverse tangent of a value.
static class	ArithmeticOperators.ATan2 An expression that calculates the inverse tangent of y / x, where y and x are the first and second values passed to the expression respectively.
static class	ArithmeticOperators.ATanh An expression that calculates the inverse hyperbolic tangent of a value
static class	ArithmeticOperators.Ceil AggregationExpression for $ceil.
static class	ArithmeticOperators.Cos An expression that calculates the cosine of a value that is measured in radians.
static class	ArithmeticOperators.Cosh An expression that calculates the hyperbolic cosine of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.
static class	ArithmeticOperators.Derivative Value object to represent an expression that calculates the average rate of change within the specified window.
static class	ArithmeticOperators.Divide AggregationExpression for $divide.
static class	ArithmeticOperators.Exp AggregationExpression for $exp.
static class	ArithmeticOperators.Floor AggregationExpression for $floor.
static class	ArithmeticOperators.Integral Value object to represent an expression that calculates the approximation for the mathematical integral value.
static class	ArithmeticOperators.Ln AggregationExpression for $ln.
static class	ArithmeticOperators.Log AggregationExpression for $log.
static class	ArithmeticOperators.Log10 AggregationExpression for $log10.
static class	ArithmeticOperators.Mod AggregationExpression for $mod.
static class	ArithmeticOperators.Multiply AggregationExpression for $multiply.
static class	ArithmeticOperators.Pow AggregationExpression for $pow.
static class	ArithmeticOperators.Rand ArithmeticOperators.Rand returns a floating value between 0 and 1.
static class	ArithmeticOperators.Round ArithmeticOperators.Round rounds a number to a whole integer or to a specified decimal place.
static class	ArithmeticOperators.Sin An expression that calculates the sine of a value that is measured in radians.
static class	ArithmeticOperators.Sinh An expression that calculates the hyperbolic sine of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.
static class	ArithmeticOperators.Sqrt AggregationExpression for $sqrt.
static class	ArithmeticOperators.Subtract AggregationExpression for $subtract.
static class	ArithmeticOperators.Tan An expression that calculates the tangent of a value that is measured in radians.
static class	ArithmeticOperators.Tanh An expression that calculates the hyperbolic tangent of a value that is measured in ArithmeticOperators.AngularUnit.RADIANS.
static class	ArithmeticOperators.Trunc AggregationExpression for $trunc.

Constructor Summary

Constructors

Constructor and Description
ArithmeticOperators()

Method Summary

Modifier and Type	Method and Description
static ArithmeticOperators.Rand	rand() Creates new AggregationExpression that returns a random float between 0 and 1 each time it is called.
static ArithmeticOperators.ArithmeticOperatorFactory	valueOf(AggregationExpression expression) Take the value resulting from the given AggregationExpression.
static ArithmeticOperators.ArithmeticOperatorFactory	valueOf(String fieldReference) Take the field referenced by given fieldReference.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArithmeticOperators

public ArithmeticOperators()

Method Detail

valueOf

public static ArithmeticOperators.ArithmeticOperatorFactory valueOf(String fieldReference)

Take the field referenced by given fieldReference.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ArithmeticOperators.ArithmeticOperatorFactory.

valueOf

public static ArithmeticOperators.ArithmeticOperatorFactory valueOf(AggregationExpression expression)

Take the value resulting from the given AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of ArithmeticOperators.ArithmeticOperatorFactory.

rand

public static ArithmeticOperators.Rand rand()

Creates new AggregationExpression that returns a random float between 0 and 1 each time it is called.

Returns:

new instance of ArithmeticOperators.Rand.

Since:

3.3