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

Class CountOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.CountOperation

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation

public class CountOperation
extends Object
implements FieldsExposingAggregationOperation

Encapsulates the aggregation framework $count-operation.
We recommend to use the static factory method Aggregation.count() instead of creating instances of this class directly.

Since:

1.10

Author:

Mark Paluch

See Also:

• https://docs.mongodb.com/manual/reference/operator/aggregation/count/

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CountOperation.CountOperationBuilder	Builder for CountOperation.

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

FieldsExposingAggregationOperation.InheritsFieldsAggregationOperation

Constructor Summary

Constructors

Constructor	Description
CountOperation(String fieldName)	Creates a new CountOperation given the fieldName field name.

Method Summary

Modifier and Type	Method	Description
ExposedFields	getFields()	Returns the fields exposed by the AggregationOperation.
String	getOperator()	Return the MongoDB operator that is used for this 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.AggregationOperation

toPipelineStages

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

inheritsFields

Constructor Details

CountOperation

public CountOperation(String fieldName)

Creates a new CountOperation given the fieldName field name.

Parameters:

fieldName - must not be null or empty.

Method Details

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

getOperator

public String getOperator()

Description copied from interface: AggregationOperation

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

Specified by:

getOperator in interface AggregationOperation

Returns:

the operator used for this AggregationOperation.

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.