org.springframework.data.mongodb.core.aggregation

Class AddFieldsOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.AddFieldsOperation

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation, FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

public class AddFieldsOperation
extends Object

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

 AddFieldsOperation.addField("totalHomework").withValue("A+").and().addField("totalQuiz").withValue("B-")
 

Since:

3.0

Author:

Christoph Strobl

See Also:

MongoDB Aggregation Framework: $addFields

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddFieldsOperation.AddFieldsOperationBuilder

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

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AddFieldsOperation	addField(Object field, Object value) Append the value for a specific field to the operation.
static AddFieldsOperation.AddFieldsOperationBuilder.ValueAppender	addField(String field) Concatenate another field to add.
AddFieldsOperation.AddFieldsOperationBuilder	and() Concatenate additional fields to add.
static AddFieldsOperation.AddFieldsOperationBuilder	builder() Define the AddFieldsOperation via AddFieldsOperation.AddFieldsOperationBuilder.
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()
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.FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

inheritsFields

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationOperation

toPipelineStages

Constructor Detail

AddFieldsOperation

public AddFieldsOperation(Object field,
                          @Nullable
                          Object value)

Create new instance of AddFieldsOperation

Parameters:

field - must not be null.

value - can be null.

Method Detail

builder

public static AddFieldsOperation.AddFieldsOperationBuilder builder()

Define the AddFieldsOperation via AddFieldsOperation.AddFieldsOperationBuilder.

Returns:

new instance of AddFieldsOperation.AddFieldsOperationBuilder.

addField

public static AddFieldsOperation.AddFieldsOperationBuilder.ValueAppender addField(String field)

Concatenate another field to add.

Parameters:

field - must not be null.

Returns:

new instance of AddFieldsOperation.AddFieldsOperationBuilder.

addField

public AddFieldsOperation addField(Object field,
                                   Object value)

Append the value for a specific field to the operation.

Parameters:

field - the target field to add.

value - the value to assign.

Returns:

new instance of AddFieldsOperation.

and

public AddFieldsOperation.AddFieldsOperationBuilder and()

Concatenate additional fields to add.

Returns:

new instance of AddFieldsOperation.AddFieldsOperationBuilder.

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.