com.mongodb.AggregateIterableImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver Show documentation
The MongoDB Driver uber-artifact that combines mongodb-driver-sync and the legacy driver
There is a newer version: 3.12.14
/*
 * Copyright 2015-2016 MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mongodb;

import com.mongodb.client.AggregateIterable;
import com.mongodb.client.model.Collation;
import com.mongodb.operation.AggregateOperation;
import com.mongodb.operation.AggregateToCollectionOperation;
import com.mongodb.operation.BatchCursor;
import com.mongodb.operation.FindOperation;
import com.mongodb.operation.ReadOperation;
import com.mongodb.session.ClientSession;
import org.bson.BsonDocument;
import org.bson.BsonValue;
import org.bson.codecs.configuration.CodecRegistry;
import org.bson.conversions.Bson;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;

import static com.mongodb.assertions.Assertions.notNull;
import static java.util.concurrent.TimeUnit.MILLISECONDS;

class AggregateIterableImpl extends MongoIterableImpl implements AggregateIterable {
    private final MongoNamespace namespace;
    private final Class documentClass;
    private final Class resultClass;
    private final WriteConcern writeConcern;
    private final CodecRegistry codecRegistry;
    private final List pipeline;

    private Boolean allowDiskUse;
    private long maxTimeMS;
    private long maxAwaitTimeMS;
    private Boolean useCursor;
    private Boolean bypassDocumentValidation;
    private Collation collation;
    private String comment;
    private Bson hint;

    AggregateIterableImpl(final ClientSession clientSession, final MongoNamespace namespace, final Class documentClass,
                          final Class resultClass, final CodecRegistry codecRegistry, final ReadPreference readPreference,
                          final ReadConcern readConcern, final WriteConcern writeConcern, final OperationExecutor executor,
                          final List pipeline) {
        super(clientSession, executor, readConcern, readPreference);
        this.namespace = notNull("namespace", namespace);
        this.documentClass = notNull("documentClass", documentClass);
        this.resultClass = notNull("resultClass", resultClass);
        this.codecRegistry = notNull("codecRegistry", codecRegistry);
        this.writeConcern = notNull("writeConcern", writeConcern);
        this.pipeline = notNull("pipeline", pipeline);
    }

    @Override
    public void toCollection() {
        List aggregateList = createBsonDocumentList(pipeline);

        if (getOutCollection(aggregateList) == null) {
            throw new IllegalStateException("The last stage of the aggregation pipeline must be $out");
        }

        getExecutor().execute(createAggregateToCollectionOperation(aggregateList), getClientSession());
    }

    @Override
    public AggregateIterable allowDiskUse(final Boolean allowDiskUse) {
        this.allowDiskUse = allowDiskUse;
        return this;
    }

    @Override
    public AggregateIterable batchSize(final int batchSize) {
        super.batchSize(batchSize);
        return this;
    }

    @Override
    public AggregateIterable maxTime(final long maxTime, final TimeUnit timeUnit) {
        notNull("timeUnit", timeUnit);
        this.maxTimeMS = TimeUnit.MILLISECONDS.convert(maxTime, timeUnit);
        return this;
    }

    @Override
    @Deprecated
    public AggregateIterable useCursor(final Boolean useCursor) {
        this.useCursor = useCursor;
        return this;
    }

    @Override
    public AggregateIterable maxAwaitTime(final long maxAwaitTime, final TimeUnit timeUnit) {
        notNull("timeUnit", timeUnit);
        this.maxAwaitTimeMS = TimeUnit.MILLISECONDS.convert(maxAwaitTime, timeUnit);
        return this;
    }

    @Override
    public AggregateIterable bypassDocumentValidation(final Boolean bypassDocumentValidation) {
        this.bypassDocumentValidation = bypassDocumentValidation;
        return this;
    }

    @Override
    public AggregateIterable collation(final Collation collation) {
        this.collation = collation;
        return this;
    }

    @Override
    public AggregateIterable comment(final String comment) {
        this.comment = comment;
        return this;
    }

    @Override
    public AggregateIterable hint(final Bson hint) {
        this.hint = hint;
        return this;
    }

    @Override
    @SuppressWarnings("deprecation")
    ReadOperation> asReadOperation() {
        List aggregateList = createBsonDocumentList(pipeline);

        BsonValue outCollection = getOutCollection(aggregateList);

        if (outCollection != null) {
            getExecutor().execute(createAggregateToCollectionOperation(aggregateList), getClientSession());
            FindOperation findOperation =
                    new FindOperation(new MongoNamespace(namespace.getDatabaseName(), outCollection.asString().getValue()),
                                                      codecRegistry.get(resultClass))
                            .readConcern(getReadConcern())
                            .collation(collation);
            if (getBatchSize() != null) {
                findOperation.batchSize(getBatchSize());
            }
            return findOperation;
        } else {
            return new AggregateOperation(namespace, aggregateList, codecRegistry.get(resultClass))
                    .maxTime(maxTimeMS, MILLISECONDS)
                    .maxAwaitTime(maxAwaitTimeMS, MILLISECONDS)
                    .allowDiskUse(allowDiskUse)
                    .batchSize(getBatchSize())
                    .useCursor(useCursor)
                    .readConcern(getReadConcern())
                    .collation(collation)
                    .hint(hint == null ? null : hint.toBsonDocument(documentClass, codecRegistry))
                    .comment(comment);
        }
    }

    private BsonValue getOutCollection(final List aggregateList) {
        return aggregateList.size() == 0 ? null : aggregateList.get(aggregateList.size() - 1).get("$out");
    }

    private AggregateToCollectionOperation createAggregateToCollectionOperation(final List aggregateList) {
        return new AggregateToCollectionOperation(namespace, aggregateList, writeConcern)
                        .maxTime(maxTimeMS, MILLISECONDS)
                        .allowDiskUse(allowDiskUse)
                        .bypassDocumentValidation(bypassDocumentValidation)
                        .collation(collation)
                        .hint(hint == null ? null : hint.toBsonDocument(documentClass, codecRegistry))
                        .comment(comment);
    }

    private List createBsonDocumentList(final List pipeline) {
        List aggregateList = new ArrayList(pipeline.size());
        for (Bson obj : pipeline) {
            if (obj == null) {
                throw new IllegalArgumentException("pipeline can not contain a null value");
            }
            aggregateList.add(obj.toBsonDocument(documentClass, codecRegistry));
        }
        return aggregateList;
    }
}