Module spring.data.mongodb

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

Class ArithmeticOperators.Round

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ArithmeticOperators.Round

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ArithmeticOperators

public static class ArithmeticOperators.Round
extends Object

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 Type	Method	Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)
protected Map<String,Object>	append(String key, Object value)
protected Map<String,Object>	appendAt(int index, String key, Object value)	Append the given key at the position in the underlying LinkedHashMap.
protected Map<String,Object>	appendTo(String key, Object value)
protected Map<String,Object>	argumentMap()	Get the argument map.
protected static List<Field>	asFields(String... fieldRefs)
protected boolean	contains(Object key)	Check if the given key is available.
protected <T> T	get(int index)	Get the value at a given index.
protected <T> T	get(Object key)	Get the value for a given key.
protected String	getMongoMethod()
protected boolean	isArgumentMap()
ArithmeticOperators.Round	place(int place)	The place to round to.
ArithmeticOperators.Round	placeOf(String fieldReference)	The place to round to defined by via a field reference that resolves to an integer between -20 and 100, exclusive.
ArithmeticOperators.Round	placeOf(AggregationExpression expression)	The place to round to defined by an expression that resolves to an integer between -20 and 100, exclusive.
protected Map<String,Object>	remove(String key)
static ArithmeticOperators.Round	round(Number value)	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)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
protected List<Object>	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

public static ArithmeticOperators.Round roundValueOf(String fieldReference)

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

public static ArithmeticOperators.Round roundValueOf(AggregationExpression expression)

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

public static ArithmeticOperators.Round round(Number value)

Round the given numeric (integer, double, decimal, or long) value.

Parameters:

value - must not be null.

Returns:

new instance of ArithmeticOperators.Round.

place

public ArithmeticOperators.Round place(int 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

public ArithmeticOperators.Round placeOf(AggregationExpression expression)

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

public ArithmeticOperators.Round placeOf(String fieldReference)

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

protected String getMongoMethod()

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationExpression

Turns the AggregationExpression into a Document within the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationExpression

Parameters:

context - must not be null.

Returns:

the MongoDB native (Document) form of the expression.

toDocument

public org.bson.Document toDocument(Object value,
 AggregationOperationContext context)

asFields

protected static List<Field> asFields(String... fieldRefs)

append

protected List<Object> append(Object value,
 org.springframework.data.mongodb.core.aggregation.AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

protected Map<String,Object> append(String key,
 Object value)

appendTo

protected Map<String,Object> appendTo(String key,
 Object value)

remove

protected Map<String,Object> remove(String key)

appendAt

protected Map<String,Object> appendAt(int index,
 String key,
 Object value)

Append the given key at the position in the underlying LinkedHashMap.

Parameters:

index -

key -

value -

Returns:

Since:

3.1

values

protected List<Object> 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

protected <T> T get(Object key)

Get the value for a given key.

Type Parameters:

T -

Parameters:

key -

Returns:

Since:

2.1

isArgumentMap

protected boolean isArgumentMap()

argumentMap

protected Map<String,Object> argumentMap()

Get the argument map.

Returns:

Since:

2.1

contains

protected boolean contains(Object key)

Check if the given key is available.

Parameters:

key -

Returns:

Since:

2.1