com.allanbank.mongodb.client.message

Class AggregateCommand

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Command

com.allanbank.mongodb.client.message.AggregateCommand

All Implemented Interfaces:

Message, CursorableMessage

public class AggregateCommand
extends Command
implements CursorableMessage

Helper class for the aggregation commands.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields inherited from class com.allanbank.mongodb.client.message.Command

COMMAND_COLLECTION

Fields inherited from class com.allanbank.mongodb.client.message.AbstractMessage

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
AggregateCommand(Aggregate aggregation, String databaseName, String collectionName, Document commandDocument, ReadPreference readPreference, VersionRange requiredServerVersion) Create a new AggregateCommand.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
int	getBatchSize() Returns the number of documents to be returned in each batch of results.
int	getLimit() Returns the total number of documents to be returned.
int	hashCode() Computes a reasonable hash code.

Methods inherited from class com.allanbank.mongodb.client.message.Command

getCommand, getOperationName, getRoutingDocument, isAllowJumbo, setAllowJumbo, size, toString, validateSize, write, write

Methods inherited from class com.allanbank.mongodb.client.message.AbstractMessage

finishHeader, getCollectionName, getDatabaseName, getReadPreference, getRequiredVersionRange, init, writeHeader, writeHeader

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.allanbank.mongodb.client.message.CursorableMessage

getCollectionName

Methods inherited from interface com.allanbank.mongodb.client.Message

getDatabaseName, getOperationName, getReadPreference, getRequiredVersionRange, size, validateSize, write, write

Constructor Detail

AggregateCommand

public AggregateCommand(Aggregate aggregation,
                String databaseName,
                String collectionName,
                Document commandDocument,
                ReadPreference readPreference,
                VersionRange requiredServerVersion)

Create a new AggregateCommand.

Parameters:

aggregation - The original aggregation.

databaseName - The name of the database.

collectionName - The name of the collection to run the aggregation on.

commandDocument - The command document containing the command and options.

readPreference - The preference for which servers to use to retrieve the results.

requiredServerVersion - The required version of the server to support processing the message.

Method Detail

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class Command

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getBatchSize

public int getBatchSize()

Returns the number of documents to be returned in each batch of results.

Overridden to return the batch size from the Aggregate.

Specified by:

getBatchSize in interface CursorableMessage

Returns:

The number of documents to be returned in each batch of results.

getLimit

public int getLimit()

Returns the total number of documents to be returned.

Overridden to return the limit from the Aggregate.

Specified by:

getLimit in interface CursorableMessage

Returns:

The total number of documents to be returned.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class Command

Returns:

The hash code value.