com.allanbank.mongodb.builder

Class Distinct

java.lang.Object

com.allanbank.mongodb.builder.Distinct

public class Distinct
extends Object

Distinct provides container for all of the options to a distinct command. A Distinct.Builder is provided to assist in creating a Distinct.

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Distinct.Builder Builder provides support for creating a Distinct object.

Field Summary

Fields

Modifier and Type	Field and Description
static Version	MAX_TIMEOUT_VERSION The first version of MongoDB to support the distinct command with the ability to limit the execution time on the server.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Distinct(Distinct.Builder builder) Creates a new Distinct.

Method Summary

Methods

Modifier and Type	Method and Description
static Distinct.Builder	builder() Creates a new builder for a Distinct.
String	getKey() Returns the name of the key to collect distinct values for.
long	getMaximumTimeMilliseconds() Returns the maximum amount of time to allow the command to run on the Server before it is aborted.
Document	getQuery() Returns the query to select the documents to run the distinct against.
ReadPreference	getReadPreference() Returns the ReadPreference specifying which servers may be used to execute the Distinct command.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_TIMEOUT_VERSION

public static final Version MAX_TIMEOUT_VERSION

The first version of MongoDB to support the distinct command with the ability to limit the execution time on the server.

Constructor Detail

Distinct

protected Distinct(Distinct.Builder builder)

Creates a new Distinct.

Parameters:

builder - The builder to copy the state from.

Throws:

IllegalArgumentException - If neither the key is null or empty.

Method Detail

builder

public static Distinct.Builder builder()

Creates a new builder for a Distinct.

Returns:

The builder to construct a Distinct.

getKey

public String getKey()

Returns the name of the key to collect distinct values for.

Returns:

The name of the key to collect distinct values for.

getMaximumTimeMilliseconds

public long getMaximumTimeMilliseconds()

Returns the maximum amount of time to allow the command to run on the Server before it is aborted.

Returns:

The maximum amount of time to allow the command to run on the Server before it is aborted.

Since:

MongoDB 2.6

getQuery

public Document getQuery()

Returns the query to select the documents to run the distinct against.

Returns:

The query to select the documents to run the distinct against.

getReadPreference

public ReadPreference getReadPreference()

Returns the ReadPreference specifying which servers may be used to execute the Distinct command.

If null then the MongoCollection instance's ReadPreference will be used.

Returns:

The read preference to use.

See Also:

MongoCollection.getReadPreference()