Class ArithmeticOperators.Cosh
java.lang.Object
org.springframework.data.mongodb.core.aggregation.ArithmeticOperators.Cosh
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- ArithmeticOperators
An
expression
that calculates the hyperbolic cosine of a value that is measured in
ArithmeticOperators.AngularUnit.RADIANS
.- Since:
- 3.3
- Author:
- Christoph Strobl
-
Method Summary
Modifier and TypeMethodDescriptionappend
(Object value, org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList) Append the given key at the position in the underlyingLinkedHashMap
.Get the argument map.protected boolean
Check if the given key is available.static ArithmeticOperators.Cosh
Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.static ArithmeticOperators.Cosh
cosh
(Object value, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured in the givenunit
.static ArithmeticOperators.Cosh
Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.static ArithmeticOperators.Cosh
coshOf
(String fieldReference, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured in the givenunit
.static ArithmeticOperators.Cosh
coshOf
(AggregationExpression expression) Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.static ArithmeticOperators.Cosh
coshOf
(AggregationExpression expression, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured in the givenunit
.protected <T> T
get
(int index) Get the value at a given index.protected <T> T
Get the value for a given key.protected String
protected boolean
org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) values()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationExpression
toDocument
-
Method Details
-
coshOf
Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.- Parameters:
fieldReference
- the name of thefield
that resolves to a numeric value.- Returns:
- new instance of
ArithmeticOperators.Cosh
.
-
coshOf
public static ArithmeticOperators.Cosh coshOf(String fieldReference, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured in the givenunit
.
UsecoshOf("angle", DEGREES)
as shortcut for{ $cosh : { $degreesToRadians : "$angle" } }
- Parameters:
fieldReference
- the name of thefield
that resolves to a numeric value.unit
- the unit of measure used by the value of the given field.- Returns:
- new instance of
ArithmeticOperators.Cosh
.
-
coshOf
Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.
UsesinhOf("angle", DEGREES)
as shortcut for eg.sinhOf(ConvertOperators.valueOf("angle").degreesToRadians())
.- Parameters:
expression
- theexpression
that resolves to a numeric value.- Returns:
- new instance of
ArithmeticOperators.Cosh
.
-
coshOf
public static ArithmeticOperators.Cosh coshOf(AggregationExpression expression, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured in the givenunit
.- Parameters:
expression
- theexpression
that resolves to a numeric value.unit
- the unit of measure used by the value of the given field.- Returns:
- new instance of
ArithmeticOperators.Cosh
.
-
cosh
Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.- Parameters:
value
- anything (field
,expression
, ...) that resolves to a numeric value.- Returns:
- new instance of
ArithmeticOperators.Cosh
.
-
cosh
Creates a newAggregationExpression
that calculates the hyperbolic cosine of a value that is measured in the givenunit
.- Parameters:
value
- anything (field
,expression
, ...) that resolves to a numeric valueunit
- the unit of measure used by the value of the given field.- Returns:
- new instance of
ArithmeticOperators.Cosh
.
-
getMongoMethod
-
toDocument
Description copied from interface:AggregationExpression
- Specified by:
toDocument
in interfaceAggregationExpression
- Parameters:
context
- must not be null.- Returns:
- the MongoDB native (
Document
) form of the expression.
-
toDocument
-
asFields
-
append
-
append
-
append
-
appendTo
-
remove
-
appendAt
Append the given key at the position in the underlyingLinkedHashMap
.- Parameters:
index
-key
-value
-- Returns:
- Since:
- 3.1
-
values
-
get
protected <T> T get(int index) Get the value at a given index.- Type Parameters:
T
-- Parameters:
index
-- Returns:
- Since:
- 2.1
-
get
Get the value for a given key.- Type Parameters:
T
-- Parameters:
key
-- Returns:
- Since:
- 2.1
-
isArgumentMap
protected boolean isArgumentMap() -
argumentMap
Get the argument map.- Returns:
- Since:
- 2.1
-
contains
Check if the given key is available.- Parameters:
key
-- Returns:
- Since:
- 2.1
-