com.allanbank.mongodb.builder

Class Distinct.Builder

java.lang.Object

com.allanbank.mongodb.builder.Distinct.Builder

Enclosing class:

Distinct

public static class Distinct.Builder
extends Object

Builder provides support for creating a Distinct object.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	myKey The name of the key to collect distinct values for.
protected long	myMaximumTimeMilliseconds The maximum amount of time to allow the command to run.
protected Document	myQuery The query to select document to perform a distinct query across.
protected ReadPreference	myReadPreference The read preference to use.

Constructor Summary

Constructors

Constructor and Description
Distinct.Builder() Creates a new Builder.

Method Summary

Methods

Modifier and Type	Method and Description
Distinct	build() Creates a new GroupBy based on the current state of the builder.
Distinct.Builder	key(String key) Sets the name of the key to collect distinct values for.
Distinct.Builder	maximumTime(long timeLimit, TimeUnit timeLimitUnits) Sets the maximum number of milliseconds to allow the command to run before aborting the request on the server.
Distinct.Builder	query(DocumentAssignable query) Sets the value of the query to select the documents to run the distinct against.
Distinct.Builder	readPreference(ReadPreference readPreference) Sets the ReadPreference specifying which servers may be used to execute the Distinct command.
Distinct.Builder	reset() Resets the builder back to its initial state.
Distinct.Builder	setKey(String key) Sets the name of the key to collect distinct values for.
Distinct.Builder	setMaximumTimeMilliseconds(long maximumTimeMilliseconds) Sets the maximum number of milliseconds to allow the command to run before aborting the request on the server.
Distinct.Builder	setQuery(DocumentAssignable query) Sets the value of the query to select the documents to run the distinct against.
Distinct.Builder	setReadPreference(ReadPreference readPreference) Sets 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

myKey

protected String myKey

The name of the key to collect distinct values for.

myMaximumTimeMilliseconds

protected long myMaximumTimeMilliseconds

The maximum amount of time to allow the command to run.

myQuery

protected Document myQuery

The query to select document to perform a distinct query across.

myReadPreference

protected ReadPreference myReadPreference

The read preference to use.

Constructor Detail

Distinct.Builder

public Distinct.Builder()

Creates a new Builder.

Method Detail

build

public Distinct build()
               throws IllegalArgumentException

Creates a new GroupBy based on the current state of the builder.

Returns:

A new GroupBy based on the current state of the builder.

Throws:

IllegalArgumentException - If neither the key is null or empty.

key

public Distinct.Builder key(String key)

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

This method delegates to setKey(String).

Parameters:

key - The new name of the key to collect distinct values for.

Returns:

This Distinct.Builder for method call chaining.

maximumTime

public Distinct.Builder maximumTime(long timeLimit,
                           TimeUnit timeLimitUnits)

Sets the maximum number of milliseconds to allow the command to run before aborting the request on the server.

This method equivalent to setMaximumTimeMilliseconds(timeLimitUnits.toMillis(timeLimit).

Parameters:

timeLimit - The new maximum amount of time to allow the command to run.

timeLimitUnits - The units for the maximum amount of time to allow the command to run.

Returns:

This Distinct.Builder for method call chaining.

Since:

MongoDB 2.6

query

public Distinct.Builder query(DocumentAssignable query)

Sets the value of the query to select the documents to run the distinct against.

This method delegates to setQuery(DocumentAssignable).

Parameters:

query - The new value for the query to select the documents to run the distinct against.

Returns:

This Distinct.Builder for method call chaining.

readPreference

public Distinct.Builder readPreference(ReadPreference readPreference)

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

If not set or set to null then the MongoCollection instance's ReadPreference will be used.

This method delegates to setReadPreference(ReadPreference).

Parameters:

readPreference - The read preferences specifying which servers may be used.

Returns:

This builder for chaining method calls.

See Also:

MongoCollection.getReadPreference()

reset

public Distinct.Builder reset()

Resets the builder back to its initial state.

Returns:

This Distinct.Builder for method call chaining.

setKey

public Distinct.Builder setKey(String key)

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

Parameters:

key - The new name of the key to collect distinct values for.

Returns:

This Distinct.Builder for method call chaining.

setMaximumTimeMilliseconds

public Distinct.Builder setMaximumTimeMilliseconds(long maximumTimeMilliseconds)

Sets the maximum number of milliseconds to allow the command to run before aborting the request on the server.

Parameters:

maximumTimeMilliseconds - The new maximum number of milliseconds to allow the command to run.

Returns:

This Distinct.Builder for method call chaining.

Since:

MongoDB 2.6

setQuery

public Distinct.Builder setQuery(DocumentAssignable query)

Sets the value of the query to select the documents to run the distinct against.

Parameters:

query - The new value for the query to select the documents to run the distinct against.

Returns:

This Distinct.Builder for method call chaining.

setReadPreference

public Distinct.Builder setReadPreference(ReadPreference readPreference)

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

If not set or set to null then the MongoCollection instance's ReadPreference will be used.

Parameters:

readPreference - The read preferences specifying which servers may be used.

Returns:

This builder for chaining method calls.

See Also:

MongoCollection.getReadPreference()