Class ArithmeticOperators.Round
java.lang.Object
org.springframework.data.mongodb.core.aggregation.ArithmeticOperators.Round
- All Implemented Interfaces:
AggregationExpression
,MongoExpression
- Enclosing class:
- ArithmeticOperators
ArithmeticOperators.Round
rounds a number to a whole integer or to a specified decimal place.
- If
place(int)
resolves to a positive integer,$round
rounds to the given decimal places. - If
place(int)
resolves to a negative integer,$round
rounds to the left of the decimal. - If
place(int)
resolves to a zero,$round
rounds using the first digit to the right of the decimal.
- Since:
- 3.0
-
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
place
(int place) The place to round to.The place to round to defined by via a field reference that resolves to an integer between -20 and 100, exclusive.placeOf
(AggregationExpression expression) The place to round to defined by an expression that resolves to an integer between -20 and 100, exclusive.static ArithmeticOperators.Round
Round the given numeric (integer, double, decimal, or long) value.static ArithmeticOperators.Round
roundValueOf
(String fieldReference) Round the value of the field that resolves to an integer, double, decimal, or long.static ArithmeticOperators.Round
roundValueOf
(AggregationExpression expression) Round the outcome of the given expression hat resolves to an integer, double, decimal, or long.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
-
roundValueOf
Round the value of the field that resolves to an integer, double, decimal, or long.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Round
.
-
roundValueOf
Round the outcome of the given expression hat resolves to an integer, double, decimal, or long.- Parameters:
expression
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Round
.
-
round
Round the given numeric (integer, double, decimal, or long) value.- Parameters:
value
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Round
.
-
place
The place to round to. Can be between -20 and 100, exclusive.- Parameters:
place
- value between -20 and 100, exclusive.- Returns:
- new instance of
ArithmeticOperators.Round
.
-
placeOf
The place to round to defined by an expression that resolves to an integer between -20 and 100, exclusive.- Parameters:
expression
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Round
.
-
placeOf
The place to round to defined by via a field reference that resolves to an integer between -20 and 100, exclusive.- Parameters:
fieldReference
- must not be null.- Returns:
- new instance of
ArithmeticOperators.Round
.
-
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
-