Class ArithmeticOperators.Sin
java.lang.Object
org.springframework.data.mongodb.core.aggregation.ArithmeticOperators.Sin
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- ArithmeticOperators
An
expression
that calculates the sine of a value that is measured in 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.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
static ArithmeticOperators.Sin
Creates a newAggregationExpression
that calculates the sine of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.static ArithmeticOperators.Sin
sin
(Object value, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the sine of a value that is measured in the givenunit
.static ArithmeticOperators.Sin
Creates a newAggregationExpression
that calculates the sine of a value that is measured inradians
.static ArithmeticOperators.Sin
sinOf
(String fieldReference, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the sine of a value that is measured in the givenunit
.static ArithmeticOperators.Sin
sinOf
(AggregationExpression expression) Creates a newAggregationExpression
that calculates the sine of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.static ArithmeticOperators.Sin
sinOf
(AggregationExpression expression, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the sine of a value that is measured in the givenunit
.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
-
sinOf
Creates a newAggregationExpression
that calculates the sine of a value that is measured inradians
.
UsesinhOf("angle", DEGREES)
as shortcut for{ $sinh : { $degreesToRadians : "$angle" } }
.- Parameters:
fieldReference
- the name of thefield
that resolves to a numeric value.- Returns:
- new instance of
ArithmeticOperators.Sin
.
-
sinOf
public static ArithmeticOperators.Sin sinOf(String fieldReference, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the sine of a value that is measured in the givenunit
.- 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.Sin
.
-
sinOf
Creates a newAggregationExpression
that calculates the sine of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.- Parameters:
expression
- theexpression
that resolves to a numeric value.- Returns:
- new instance of
ArithmeticOperators.Sin
.
-
sinOf
public static ArithmeticOperators.Sin sinOf(AggregationExpression expression, ArithmeticOperators.AngularUnit unit) Creates a newAggregationExpression
that calculates the sine 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.Sin
.
-
sin
Creates a newAggregationExpression
that calculates the sine 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.Sin
.
-
sin
Creates a newAggregationExpression
that calculates the sine of a value that is measured in the givenunit
.- Parameters:
value
- anything (field
,expression
, ...) that resolves to a numeric value.unit
- the unit of measure used by the value of the given field.- Returns:
- new instance of
ArithmeticOperators.Sin
.
-
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
-