org.springframework.data.mongodb.core.aggregation

Class ArithmeticOperators.Mod

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ArithmeticOperators

public static class ArithmeticOperators.Mod
extends Object

AggregationExpression for $mod.

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractAggregationExpression.Expand Expand a nested list of values to single entries or keep the list.

Method Summary

Modifier and Type	Method and Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, 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>	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()
ArithmeticOperators.Mod	mod(AggregationExpression expression) Use evaluated value of the given AggregationExpression as mod base.
ArithmeticOperators.Mod	mod(Number base) Use the given value as mod base.
ArithmeticOperators.Mod	mod(String fieldReference) Use the value stored at the given field as mod base.
protected Map<String,Object>	remove(String key)
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationExpression into a Document within the given AggregationOperationContext.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
static ArithmeticOperators.Mod	valueOf(AggregationExpression expression) Creates new ArithmeticOperators.Mod.
static ArithmeticOperators.Mod	valueOf(Number value) Creates new ArithmeticOperators.Mod.
static ArithmeticOperators.Mod	valueOf(String fieldReference) Creates new ArithmeticOperators.Mod.
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

from, toDocument

Methods inherited from interface org.springframework.data.mongodb.MongoExpression

create, create

Method Detail

getMongoMethod

protected String getMongoMethod()

valueOf

public static ArithmeticOperators.Mod valueOf(String fieldReference)

Creates new ArithmeticOperators.Mod.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ArithmeticOperators.Mod.

valueOf

public static ArithmeticOperators.Mod valueOf(AggregationExpression expression)

Creates new ArithmeticOperators.Mod.

Parameters:

expression - must not be null.

Returns:

new instance of ArithmeticOperators.Mod.

valueOf

public static ArithmeticOperators.Mod valueOf(Number value)

Creates new ArithmeticOperators.Mod.

Parameters:

value - must not be null.

Returns:

new instance of ArithmeticOperators.Mod.

mod

public ArithmeticOperators.Mod mod(String fieldReference)

Use the value stored at the given field as mod base.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ArithmeticOperators.Mod.

mod

public ArithmeticOperators.Mod mod(AggregationExpression expression)

Use evaluated value of the given AggregationExpression as mod base.

Parameters:

expression - must not be null.

Returns:

new instance of ArithmeticOperators.Mod.

mod

public ArithmeticOperators.Mod mod(Number base)

Use the given value as mod base.

Parameters:

base - must not be null.

Returns:

new instance of ArithmeticOperators.Mod.

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,
                              AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

protected Map<String,Object> append(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

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