Class BucketOperationSupport.OperationOutput

java.lang.Object

org.springframework.data.mongodb.core.aggregation.BucketOperationSupport.Output

org.springframework.data.mongodb.core.aggregation.BucketOperationSupport.OperationOutput

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

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

protected static class BucketOperationSupport.OperationOutput
extends BucketOperationSupport.Output

Output field that uses a Mongo operation (expression object) to generate an output field value.
BucketOperationSupport.OperationOutput is used either with a regular field name or an operation keyword (e.g. $sum, $count).

Since:

1.10

Author:

Mark Paluch

Constructor Summary

Constructors

Constructor	Description
OperationOutput(String operation, Collection<? extends Object> values)	Creates a new BucketOperationSupport.Output for the given field.

Method Summary

Modifier and Type	Method	Description
protected Field	getField()	Returns the field that holds the ProjectionOperation.ProjectionOperationBuilder.OperationProjection.
protected List<Object>	getOperationArguments(AggregationOperationContext context)
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationExpression into a Document within the given AggregationOperationContext.
BucketOperationSupport.OperationOutput	withAlias(String alias)	Creates a new instance of this BucketOperationSupport.OperationOutput with the given alias.

Methods inherited from class BucketOperationSupport.Output

getExposedField

Methods inherited from class Object

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

Methods inherited from interface AggregationExpression

toDocument

Constructor Details

OperationOutput

public OperationOutput(String operation,
 Collection<? extends Object> values)

Creates a new BucketOperationSupport.Output for the given field.

Parameters:

operation - the actual operation key, must not be null or empty.

values - the values to pass into the operation, must not be null.

Method Details

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationExpression

Turns the AggregationExpression into a Document within the given AggregationOperationContext.

Parameters:

context - must not be null.

Returns:

the MongoDB native (Document) form of the expression.

getOperationArguments

protected List<Object> getOperationArguments(AggregationOperationContext context)

getField

protected Field getField()

Returns the field that holds the ProjectionOperation.ProjectionOperationBuilder.OperationProjection.

Returns:

never null.

withAlias

public BucketOperationSupport.OperationOutput withAlias(String alias)

Creates a new instance of this BucketOperationSupport.OperationOutput with the given alias.

Parameters:

alias - the alias to set

Returns:

new instance of BucketOperationSupport.OperationOutput.