Class ArithmeticOperators.ATan2
java.lang.Object
org.springframework.data.mongodb.core.aggregation.ArithmeticOperators.ATan2
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- ArithmeticOperators
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.- Since:
- 3.3
- Author:
- Divya Srivastava
-
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.Creates a newAggregationExpression
that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.Creates a newAggregationExpression
that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.atan2of
(AggregationExpression expression) Creates a newAggregationExpression
that calculates the hyperbolic tangent of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.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
org.bson.Document
toDocument
(Object value, AggregationOperationContext context) org.bson.Document
toDocument
(AggregationOperationContext context) static ArithmeticOperators.ATan2
Creates a newAggregationExpression
that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.static ArithmeticOperators.ATan2
valueOf
(AggregationExpression expression) Creates a newAggregationExpression
that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.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
-
valueOf
Creates a newAggregationExpression
that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.- Parameters:
fieldReference
- the name of thefield
that resolves to a numeric value.- Returns:
- new instance of
ArithmeticOperators.ATan2
.
-
valueOf
Creates a newAggregationExpression
that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.- Parameters:
expression
- theexpression
that resolves to a numeric value.- Returns:
- new instance of
ArithmeticOperators.ATan2
.
-
atan2of
Creates a newAggregationExpression
that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.- Parameters:
fieldReference
- anything (field
,expression
, ...) that resolves to a numeric value.- Returns:
- new instance of
ArithmeticOperators.ATan2
.
-
atan2of
Creates a newAggregationExpression
that calculates the hyperbolic tangent of a value that is measured inArithmeticOperators.AngularUnit.RADIANS
.- Parameters:
expression
- anything (field
,expression
, ...) that resolves to a numeric value.- Returns:
- new instance of
ArithmeticOperators.ATan2
.
-
atan2of
Creates a newAggregationExpression
that calculates the inverse tangent of of y / x, where y and x are the first and second values passed to the expression respectively.- Parameters:
value
- of typeNumber
- Returns:
- new instance of
ArithmeticOperators.ATan2
.
-
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
-