org.springframework.data.mongodb.core.aggregation

Class ReplaceRootOperation

java.lang.Object

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

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation

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 and Description
static interface	ReplaceRootOperation.Replacement Replacement object that results in a replacement document or an expression that results in a document.
static class	ReplaceRootOperation.ReplaceRootDocumentOperationBuilder Builder for ReplaceRootDocumentOperation to populate 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 and 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 and Description
static ReplaceRootOperation.ReplaceRootOperationBuilder	builder() Creates a new ReplaceRootOperation.ReplaceRootDocumentOperationBuilder.
ExposedFields	getFields() Returns the fields exposed by the AggregationOperation.
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

inheritsFields

Constructor Detail

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 Detail

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

Returns:

the Document

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.