com.mongodb

Class AggregateIterableImpl<TDocument,TResult>

java.lang.Object

com.mongodb.AggregateIterableImpl<TDocument,TResult>

All Implemented Interfaces:

AggregateIterable<TResult>, MongoIterable<TResult>, java.lang.Iterable<TResult>

class AggregateIterableImpl<TDocument,TResult>
extends java.lang.Object
implements AggregateIterable<TResult>

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Boolean	allowDiskUse
private java.lang.Integer	batchSize
private java.lang.Boolean	bypassDocumentValidation
private CodecRegistry	codecRegistry
private Collation	collation
private java.lang.Class<TDocument>	documentClass
private OperationExecutor	executor
private long	maxTimeMS
private MongoNamespace	namespace
private java.util.List<? extends Bson>	pipeline
private ReadConcern	readConcern
private ReadPreference	readPreference
private java.lang.Class<TResult>	resultClass
private java.lang.Boolean	useCursor
private WriteConcern	writeConcern

Constructor Summary

Constructors

Constructor and Description
AggregateIterableImpl(MongoNamespace namespace, java.lang.Class<TDocument> documentClass, java.lang.Class<TResult> resultClass, CodecRegistry codecRegistry, ReadPreference readPreference, ReadConcern readConcern, WriteConcern writeConcern, OperationExecutor executor, java.util.List<? extends Bson> pipeline)

Method Summary

Modifier and Type	Method and Description
AggregateIterable<TResult>	allowDiskUse(java.lang.Boolean allowDiskUse) Enables writing to temporary files.
AggregateIterable<TResult>	batchSize(int batchSize) Sets the number of documents to return per batch.
AggregateIterable<TResult>	bypassDocumentValidation(java.lang.Boolean bypassDocumentValidation) Sets the bypass document level validation flag.
AggregateIterable<TResult>	collation(Collation collation) Sets the collation options
private AggregateToCollectionOperation	createAggregateToCollectionOperation(java.util.List<BsonDocument> aggregateList)
private java.util.List<BsonDocument>	createBsonDocumentList(java.util.List<? extends Bson> pipeline)
private MongoIterable<TResult>	execute()
TResult	first() Helper to return the first item in the iterator or null.
void	forEach(Block<? super TResult> block) Iterates over all documents in the view, applying the given block to each.
private BsonValue	getOutCollection(java.util.List<BsonDocument> aggregateList)
<A extends java.util.Collection<? super TResult>> A	into(A target) Iterates over all the documents, adding each to the given target.
MongoCursor<TResult>	iterator()
<U> MongoIterable<U>	map(Function<TResult,U> mapper) Maps this iterable from the source document type to the target document type.
AggregateIterable<TResult>	maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
void	toCollection() Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.
AggregateIterable<TResult>	useCursor(java.lang.Boolean useCursor) Sets whether the server should use a cursor to return results.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

namespace

private final MongoNamespace namespace

documentClass

private final java.lang.Class<TDocument> documentClass

resultClass

private final java.lang.Class<TResult> resultClass

readPreference

private final ReadPreference readPreference

readConcern

private final ReadConcern readConcern

writeConcern

private final WriteConcern writeConcern

codecRegistry

private final CodecRegistry codecRegistry

executor

private final OperationExecutor executor

pipeline

private final java.util.List<? extends Bson> pipeline

allowDiskUse

private java.lang.Boolean allowDiskUse

batchSize

private java.lang.Integer batchSize

maxTimeMS

private long maxTimeMS

useCursor

private java.lang.Boolean useCursor

bypassDocumentValidation

private java.lang.Boolean bypassDocumentValidation

collation

private Collation collation

Constructor Detail

AggregateIterableImpl

AggregateIterableImpl(MongoNamespace namespace,
                      java.lang.Class<TDocument> documentClass,
                      java.lang.Class<TResult> resultClass,
                      CodecRegistry codecRegistry,
                      ReadPreference readPreference,
                      ReadConcern readConcern,
                      WriteConcern writeConcern,
                      OperationExecutor executor,
                      java.util.List<? extends Bson> pipeline)

Method Detail

toCollection

public void toCollection()

Description copied from interface: AggregateIterable

Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.

Specified by:

toCollection in interface AggregateIterable<TResult>

allowDiskUse

public AggregateIterable<TResult> allowDiskUse(java.lang.Boolean allowDiskUse)

Description copied from interface: AggregateIterable

Enables writing to temporary files. A null value indicates that it's unspecified.

Specified by:

allowDiskUse in interface AggregateIterable<TResult>

Parameters:

allowDiskUse - true if writing to temporary files is enabled

Returns:

this

batchSize

public AggregateIterable<TResult> batchSize(int batchSize)

Description copied from interface: AggregateIterable

Sets the number of documents to return per batch.

Specified by:

batchSize in interface AggregateIterable<TResult>

Specified by:

batchSize in interface MongoIterable<TResult>

Parameters:

batchSize - the batch size

Returns:

this

maxTime

public AggregateIterable<TResult> maxTime(long maxTime,
                                          java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: AggregateIterable

Sets the maximum execution time on the server for this operation.

Specified by:

maxTime in interface AggregateIterable<TResult>

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

useCursor

public AggregateIterable<TResult> useCursor(java.lang.Boolean useCursor)

Description copied from interface: AggregateIterable

Sets whether the server should use a cursor to return results.

Specified by:

useCursor in interface AggregateIterable<TResult>

Parameters:

useCursor - whether the server should use a cursor to return results

Returns:

this

bypassDocumentValidation

public AggregateIterable<TResult> bypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)

Description copied from interface: AggregateIterable

Sets the bypass document level validation flag.

Note: This only applies when an $out stage is specified

.

Specified by:

bypassDocumentValidation in interface AggregateIterable<TResult>

Parameters:

bypassDocumentValidation - If true, allows the write to opt-out of document level validation.

Returns:

this

collation

public AggregateIterable<TResult> collation(Collation collation)

Description copied from interface: AggregateIterable

Sets the collation options

A null value represents the server default.

Specified by:

collation in interface AggregateIterable<TResult>

Parameters:

collation - the collation options to use

Returns:

this

iterator

public MongoCursor<TResult> iterator()

Specified by:

iterator in interface MongoIterable<TResult>

Specified by:

iterator in interface java.lang.Iterable<TResult>

first

public TResult first()

Description copied from interface: MongoIterable

Helper to return the first item in the iterator or null.

Specified by:

first in interface MongoIterable<TResult>

Returns:

T the first item or null.

map

public <U> MongoIterable<U> map(Function<TResult,U> mapper)

Description copied from interface: MongoIterable

Maps this iterable from the source document type to the target document type.

Specified by:

map in interface MongoIterable<TResult>

Type Parameters:

U - the target document type

Parameters:

mapper - a function that maps from the source to the target document type

Returns:

an iterable which maps T to U

forEach

public void forEach(Block<? super TResult> block)

Description copied from interface: MongoIterable

Iterates over all documents in the view, applying the given block to each.

Similar to map but the function is fully encapsulated with no returned result.

Specified by:

forEach in interface MongoIterable<TResult>

Parameters:

block - the block to apply to each document of type T.

into

public <A extends java.util.Collection<? super TResult>> A into(A target)

Description copied from interface: MongoIterable

Iterates over all the documents, adding each to the given target.

Specified by:

into in interface MongoIterable<TResult>

Type Parameters:

A - the collection type

Parameters:

target - the collection to insert into

Returns:

the target

execute

private MongoIterable<TResult> execute()

getOutCollection

private BsonValue getOutCollection(java.util.List<BsonDocument> aggregateList)

createAggregateToCollectionOperation

private AggregateToCollectionOperation createAggregateToCollectionOperation(java.util.List<BsonDocument> aggregateList)

createBsonDocumentList

private java.util.List<BsonDocument> createBsonDocumentList(java.util.List<? extends Bson> pipeline)