org.springframework.data.mongodb.core.aggregation

Class AggregationOptions

java.lang.Object

org.springframework.data.mongodb.core.aggregation.AggregationOptions

public class AggregationOptions
extends Object

Holds a set of configurable aggregation options that can be used within an aggregation pipeline. A list of support aggregation options can be found in the MongoDB reference documentation https://docs.mongodb.org/manual/reference/command/aggregate/#aggregate

Since:

1.6

Author:

Thomas Darimont, Oliver Gierke

See Also:

Aggregation.withOptions(AggregationOptions), TypedAggregation.withOptions(AggregationOptions)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregationOptions.Builder A Builder for AggregationOptions.

Constructor Summary

Constructors

Constructor and Description
AggregationOptions(boolean allowDiskUse, boolean explain, com.mongodb.DBObject cursor) Creates a new AggregationOptions.

Method Summary

Modifier and Type	Method and Description
com.mongodb.DBObject	getCursor() Specify a document that contains options that control the creation of the cursor object.
boolean	isAllowDiskUse() Enables writing to temporary files.
boolean	isExplain() Specifies to return the information on the processing of the pipeline.
com.mongodb.DBObject	toDbObject() Returns a DBObject representation of this AggregationOptions.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregationOptions

public AggregationOptions(boolean allowDiskUse,
                          boolean explain,
                          com.mongodb.DBObject cursor)

Creates a new AggregationOptions.

Parameters:

allowDiskUse - whether to off-load intensive sort-operations to disk.

explain - whether to get the execution plan for the aggregation instead of the actual results.

cursor - can be null, used to pass additional options to the aggregation.

Method Detail

isAllowDiskUse

public boolean isAllowDiskUse()

Enables writing to temporary files. When set to true, aggregation stages can write data to the _tmp subdirectory in the dbPath directory.

Returns:

isExplain

public boolean isExplain()

Specifies to return the information on the processing of the pipeline.

Returns:

getCursor

public com.mongodb.DBObject getCursor()

Specify a document that contains options that control the creation of the cursor object.

Returns:

toDbObject

public com.mongodb.DBObject toDbObject()

Returns a DBObject representation of this AggregationOptions.

Returns:

toString

public String toString()

Overrides:

toString in class Object