Module spring.data.mongodb

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

Interface AggregationOperation

All Known Subinterfaces:

FieldsExposingAggregationOperation, FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

All Known Implementing Classes:

AddFieldsOperation, BucketAutoOperation, BucketOperation, BucketOperationSupport, CountOperation, DensifyOperation, FacetOperation, GeoNearOperation, GraphLookupOperation, GroupOperation, LimitOperation, LookupOperation, MatchOperation, MergeOperation, OutOperation, ProjectionOperation, ProjectionOperation.ExpressionProjectionOperationBuilder, ProjectionOperation.ProjectionOperationBuilder, RedactOperation, ReplaceRootOperation, ReplaceRootOperation.ReplaceRootDocumentOperation, ReplaceWithOperation, SampleOperation, SetOperation, SetWindowFieldsOperation, SkipOperation, SortByCountOperation, SortOperation, UnionWithOperation, UnsetOperation, UnwindOperation

public interface AggregationOperation

Represents one single operation in an aggregation pipeline.

Since:

1.3

Author:

Sebastian Herold, Thomas Darimont, Oliver Gierke, Christoph Strobl

Method Summary

Modifier and Type	Method	Description
default String	getOperator()	Return the MongoDB operator that is used for this AggregationOperation.
org.bson.Document	toDocument(AggregationOperationContext context)	Deprecated. since 2.2 in favor of toPipelineStages(AggregationOperationContext).
default List<org.bson.Document>	toPipelineStages(AggregationOperationContext context)	Turns the AggregationOperation into list of stages by using the given AggregationOperationContext.

Method Details

toDocument

@Deprecated
org.bson.Document toDocument(AggregationOperationContext context)

Deprecated.

since 2.2 in favor of toPipelineStages(AggregationOperationContext).

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

Parameters:

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

Returns:

the Document

toPipelineStages

default List<org.bson.Document> toPipelineStages(AggregationOperationContext context)

Turns the AggregationOperation into list of stages by using the given AggregationOperationContext. This allows a single AggregationOptions to add additional stages for eg. $sort or $limit.

Parameters:

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

Returns:

the pipeline stages to run through. Never null.

Since:

2.2

getOperator

default String getOperator()

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

Returns:

the operator used for this AggregationOperation.

Since:

3.0.2