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

Class ArithmeticOperators.ArithmeticOperatorFactory

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	Description
ArithmeticOperatorFactory(String fieldReference)	Creates new ArithmeticOperators.ArithmeticOperatorFactory for given fieldReference.
ArithmeticOperatorFactory(AggregationExpression expression)	Creates new ArithmeticOperators.ArithmeticOperatorFactory for given AggregationExpression.

Method Summary

Modifier and Type	Method	Description
ArithmeticOperators.Abs	abs()	Creates new AggregationExpression that returns the absolute value of the associated number.
ArithmeticOperators.ACos	acos()	Creates new AggregationExpression that calculates the inverse cosine of a numeric value.
ArithmeticOperators.ACosh	acosh()	Creates new AggregationExpression that calculates the inverse hyperbolic cosine of a numeric value.
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.
ArithmeticOperators.Add	add(AggregationExpression expression)	Creates new AggregationExpression that adds the resulting value of the given AggregationExpression to the associated number.
ArithmeticOperators.ASin	asin()	Creates new AggregationExpression that calculates the inverse sine of a numeric value.
ArithmeticOperators.ASinh	asinh()	Creates new AggregationExpression that calculates the inverse hyperbolic sine of a numeric value.
ArithmeticOperators.ATan	atan()	Creates new AggregationExpression that calculates the inverse tangent of a numeric value.
ArithmeticOperators.ATan2	atan2(Number value)	Creates new AggregationExpression that calculates the inverse tangent of the the numeric value divided by the given numeric value in the argument.
ArithmeticOperators.ATan2	atan2(String fieldReference)	Creates new AggregationExpression that calculates the inverse tangent of the the numeric value divided by the given field reference in the argument.
ArithmeticOperators.ATan2	atan2(AggregationExpression expression)	Creates new AggregationExpression that calculates the inverse tangent of the the numeric value divided by the given AggregationExpression in the argument.
ArithmeticOperators.ATanh	atanh()	Creates new AggregationExpression that calculates the inverse hyperbolic tangent of a numeric value.
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.Cos	cos()	Creates new AggregationExpression that calculates the cosine of a numeric value given in radians.
ArithmeticOperators.Cos	cos(ArithmeticOperators.AngularUnit unit)	Creates new AggregationExpression that calculates the cosine of a numeric value in the given unit.
ArithmeticOperators.Cosh	cosh()	Creates new AggregationExpression that calculates the hyperbolic cosine of a numeric value given in radians.
ArithmeticOperators.Cosh	cosh(ArithmeticOperators.AngularUnit unit)	Creates new AggregationExpression that calculates the hyperbolic cosine of a numeric 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.
ArithmeticOperators.Derivative	derivative()	Creates new AggregationExpression that calculates the mathematical derivative value.
ArithmeticOperators.Derivative	derivative(String unit)	Creates new AggregationExpression that calculates the mathematical derivative value.
ArithmeticOperators.Derivative	derivative(SetWindowFieldsOperation.WindowUnit unit)	Creates new AggregationExpression that calculates the mathematical derivative value.
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.Divide	divideBy(AggregationExpression expression)	Creates new AggregationExpression that divides the associated number by number extracted via expression.
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.Integral	integral()	Creates new AggregationExpression that calculates the approximation for the mathematical integral value.
ArithmeticOperators.Integral	integral(String unit)	Creates new AggregationExpression that calculates the approximation for the mathematical integral value.
ArithmeticOperators.Integral	integral(SetWindowFieldsOperation.WindowUnit unit)	Creates new AggregationExpression that calculates the approximation for the mathematical integral value.
ArithmeticOperators.Ln	ln()	Creates new AggregationExpression that calculates the natural logarithm ln (i.e loge) of the assoicated number.
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.Log	log(AggregationExpression expression)	Creates new AggregationExpression that calculates the log of the associated number in the specified base extracted by given AggregationExpression.
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(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.Mod	mod(AggregationExpression expression)	Creates new AggregationExpression that divides the associated number by another and returns the remainder.
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.Multiply	multiplyBy(AggregationExpression expression)	Creates new AggregationExpression that multiplies the associated number with another.
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.Pow	pow(AggregationExpression expression)	Creates new AggregationExpression that raises the associated number to the specified exponent.
ArithmeticOperators.Round	round()	Creates new AggregationExpression that rounds a number to a whole integer or to a specified decimal place.
ArithmeticOperators.Round	roundToPlace(int place)	Creates new AggregationExpression that rounds a number to a specified decimal place.
ArithmeticOperators.Sin	sin()	Creates new AggregationExpression that calculates the sine of a numeric value given in radians.
ArithmeticOperators.Sin	sin(ArithmeticOperators.AngularUnit unit)	Creates new AggregationExpression that calculates the sine of a numeric value in the given unit.
ArithmeticOperators.Sinh	sinh()	Creates new AggregationExpression that calculates the sine of a numeric value given in radians.
ArithmeticOperators.Sinh	sinh(ArithmeticOperators.AngularUnit unit)	Creates new AggregationExpression that calculates the sine of a numeric value.
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(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.
ArithmeticOperators.Subtract	subtract(AggregationExpression expression)	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.Tan	tan()	Creates new AggregationExpression that calculates the tangent of a numeric value given in radians.
ArithmeticOperators.Tan	tan(ArithmeticOperators.AngularUnit unit)	Creates new AggregationExpression that calculates the tangent of a numeric value in the given unit.
ArithmeticOperators.Tanh	tanh()	Creates new AggregationExpression that calculates the hyperbolic tangent of a numeric value given in radians.
ArithmeticOperators.Tanh	tanh(ArithmeticOperators.AngularUnit unit)	Creates new AggregationExpression that calculates the hyperbolic tangent of a numeric value.
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 Details

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 Details

abs

public ArithmeticOperators.Abs abs()

Creates new AggregationExpression that returns the absolute value of the associated number.

Returns:

new instance of ArithmeticOperators.Abs.

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:

new instance of ArithmeticOperators.Add.

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:

new instance of ArithmeticOperators.Add.

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:

new instance of ArithmeticOperators.Add.

ceil

public ArithmeticOperators.Ceil ceil()

Creates new AggregationExpression that returns the smallest integer greater than or equal to the assoicated number.

Returns:

new instance of ArithmeticOperators.Ceil.

derivative

public ArithmeticOperators.Derivative derivative()

Creates new AggregationExpression that calculates the mathematical derivative value.

Returns:

new instance of ArithmeticOperators.Derivative.

Since:

3.3

derivative

public ArithmeticOperators.Derivative derivative(SetWindowFieldsOperation.WindowUnit unit)

Creates new AggregationExpression that calculates the mathematical derivative value.

Parameters:

unit - The time unit (SetWindowFieldsOperation.WindowUnits.WEEK, SetWindowFieldsOperation.WindowUnits.DAY, SetWindowFieldsOperation.WindowUnits.HOUR, SetWindowFieldsOperation.WindowUnits.MINUTE, SetWindowFieldsOperation.WindowUnits.SECOND, SetWindowFieldsOperation.WindowUnits.MILLISECOND) to apply.

Returns:

new instance of ArithmeticOperators.Derivative.

Since:

3.3

derivative

public ArithmeticOperators.Derivative derivative(@Nullable
 String unit)

Creates new AggregationExpression that calculates the mathematical derivative value.

Parameters:

unit - The time unit (week, day, hour, minute, second, millisecond) to apply can be null.

Returns:

new instance of ArithmeticOperators.Derivative.

Since:

3.3

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:

new instance of ArithmeticOperators.Divide.

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:

new instance of ArithmeticOperators.Divide.

divideBy

public ArithmeticOperators.Divide divideBy(Number value)

Creates new AggregationExpression that divides the associated number by given value.

Parameters:

value - must not be null.

Returns:

new instance of ArithmeticOperators.Divide.

exp

public ArithmeticOperators.Exp exp()

Creates new AggregationExpression that raises Euler’s number (i.e. e ) on the associated number.

Returns:

new instance of ArithmeticOperators.Exp.

floor

public ArithmeticOperators.Floor floor()

Creates new AggregationExpression that returns the largest integer less than or equal to the associated number.

Returns:

new instance of ArithmeticOperators.Floor.

integral

public ArithmeticOperators.Integral integral()

Creates new AggregationExpression that calculates the approximation for the mathematical integral value.

Returns:

new instance of ArithmeticOperators.Integral.

Since:

3.3

integral

public ArithmeticOperators.Integral integral(SetWindowFieldsOperation.WindowUnit unit)

Creates new AggregationExpression that calculates the approximation for the mathematical integral value.

Parameters:

unit - The time unit (SetWindowFieldsOperation.WindowUnits.WEEK, SetWindowFieldsOperation.WindowUnits.DAY, SetWindowFieldsOperation.WindowUnits.HOUR, SetWindowFieldsOperation.WindowUnits.MINUTE, SetWindowFieldsOperation.WindowUnits.SECOND, SetWindowFieldsOperation.WindowUnits.MILLISECOND) to apply.

Returns:

new instance of ArithmeticOperators.Derivative.

Since:

3.3

integral

public ArithmeticOperators.Integral integral(String unit)

Creates new AggregationExpression that calculates the approximation for the mathematical integral value.

Parameters:

unit - the unit of measure.

Returns:

new instance of ArithmeticOperators.Integral.

Since:

3.3

ln

public ArithmeticOperators.Ln ln()

Creates new AggregationExpression that calculates the natural logarithm ln (i.e loge) of the assoicated number.

Returns:

new instance of ArithmeticOperators.Ln.

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:

new instance of ArithmeticOperators.Log.

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:

new instance of ArithmeticOperators.Log.

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:

new instance of ArithmeticOperators.Log.

log10

public ArithmeticOperators.Log10 log10()

Creates new AggregationExpression that calculates the log base 10 for the associated number.

Returns:

new instance of ArithmeticOperators.Log10.

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:

new instance of ArithmeticOperators.Mod.

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:

new instance of ArithmeticOperators.Mod.

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:

new instance of ArithmeticOperators.Mod.

multiplyBy

public ArithmeticOperators.Multiply multiplyBy(String fieldReference)

Creates new AggregationExpression that multiplies the associated number with another.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ArithmeticOperators.Multiply.

multiplyBy

public ArithmeticOperators.Multiply multiplyBy(AggregationExpression expression)

Creates new AggregationExpression that multiplies the associated number with another.

Parameters:

expression - must not be null.

Returns:

new instance of ArithmeticOperators.Multiply.

multiplyBy

public ArithmeticOperators.Multiply multiplyBy(Number value)

Creates new AggregationExpression that multiplies the associated number with another.

Parameters:

value - must not be null.

Returns:

new instance of ArithmeticOperators.Multiply.

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:

new instance of ArithmeticOperators.Pow.

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:

new instance of ArithmeticOperators.Pow.

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:

new instance of ArithmeticOperators.Pow.

sqrt

public ArithmeticOperators.Sqrt sqrt()

Creates new AggregationExpression that calculates the square root of the associated number.

Returns:

new instance of ArithmeticOperators.Sqrt.

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:

new instance of ArithmeticOperators.Subtract.

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:

new instance of ArithmeticOperators.Subtract.

subtract

public ArithmeticOperators.Subtract subtract(Number value)

Creates new AggregationExpression that subtracts value from the associated number.

Parameters:

value - must not be null.

Returns:

new instance of ArithmeticOperators.Subtract.

trunc

public ArithmeticOperators.Trunc trunc()

Creates new AggregationExpression that truncates a number to its integer.

Returns:

new instance of ArithmeticOperators.Trunc.

sum

public AccumulatorOperators.Sum sum()

Creates new AggregationExpression that calculates and returns the sum of numeric values.

Returns:

new instance of AccumulatorOperators.Sum.

avg

public AccumulatorOperators.Avg avg()

Creates new AggregationExpression that returns the average value of the numeric values.

Returns:

new instance of AccumulatorOperators.Avg.

max

public AccumulatorOperators.Max max()

Creates new AggregationExpression that returns the maximum value.

Returns:

new instance of AccumulatorOperators.Max.

min

public AccumulatorOperators.Min min()

Creates new AggregationExpression that returns the minimum value.

Returns:

new instance of AccumulatorOperators.Min.

stdDevPop

public AccumulatorOperators.StdDevPop stdDevPop()

Creates new AggregationExpression that calculates the population standard deviation of the input values.

Returns:

new instance of AccumulatorOperators.StdDevPop.

stdDevSamp

public AccumulatorOperators.StdDevSamp stdDevSamp()

Creates new AggregationExpression that 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

round

public ArithmeticOperators.Round round()

Creates new AggregationExpression that rounds a number to a whole integer or to a specified decimal place.

Returns:

new instance of ArithmeticOperators.Round.

Since:

3.0

roundToPlace

public ArithmeticOperators.Round roundToPlace(int place)

Creates new AggregationExpression that rounds a number to a specified decimal place.

Returns:

new instance of ArithmeticOperators.Round.

Since:

3.0

sin

public ArithmeticOperators.Sin sin()

Creates new AggregationExpression that calculates the sine of a numeric value given in radians.

Returns:

new instance of ArithmeticOperators.Sin.

Since:

3.3

sin

public ArithmeticOperators.Sin sin(ArithmeticOperators.AngularUnit unit)

Creates new AggregationExpression that calculates the sine of a numeric value in the given unit.

Parameters:

unit - the unit of measure.

Returns:

new instance of ArithmeticOperators.Sin.

Since:

3.3

sinh

public ArithmeticOperators.Sinh sinh()

Creates new AggregationExpression that calculates the sine of a numeric value given in radians.

Returns:

new instance of ArithmeticOperators.Sinh.

Since:

3.3

sinh

public ArithmeticOperators.Sinh sinh(ArithmeticOperators.AngularUnit unit)

Creates new AggregationExpression that calculates the sine of a numeric value.

Parameters:

unit - the unit of measure.

Returns:

new instance of ArithmeticOperators.Sinh.

Since:

3.3

asin

public ArithmeticOperators.ASin asin()

Creates new AggregationExpression that calculates the inverse sine of a numeric value.

Returns:

new instance of ArithmeticOperators.ASin.

Since:

3.3

asinh

public ArithmeticOperators.ASinh asinh()

Creates new AggregationExpression that calculates the inverse hyperbolic sine of a numeric value.

Returns:

new instance of ArithmeticOperators.ASinh.

Since:

3.3

cos

public ArithmeticOperators.Cos cos()

Creates new AggregationExpression that calculates the cosine of a numeric value given in radians.

Returns:

new instance of ArithmeticOperators.Cos.

Since:

3.3

cos

public ArithmeticOperators.Cos cos(ArithmeticOperators.AngularUnit unit)

Creates new AggregationExpression that calculates the cosine of a numeric value in the given unit.

Parameters:

unit - the unit of measure.

Returns:

new instance of ArithmeticOperators.Cos.

Since:

3.3

cosh

public ArithmeticOperators.Cosh cosh()

Creates new AggregationExpression that calculates the hyperbolic cosine of a numeric value given in radians.

Returns:

new instance of ArithmeticOperators.Cosh.

Since:

3.3

cosh

public ArithmeticOperators.Cosh cosh(ArithmeticOperators.AngularUnit unit)

Creates new AggregationExpression that calculates the hyperbolic cosine of a numeric value.

Parameters:

unit - the unit of measure.

Returns:

new instance of ArithmeticOperators.Cosh.

Since:

3.3

acos

public ArithmeticOperators.ACos acos()

Creates new AggregationExpression that calculates the inverse cosine of a numeric value.

Returns:

new instance of ArithmeticOperators.ACos.

Since:

3.4

acosh

public ArithmeticOperators.ACosh acosh()

Creates new AggregationExpression that calculates the inverse hyperbolic cosine of a numeric value.

Returns:

new instance of ArithmeticOperators.ACosh.

Since:

3.4

tan

public ArithmeticOperators.Tan tan()

Creates new AggregationExpression that calculates the tangent of a numeric value given in radians.

Returns:

new instance of ArithmeticOperators.Tan.

Since:

3.3

atan

public ArithmeticOperators.ATan atan()

Creates new AggregationExpression that calculates the inverse tangent of a numeric value.

Returns:

new instance of ArithmeticOperators.ATan.

Since:

3.3

atan2

public ArithmeticOperators.ATan2 atan2(Number value)

Creates new AggregationExpression that calculates the inverse tangent of the the numeric value divided by the given numeric value in the argument.

Parameters:

value - the numeric value

Returns:

new instance of ArithmeticOperators.ATan2.

Since:

3.3

atan2

public ArithmeticOperators.ATan2 atan2(String fieldReference)

Creates new AggregationExpression that calculates the inverse tangent of the the numeric value divided by the given field reference in the argument.

Parameters:

fieldReference - the numeric value

Returns:

new instance of ArithmeticOperators.ATan2.

Since:

3.3

atan2

public ArithmeticOperators.ATan2 atan2(AggregationExpression expression)

Creates new AggregationExpression that calculates the inverse tangent of the the numeric value divided by the given AggregationExpression in the argument.

Parameters:

expression - the expression evaluating to a numeric value

Returns:

new instance of ArithmeticOperators.ATan2.

Since:

3.3

atanh

public ArithmeticOperators.ATanh atanh()

Creates new AggregationExpression that calculates the inverse hyperbolic tangent of a numeric value.

Returns:

new instance of ArithmeticOperators.ATanh.

Since:

3.3

tan

public ArithmeticOperators.Tan tan(ArithmeticOperators.AngularUnit unit)

Creates new AggregationExpression that calculates the tangent of a numeric value in the given unit.

Parameters:

unit - the unit of measure.

Returns:

new instance of ArithmeticOperators.Tan.

Since:

3.3

tanh

public ArithmeticOperators.Tanh tanh()

Creates new AggregationExpression that calculates the hyperbolic tangent of a numeric value given in radians.

Returns:

new instance of ArithmeticOperators.Tan.

Since:

3.3

tanh

public ArithmeticOperators.Tanh tanh(ArithmeticOperators.AngularUnit unit)

Creates new AggregationExpression that calculates the hyperbolic tangent of a numeric value.

Parameters:

unit - the unit of measure.

Returns:

new instance of ArithmeticOperators.Tanh.

Since:

3.3