Module spring.data.mongodb

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

Class BucketOperationSupport<T extends BucketOperationSupport<T,B>,B extends BucketOperationSupport.OutputBuilder<B,T>>

java.lang.Object

org.springframework.data.mongodb.core.aggregation.BucketOperationSupport<T,B>

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation

Direct Known Subclasses:

BucketAutoOperation, BucketOperation

public abstract class BucketOperationSupport<T extends BucketOperationSupport<T,B>,B extends BucketOperationSupport.OutputBuilder<B,T>>
extends Object
implements FieldsExposingAggregationOperation

Base class for bucket operations that support output expressions the aggregation framework.
Bucket stages collect documents into buckets and can contribute output fields.
Implementing classes are required to provide an BucketOperationSupport.OutputBuilder.

Since:

1.10

Author:

Mark Paluch, Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BucketOperationSupport.ExpressionBucketOperationBuilderSupport<B extends BucketOperationSupport.OutputBuilder<B,T>,T extends BucketOperationSupport<T,B>>	Builder for SpEL expression-based BucketOperationSupport.Output.
protected static class	BucketOperationSupport.OperationOutput	Output field that uses a Mongo operation (expression object) to generate an output field value.
protected static class	BucketOperationSupport.Output	Encapsulates an output field in a bucket aggregation stage.
static class	BucketOperationSupport.OutputBuilder<B extends BucketOperationSupport.OutputBuilder<B,T>,T extends BucketOperationSupport<T,B>>	Base class for BucketOperationSupport.Output builders that result in a BucketOperationSupport providing the built BucketOperationSupport.Output.
protected static class	BucketOperationSupport.Outputs	Encapsulates BucketOperationSupport.Outputs.

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

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BucketOperationSupport(AggregationExpression groupByExpression)	Creates a new BucketOperationSupport given a group-by expression.
protected	BucketOperationSupport(BucketOperationSupport<?,?> operationSupport)	Creates a copy of BucketOperationSupport.
protected	BucketOperationSupport(BucketOperationSupport<?,?> operationSupport, BucketOperationSupport.Outputs outputs)	Creates a copy of BucketOperationSupport and applies the new BucketOperationSupport.Outputs.
protected	BucketOperationSupport(Field groupByField)	Creates a new BucketOperationSupport given a group-by field.

Method Summary

Modifier and Type	Method	Description
abstract B	andOutput(String fieldName)	Creates a new BucketOperationSupport given fieldName to add an output field to the resulting bucket documents.
abstract B	andOutput(AggregationExpression expression)	Creates a new BucketOperationSupport given an AggregationExpression to add an output field to the resulting bucket documents.
protected T	andOutput(BucketOperationSupport.Output output)
B	andOutputCount()	Creates a new BucketOperationSupport given to add a count field to the resulting bucket documents.
abstract BucketOperationSupport.ExpressionBucketOperationBuilderSupport<B,T>	andOutputExpression(String expression, Object... params)	Creates a new BucketOperationSupport.ExpressionBucketOperationBuilderSupport given a SpEL expression and optional params to add an output field to the resulting bucket documents.
ExposedFields	getFields()	Returns the fields exposed by the AggregationOperation.
protected abstract T	newBucketOperation(BucketOperationSupport.Outputs outputs)	Implementation hook to create a new bucket operation.
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

getOperator, toPipelineStages

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

inheritsFields

Constructor Details

BucketOperationSupport

protected BucketOperationSupport(Field groupByField)

Creates a new BucketOperationSupport given a group-by field.

Parameters:

groupByField - must not be null.

BucketOperationSupport

protected BucketOperationSupport(AggregationExpression groupByExpression)

Creates a new BucketOperationSupport given a group-by expression.

Parameters:

groupByExpression - must not be null.

BucketOperationSupport

protected BucketOperationSupport(BucketOperationSupport<?,?> operationSupport)

Creates a copy of BucketOperationSupport.

Parameters:

operationSupport - must not be null.

BucketOperationSupport

protected BucketOperationSupport(BucketOperationSupport<?,?> operationSupport,
 BucketOperationSupport.Outputs outputs)

Creates a copy of BucketOperationSupport and applies the new BucketOperationSupport.Outputs.

Parameters:

operationSupport - must not be null.

outputs - must not be null.

Method Details

andOutputExpression

public abstract BucketOperationSupport.ExpressionBucketOperationBuilderSupport<B,T> andOutputExpression(String expression,
 Object... params)

Creates a new BucketOperationSupport.ExpressionBucketOperationBuilderSupport given a SpEL expression and optional params to add an output field to the resulting bucket documents.

Parameters:

expression - the SpEL expression, must not be null or empty.

params - must not be null

Returns:

new instance of BucketOperationSupport.ExpressionBucketOperationBuilderSupport to create BucketOperation.

andOutput

public abstract B andOutput(AggregationExpression expression)

Creates a new BucketOperationSupport given an AggregationExpression to add an output field to the resulting bucket documents.

Parameters:

expression - the SpEL expression, must not be null or empty.

Returns:

never null.

andOutput

public abstract B andOutput(String fieldName)

Creates a new BucketOperationSupport given fieldName to add an output field to the resulting bucket documents. BucketOperationSupport exposes accumulation operations that can be applied to fieldName.

Parameters:

fieldName - must not be null or empty.

Returns:

never null.

andOutputCount

public B andOutputCount()

Creates a new BucketOperationSupport given to add a count field to the resulting bucket documents.

Returns:

never null.

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

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.

newBucketOperation

protected abstract T newBucketOperation(BucketOperationSupport.Outputs outputs)

Implementation hook to create a new bucket operation.

Parameters:

outputs - the outputs

Returns:

the new bucket operation.

andOutput

protected T andOutput(BucketOperationSupport.Output output)