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

Class ArithmeticOperators.Subtract

java.lang.Object

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

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ArithmeticOperators

public static class ArithmeticOperators.Subtract
extends Object

AggregationExpression for $subtract.

Author:

Christoph Strobl

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()
protected Map<String,Object>	remove(String key)
ArithmeticOperators.Subtract	subtract(Number value)	Subtract the given value.
ArithmeticOperators.Subtract	subtract(String fieldReference)	Subtract the value stored at the given field.
ArithmeticOperators.Subtract	subtract(AggregationExpression expression)	Subtract the evaluated value of the given AggregationExpression.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
static ArithmeticOperators.Subtract	valueOf(Number value)	Creates new ArithmeticOperators.Subtract.
static ArithmeticOperators.Subtract	valueOf(String fieldReference)	Creates new ArithmeticOperators.Subtract.
static ArithmeticOperators.Subtract	valueOf(AggregationExpression expression)	Creates new ArithmeticOperators.Subtract.
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

getMongoMethod

protected String getMongoMethod()

valueOf

public static ArithmeticOperators.Subtract valueOf(String fieldReference)

Creates new ArithmeticOperators.Subtract.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ArithmeticOperators.Subtract.

valueOf

public static ArithmeticOperators.Subtract valueOf(AggregationExpression expression)

Creates new ArithmeticOperators.Subtract.

Parameters:

expression - must not be null.

Returns:

new instance of ArithmeticOperators.Subtract.

valueOf

public static ArithmeticOperators.Subtract valueOf(Number value)

Creates new ArithmeticOperators.Subtract.

Parameters:

value - must not be null.

Returns:

new instance of ArithmeticOperators.Subtract.

subtract

public ArithmeticOperators.Subtract subtract(String fieldReference)

Subtract the value stored at the given field.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ArithmeticOperators.Pow.

subtract

public ArithmeticOperators.Subtract subtract(AggregationExpression expression)

Subtract the evaluated value of the given AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of ArithmeticOperators.Pow.

subtract

public ArithmeticOperators.Subtract subtract(Number value)

Subtract the given value.

Parameters:

value - must not be null.

Returns:

new instance of ArithmeticOperators.Pow.

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