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

Class ReplaceRootOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.ReplaceRootOperation

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation

Direct Known Subclasses:

ReplaceRootOperation.ReplaceRootDocumentOperation, ReplaceWithOperation

public class ReplaceRootOperation
extends Object
implements FieldsExposingAggregationOperation

Encapsulates the aggregation framework $replaceRoot-operation.
We recommend to use the static factory method Aggregation.replaceRoot(String) instead of creating instances of this class directly.

Since:

1.10

Author:

Mark Paluch, Christoph Strobl

See Also:

• MongoDB Aggregation Framework: $replaceRoot

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReplaceRootOperation.Replacement	Replacement object that results in a replacement document or an expression that results in a document.
static class	ReplaceRootOperation.ReplaceRootDocumentOperation	Encapsulates the aggregation framework $replaceRoot-operation to result in a composable replacement document.
static class	ReplaceRootOperation.ReplaceRootDocumentOperationBuilder	Builder for ReplaceRootOperation.ReplaceRootDocumentOperation to populate ReplaceRootOperation.ReplacementDocument
static class	ReplaceRootOperation.ReplaceRootOperationBuilder	Builder for ReplaceRootOperation.

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

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

Constructor	Description
ReplaceRootOperation(AggregationExpression aggregationExpression)	Creates a new ReplaceRootOperation given the AggregationExpression pointing to a document.
ReplaceRootOperation(Field field)	Creates a new ReplaceRootOperation given the Field field name.
ReplaceRootOperation(ReplaceRootOperation.Replacement replacement)	Creates a new ReplaceRootOperation given the ReplaceRootOperation.Replacement.

Method Summary

Modifier and Type	Method	Description
static ReplaceRootOperation.ReplaceRootOperationBuilder	builder()	Creates a new ReplaceRootOperation.ReplaceRootDocumentOperationBuilder.
ExposedFields	getFields()	Returns the fields exposed by the AggregationOperation.
String	getOperator()	Return the MongoDB operator that is used for this AggregationOperation.
protected ReplaceRootOperation.Replacement	getReplacement()	Obtain the ReplaceRootOperation.Replacement.
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

inheritsFields

Constructor Details

ReplaceRootOperation

public ReplaceRootOperation(Field field)

Creates a new ReplaceRootOperation given the Field field name.

Parameters:

field - must not be null or empty.

ReplaceRootOperation

public ReplaceRootOperation(AggregationExpression aggregationExpression)

Creates a new ReplaceRootOperation given the AggregationExpression pointing to a document.

Parameters:

aggregationExpression - must not be null.

ReplaceRootOperation

public ReplaceRootOperation(ReplaceRootOperation.Replacement replacement)

Creates a new ReplaceRootOperation given the ReplaceRootOperation.Replacement.

Parameters:

replacement - must not be null.

Method Details

builder

public static ReplaceRootOperation.ReplaceRootOperationBuilder builder()

Creates a new ReplaceRootOperation.ReplaceRootDocumentOperationBuilder.

Returns:

a new ReplaceRootOperation.ReplaceRootDocumentOperationBuilder.

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.

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.

getReplacement

protected ReplaceRootOperation.Replacement getReplacement()

Obtain the ReplaceRootOperation.Replacement.

Returns:

never null.

Since:

3.0