org.springframework.data.mongodb.core.aggregation
Class GroupOperation

java.lang.Object
  org.springframework.data.mongodb.core.aggregation.GroupOperation

All Implemented Interfaces:

AggregationOperation, FieldsExposingAggregationOperation

public class GroupOperation
extends Object
implements FieldsExposingAggregationOperation

Encapsulates the aggregation framework $group-operation.

Since:

1.3

Author:

Sebastian Herold, Thomas Darimont, Oliver Gierke

See Also:

http://docs.mongodb.org/manual/reference/aggregation/group/#stage._S_group

Nested Class Summary

class

GroupOperation.GroupOperationBuilder Builder for GroupOperations on a field.

Constructor Summary

	GroupOperation(Fields fields) Creates a new GroupOperation including the given Fields.
protected	GroupOperation(GroupOperation groupOperation) Creates a new GroupOperation from the given GroupOperation.

Method Summary

GroupOperation.GroupOperationBuilder	addToSet(Object value) Generates an GroupOperation.GroupOperationBuilder for an $add_to_set-expression for the given value.
GroupOperation.GroupOperationBuilder	addToSet(String reference) Generates an GroupOperation.GroupOperationBuilder for an $add_to_set-expression for the given field-reference.
protected GroupOperation	and(org.springframework.data.mongodb.core.aggregation.GroupOperation.Operation operation) Creates a new GroupOperation from the current one adding the given Operation.
GroupOperation.GroupOperationBuilder	avg(String reference) Generates an GroupOperation.GroupOperationBuilder for an $avg-expression for the given field-reference.
GroupOperation.GroupOperationBuilder	count() Generates an GroupOperation.GroupOperationBuilder for a $sum-expression.
GroupOperation.GroupOperationBuilder	first(String reference) Generates an GroupOperation.GroupOperationBuilder for a $first-expression for the given field-reference.
ExposedFields	getFields() Returns the fields exposed by the AggregationOperation.
GroupOperation.GroupOperationBuilder	last(String reference) Generates an GroupOperation.GroupOperationBuilder for an $last-expression for the given field-reference.
GroupOperation.GroupOperationBuilder	max(String reference) Generates an GroupOperation.GroupOperationBuilder for an $max-expression that for the given field-reference.
GroupOperation.GroupOperationBuilder	min(String reference) Generates an GroupOperation.GroupOperationBuilder for an $min-expression that for the given field-reference.
GroupOperation.GroupOperationBuilder	push(Object value) Generates an GroupOperation.GroupOperationBuilder for an $push-expression for the given value.
GroupOperation.GroupOperationBuilder	push(String reference) Generates an GroupOperation.GroupOperationBuilder for an $push-expression for the given field-reference.
GroupOperation.GroupOperationBuilder	sum(String reference) Generates an GroupOperation.GroupOperationBuilder for a $sum-expression for the given field-reference.
com.mongodb.DBObject	toDBObject(AggregationOperationContext context) Turns the AggregationOperation into a DBObject by using the given AggregationOperationContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupOperation

public GroupOperation(Fields fields)

Creates a new GroupOperation including the given Fields.

Parameters:

fields - must not be null.

GroupOperation

protected GroupOperation(GroupOperation groupOperation)

Creates a new GroupOperation from the given GroupOperation.

Parameters:

groupOperation - must not be null.

Method Detail

and

protected GroupOperation and(org.springframework.data.mongodb.core.aggregation.GroupOperation.Operation operation)

Creates a new GroupOperation from the current one adding the given Operation.

Parameters:

operation - must not be null.

Returns:

count

public GroupOperation.GroupOperationBuilder count()

Generates an GroupOperation.GroupOperationBuilder for a $sum-expression.

Count expressions are emulated via $sum: 1.

Returns:

sum

public GroupOperation.GroupOperationBuilder sum(String reference)

Generates an GroupOperation.GroupOperationBuilder for a $sum-expression for the given field-reference.

Parameters:

reference -

Returns:

addToSet

public GroupOperation.GroupOperationBuilder addToSet(String reference)

Generates an GroupOperation.GroupOperationBuilder for an $add_to_set-expression for the given field-reference.

Parameters:

reference -

Returns:

addToSet

public GroupOperation.GroupOperationBuilder addToSet(Object value)

Generates an GroupOperation.GroupOperationBuilder for an $add_to_set-expression for the given value.

Parameters:

value -

Returns:

last

public GroupOperation.GroupOperationBuilder last(String reference)

Generates an GroupOperation.GroupOperationBuilder for an $last-expression for the given field-reference.

Parameters:

reference -

Returns:

first

public GroupOperation.GroupOperationBuilder first(String reference)

Generates an GroupOperation.GroupOperationBuilder for a $first-expression for the given field-reference.

Parameters:

reference -

Returns:

avg

public GroupOperation.GroupOperationBuilder avg(String reference)

Generates an GroupOperation.GroupOperationBuilder for an $avg-expression for the given field-reference.

Parameters:

reference -

Returns:

push

public GroupOperation.GroupOperationBuilder push(String reference)

Generates an GroupOperation.GroupOperationBuilder for an $push-expression for the given field-reference.

Parameters:

reference -

Returns:

push

public GroupOperation.GroupOperationBuilder push(Object value)

Generates an GroupOperation.GroupOperationBuilder for an $push-expression for the given value.

Parameters:

value -

Returns:

min

public GroupOperation.GroupOperationBuilder min(String reference)

Generates an GroupOperation.GroupOperationBuilder for an $min-expression that for the given field-reference.

Parameters:

reference -

Returns:

max

public GroupOperation.GroupOperationBuilder max(String reference)

Generates an GroupOperation.GroupOperationBuilder for an $max-expression that for the given field-reference.

Parameters:

reference -

Returns:

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.

toDBObject

public com.mongodb.DBObject toDBObject(AggregationOperationContext context)

Description copied from interface: AggregationOperation

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

Specified by:

toDBObject in interface AggregationOperation

Returns:

the DBObject