Module spring.data.mongodb

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

Class ObjectOperators.SetField

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ObjectOperators.SetField

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

ObjectOperators

public static class ObjectOperators.SetField
extends Object

AggregationExpression for $setField.

Since:

4.0

Author:

Christoph Strobl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SetField(Object value)

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.
static ObjectOperators.SetField	field(String fieldName)	Creates new aggregation expression that takes the value pointed to by given input fieldName.
static ObjectOperators.SetField	field(Field field)	Creates new aggregation expression that takes the value pointed to by given input Field.
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()
ObjectOperators.SetField	input(String fieldRef)	Creates new aggregation expression that takes the value pointed to by given input field reference.
ObjectOperators.SetField	input(AggregationExpression expression)	Creates new aggregation expression that takes the value pointed to by given input AggregationExpression.
protected boolean	isArgumentMap()
protected Map<String,Object>	remove(String key)
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
ObjectOperators.SetField	toValue(Object value)	Creates new aggregation expression providing the value.
ObjectOperators.SetField	toValueOf(String fieldReference)	Creates new aggregation expression providing the value using fieldReference.
ObjectOperators.SetField	toValueOf(AggregationExpression expression)	Creates new aggregation expression providing the value using AggregationExpression.
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

Constructor Details

SetField

protected SetField(Object value)

Method Details

field

public static ObjectOperators.SetField field(String fieldName)

Creates new aggregation expression that takes the value pointed to by given input fieldName.

Parameters:

fieldName - must not be null.

Returns:

new instance of ObjectOperators.SetField.

field

public static ObjectOperators.SetField field(Field field)

Creates new aggregation expression that takes the value pointed to by given input Field.

Parameters:

field - must not be null.

Returns:

new instance of ObjectOperators.SetField.

input

public ObjectOperators.SetField input(String fieldRef)

Creates new aggregation expression that takes the value pointed to by given input field reference.

Parameters:

fieldRef - must not be null.

Returns:

new instance of ObjectOperators.GetField.

input

public ObjectOperators.SetField input(AggregationExpression expression)

Creates new aggregation expression that takes the value pointed to by given input AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of ObjectOperators.SetField.

toValueOf

public ObjectOperators.SetField toValueOf(String fieldReference)

Creates new aggregation expression providing the value using fieldReference.

Parameters:

fieldReference - must not be null.

Returns:

new instance of ObjectOperators.SetField.

toValueOf

public ObjectOperators.SetField toValueOf(AggregationExpression expression)

Creates new aggregation expression providing the value using AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of ObjectOperators.SetField.

toValue

public ObjectOperators.SetField toValue(Object value)

Creates new aggregation expression providing the value.

Parameters:

value -

Returns:

new instance of ObjectOperators.SetField.

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.

getMongoMethod

protected String getMongoMethod()

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