com.allanbank.mongodb.builder

Class ParallelScan.Builder

java.lang.Object

com.allanbank.mongodb.builder.ParallelScan.Builder

Enclosing class:

ParallelScan

public static class ParallelScan.Builder
extends Object

Helper for creating immutable ParallelScan queries.

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 int	myBatchSize The number of documents to be returned in each batch of results.
protected ReadPreference	myReadPreference The preference for which servers to use to retrieve the results.
protected int	myRequestedIteratorCount The desired number of iterators/cursors to create.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ParallelScan.Builder	batchSize(int batchSize) Sets the value of the number of documents to be returned in each batch.
ParallelScan	build() Constructs a new ParallelScan object from the state of the builder.
ParallelScan.Builder	readPreference(ReadPreference readPreference) Sets the preference for the set of servers to retrieve the results from.
ParallelScan.Builder	requestedIteratorCount(int numberOfIterators) Sets the requested number of iterators/cursors to create to the new value.
ParallelScan.Builder	reset() Resets the builder back to its initial state for reuse.
ParallelScan.Builder	setBatchSize(int batchSize) Sets the value of the number of documents to be returned in each batch.
ParallelScan.Builder	setReadPreference(ReadPreference readPreference) Sets the preference for the set of servers to retrieve the results from.
ParallelScan.Builder	setRequestedIteratorCount(int numberOfIterators) Sets the requested number of iterators/cursors to create to the new value.

Methods inherited from class java.lang.Object

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

Field Detail

myBatchSize

protected int myBatchSize

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

myReadPreference

protected ReadPreference myReadPreference

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

myRequestedIteratorCount

protected int myRequestedIteratorCount

The desired number of iterators/cursors to create. The server may return few than this number of iterators.

This value will be forced into the range [1, 10,000].

Constructor Detail

ParallelScan.Builder

public ParallelScan.Builder()

Creates a new Builder.

Method Detail

batchSize

public ParallelScan.Builder batchSize(int batchSize)

Sets the value of the number of documents to be returned in each batch.

This method delegates to setBatchSize(int).

Parameters:

batchSize - The new value for the number of documents to be returned in each batch.

Returns:

This builder for chaining method calls.

build

public ParallelScan build()

Constructs a new ParallelScan object from the state of the builder.

Returns:

The new ParallelScan object.

readPreference

public ParallelScan.Builder readPreference(ReadPreference readPreference)

Sets the preference for the set of servers to retrieve the results from.

This method delegates to setReadPreference(ReadPreference).

Parameters:

readPreference - The new value for the preference of which server to return the results from.

Returns:

This builder for chaining method calls.

requestedIteratorCount

public ParallelScan.Builder requestedIteratorCount(int numberOfIterators)

Sets the requested number of iterators/cursors to create to the new value.

This value will be forced into the range [1, 10,000].

This method delegates to setRequestedIteratorCount(int).

Parameters:

numberOfIterators - The requested number of iterators/cursors to create.

Returns:

This builder for chaining method calls.

reset

public ParallelScan.Builder reset()

Resets the builder back to its initial state for reuse.

Returns:

This builder for chaining method calls.

setBatchSize

public ParallelScan.Builder setBatchSize(int batchSize)

Sets the value of the number of documents to be returned in each batch.

Parameters:

batchSize - The new value for the number of documents to be returned in each batch.

Returns:

This builder for chaining method calls.

setReadPreference

public ParallelScan.Builder setReadPreference(ReadPreference readPreference)

Sets the preference for the set of servers to retrieve the results from.

Parameters:

readPreference - The new value for the preference of which server to return the results from.

Returns:

This builder for chaining method calls.

setRequestedIteratorCount

public ParallelScan.Builder setRequestedIteratorCount(int numberOfIterators)

Sets the requested number of iterators/cursors to create to the new value.

This value will be forced into the range [1, 10,000].

Parameters:

numberOfIterators - The requested number of iterators/cursors to create.

Returns:

This builder for chaining method calls.