Module spring.data.mongodb

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

Class SetOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.SetOperation

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation, FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

public class SetOperation
extends Object

Adds new fields to documents. $set outputs documents that contain all existing fields from the input documents and newly added fields.

 SetOperation.set("totalHomework").toValue("A+").and().set("totalQuiz").toValue("B-")
 

Since:

3.0

Author:

Christoph Strobl

See Also:

• MongoDB Aggregation Framework: $set

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SetOperation.FieldAppender

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

Constructor	Description
SetOperation(Object field, Object value)	Create new instance of SetOperation

Method Summary

Modifier and Type	Method	Description
SetOperation.FieldAppender	and()	Concatenate additional fields to set.
static SetOperation.FieldAppender	builder()	Define the SetOperation via SetOperation.FieldAppender.
ExposedFields	getFields()	Returns the fields exposed by the AggregationOperation.
String	getOperator()	Return the MongoDB operator that is used for this AggregationOperation.
protected Map<Object,Object>	getValueMap()
protected String	mongoOperator()
SetOperation	set(Object field, Object value)	Append the value for a specific field to the operation.
static SetOperation.FieldAppender.ValueAppender	set(String field)	Concatenate another field to set.
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

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.AggregationOperation

toPipelineStages

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

inheritsFields

Constructor Details

SetOperation

public SetOperation(Object field,
 @Nullable
 Object value)

Create new instance of SetOperation

Parameters:

field - must not be null.

value - can be null.

Method Details

builder

public static SetOperation.FieldAppender builder()

Define the SetOperation via SetOperation.FieldAppender.

Returns:

new instance of SetOperation.FieldAppender.

set

public static SetOperation.FieldAppender.ValueAppender set(String field)

Concatenate another field to set.

Parameters:

field - must not be null.

Returns:

new instance of SetOperation.FieldAppender.ValueAppender.

set

public SetOperation set(Object field,
 Object value)

Append the value for a specific field to the operation.

Parameters:

field - the target field to set.

value - the value to assign.

Returns:

new instance of SetOperation.

and

public SetOperation.FieldAppender and()

Concatenate additional fields to set.

Returns:

new instance of SetOperation.FieldAppender.

mongoOperator

protected String mongoOperator()

Returns:

the String representation of the native MongoDB operator.

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the Document

getOperator

public String getOperator()

Description copied from interface: AggregationOperation

Return the MongoDB operator that is used for this AggregationOperation. Aggregation operations should implement this method to avoid document rendering.

Specified by:

getOperator in interface AggregationOperation

Returns:

the operator used for this AggregationOperation.

getValueMap

protected Map<Object,Object> getValueMap()

Returns:

the raw value map

getFields

public ExposedFields getFields()

Description copied from interface: FieldsExposingAggregationOperation

Returns the fields exposed by the AggregationOperation.

Specified by:

getFields in interface FieldsExposingAggregationOperation

Returns:

will never be null.