com.allanbank.mongodb.builder

Class Find

java.lang.Object

com.allanbank.mongodb.builder.Find

public class Find
extends Object

Find provides an immutable container for all of the options for a query.

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, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Find.Builder Helper for creating immutable Find queries.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	getBatchSize() Returns the number of documents to be returned in each batch of results.
Document	getHint() Returns the hint for which index to use.
String	getHintName() Returns the hint for which index to use by name.
int	getLimit() Returns the total number of documents to be returned.
int	getNumberToSkip() Returns the number of documents to skip before returning the first document.
Document	getQuery() Returns the query document.
ReadPreference	getReadPreference() Returns the preference for the servers to retrieve the results from.
Document	getReturnFields() Returns the fields to be returned from the matching documents.
Document	getSort() Returns the fields to order document by.
boolean	isPartialOk() Returns the partial okay value.
boolean	isSnapshot() If returns true then use snapshot mode to ensure document are only returned once.
boolean	isTailable() Returns true if the cursur returned from the query will be tailable, false otherwise.
Document	toQueryRequest(boolean explain) This method is not intended for applications to use.
Document	toQueryRequest(boolean explain, ReadPreference readPreference) This method is not intended for applications to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

Find

protected Find(Find.Builder builder)

Creates a new Find.

Parameters:

builder - The builder to copy the query fields from.

Method Detail

getBatchSize

public int getBatchSize()

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

Returns:

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

getHint

public Document getHint()

Returns the hint for which index to use.

Returns:

The hint for which index to use.

getHintName

public String getHintName()

Returns the hint for which index to use by name.

Returns:

The hint for which index to use by name.

getLimit

public int getLimit()

Returns the total number of documents to be returned.

Returns:

The total number of documents to be returned.

getNumberToSkip

public int getNumberToSkip()

Returns the number of documents to skip before returning the first document.

Returns:

The number of documents to skip before returning the first document.

getQuery

public Document getQuery()

Returns the query document.

Returns:

The query document.

getReadPreference

public ReadPreference getReadPreference()

Returns the preference for the servers to retrieve the results from. May be null in which case the default read preference should be used.

Returns:

The preference for the servers to retrieve the results from.

getReturnFields

public Document getReturnFields()

Returns the fields to be returned from the matching documents.

Returns:

The fields to be returned from the matching documents.

getSort

public Document getSort()

Returns the fields to order document by.

Returns:

The fields to order document by.

isPartialOk

public boolean isPartialOk()

Returns the partial okay value. If true then an error in the query should return any partial results.

Returns:

The partial okay value. If true then an error in the query should return any partial results.

isSnapshot

public boolean isSnapshot()

If returns true then use snapshot mode to ensure document are only returned once.

Returns:

True then use snapshot mode to ensure document are only returned once.

isTailable

public boolean isTailable()

Returns true if the cursur returned from the query will be tailable, false otherwise.

Returns:

True if the cursur returned from the query will be tailable, false otherwise.

See Also:

Find.Builder.setTailable(boolean) for important usage information.

toQueryRequest

public Document toQueryRequest(boolean explain)

This method is not intended for applications to use. Applications should pass the Find object to the appropriate method on the MongoCollection interface. This method is used internally by the driver and is public for cross package access only.

Converts the Find into a raw query request document to send to the MongoDB server.

Parameters:

explain - If true then explain the query procedure instead of returning results.

Returns:

The query request document to send to the MongoDB server.

toQueryRequest

public Document toQueryRequest(boolean explain,
                      ReadPreference readPreference)

This method is not intended for applications to use. Applications should pass the Find object to the appropriate method on the MongoCollection interface. This method is used internally by the driver and is public for cross package access only.

Converts the Find into a raw query request document to send to the MongoDB server including the provided read preferences.

Parameters:

explain - If true then explain the query procedure instead of returning results.

readPreference - The read preference to include in the query request document.

Returns:

The query request document to send to the MongoDB server.