org.springframework.data.mongodb.core.aggregation

Class AggregationPipeline

java.lang.Object

org.springframework.data.mongodb.core.aggregation.AggregationPipeline

public class AggregationPipeline
extends Object

The AggregationPipeline holds the collection of aggregation stages.

Since:

3.0.2

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
AggregationPipeline() Create an empty pipeline
AggregationPipeline(List<AggregationOperation> aggregationOperations) Create a new pipeline with given stages.

Method Summary

Modifier and Type	Method and Description
AggregationPipeline	add(AggregationOperation aggregationOperation) Append the given stage to the pipeline.
List<AggregationOperation>	getOperations() Get the list of aggregation stages.
boolean	isOutOrMerge()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AggregationPipeline

public AggregationPipeline()

Create an empty pipeline

AggregationPipeline

public AggregationPipeline(List<AggregationOperation> aggregationOperations)

Create a new pipeline with given stages.

Parameters:

aggregationOperations - must not be null.

Method Detail

add

public AggregationPipeline add(AggregationOperation aggregationOperation)

Append the given stage to the pipeline.

Parameters:

aggregationOperation - must not be null.

Returns:

this.

getOperations

public List<AggregationOperation> getOperations()

Get the list of aggregation stages.

Returns:

never null.

isOutOrMerge

public boolean isOutOrMerge()

Returns:

true if the last aggregation stage is either $out or $merge.