org.springframework.data.mongodb.core.aggregation

Class UnwindOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.UnwindOperation

All Implemented Interfaces:

AggregationOperation

public class UnwindOperation
extends Object
implements AggregationOperation

Encapsulates the aggregation framework $unwind-operation.

We recommend to use the static factory method Aggregation.unwind(String) instead of creating instances of this class directly.

Since:

1.3

Author:

Thomas Darimont, Oliver Gierke

See Also:

http://docs.mongodb.org/manual/reference/aggregation/unwind/#pipe._S_unwind

Constructor Summary

Constructors

Constructor and Description
UnwindOperation(Field field) Creates a new UnwindOperation for the given Field.

Method Summary

Modifier and Type	Method and Description
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

UnwindOperation

public UnwindOperation(Field field)

Creates a new UnwindOperation for the given Field.

Parameters:

field - must not be null.

Method Detail

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