Uses of Class
com.allanbank.mongodb.builder.Find.Builder

Packages that use Find.Builder

Package	Description
com.allanbank.mongodb	Provides a Java driver for the MongoDB document store that allows asynchronous invocation of requests.
com.allanbank.mongodb.builder	Provides domain classes and builders for queries and the common MongoDB commands.
com.allanbank.mongodb.client	Provides implementations of the main client interfaces and classes to translate the Reply(s) from the server.

Uses of Find.Builder in com.allanbank.mongodb

Methods in com.allanbank.mongodb with parameters of type Find.Builder

Modifier and Type	Method and Description
Document	MongoCollection.explain(Find.Builder query) Explains the way that the document will be performed.
void	MongoCollection.explainAsync(Callback<Document> results, Find.Builder query) Explains the way that the document will be performed.
Future<Document>	MongoCollection.explainAsync(Find.Builder query) Explains the way that the document will be performed.
MongoIterator<Document>	MongoCollection.find(Find.Builder query) Finds the set of documents matching the query in the collection.
void	MongoCollection.findAsync(Callback<MongoIterator<Document>> results, Find.Builder query) Finds the set of documents matching the query in the collection.
Future<MongoIterator<Document>>	MongoCollection.findAsync(Find.Builder query) Finds the set of documents matching the query in the collection.
Document	MongoCollection.findOne(Find.Builder query) Finds a single matching document in the collection.
void	MongoCollection.findOneAsync(Callback<Document> results, Find.Builder query) Finds a single matching document in the collection.
Future<Document>	MongoCollection.findOneAsync(Find.Builder query) Finds a single matching document in the collection.
MongoCursorControl	MongoCollection.streamingFind(StreamCallback<Document> results, Find.Builder query) Finds the set of documents matching the query in the collection and streams them to the provided callback one at a time.

Uses of Find.Builder in com.allanbank.mongodb.builder

Methods in com.allanbank.mongodb.builder that return Find.Builder

Modifier and Type	Method and Description
Find.Builder	Find.Builder.batchSize(int batchSize) Sets the value of the number of documents to be returned in each batch.
static Find.Builder	Find.builder() Creates a new builder for a Find.
Find.Builder	Find.Builder.hint(DocumentAssignable indexFields) Sets the value of hint as to which index should be used to execute the query.
Find.Builder	Find.Builder.hint(Element... indexFields) Sets the value of hint as to which index should be used to execute the query.
Find.Builder	Find.Builder.hint(String indexName) Sets the value of hint as to which index should be used to execute the query.
Find.Builder	Find.Builder.immortalCursor() Sets the cursor returned from the query to never timeout or die automatically, e.g., immortal.
Find.Builder	Find.Builder.immortalCursor(boolean immortal) If set to true the cursor returned from the query will not timeout or die automatically, e.g., immortal.
Find.Builder	Find.Builder.limit(int limit) Sets the value of the total number of documents to be returned.
Find.Builder	Find.Builder.max(DocumentAssignable maximumRange) Sets the value of maximum range for the index used to the new value.
Find.Builder	Find.Builder.maxScan(long maximumDocumentsToScan) Sets the value of maximum number of documents that will be scanned for results to the new value.
Find.Builder	Find.Builder.min(DocumentAssignable minimumRange) Sets the value of minimum range for the index used to the new value.
Find.Builder	Find.Builder.partialOk() Sets that if there is an error then the query should return any partial results.
Find.Builder	Find.Builder.partialOk(boolean partialOk) Sets the value of partial okay to the new value.
Find.Builder	Find.Builder.query(DocumentAssignable query) Sets the value of the query document to the new value.
Find.Builder	Find.Builder.readPreference(ReadPreference readPreference) Sets the preference for the set of servers to retrieve the results from.
Find.Builder	Find.Builder.reset() Resets the builder back to its initial state for reuse.
Find.Builder	Find.Builder.returnFields(DocumentAssignable returnFields) Sets the value of the fields to be returned from the matching documents to the new value.
Find.Builder	Find.Builder.returnKey() Sets that only index keys should be returned.
Find.Builder	Find.Builder.returnKey(boolean returnIndexKeysOnly) Sets the value for if only index keys should be returned to the new value.
Find.Builder	Find.Builder.setAwaitData(boolean awaitData) If set to true requests for data will block, waiting for data.
Find.Builder	Find.Builder.setBatchSize(int batchSize) Sets the value of the number of documents to be returned in each batch.
Find.Builder	Find.Builder.setHint(DocumentAssignable indexFields) Sets the value of hint as to which index should be used to execute the query.
Find.Builder	Find.Builder.setHint(Element... indexFields) Sets the value of hint as to which index should be used to execute the query.
Find.Builder	Find.Builder.setHint(String indexName) Sets the value of hint as to which index should be used to execute the query.
Find.Builder	Find.Builder.setImmortalCursor(boolean immortal) If set to true the cursor returned from the query will not timeout or die automatically, e.g., immortal.
Find.Builder	Find.Builder.setLimit(int limit) Sets the value of the total number of documents to be returned.
Find.Builder	Find.Builder.setMaximumDocumentsToScan(long maximumDocumentsToScan) Sets the value of maximum number of documents that will be scanned for results to the new value.
Find.Builder	Find.Builder.setMaximumRange(DocumentAssignable maximumRange) Sets the value of maximum range for the index used to the new value.
Find.Builder	Find.Builder.setMinimumRange(DocumentAssignable minimumRange) Sets the value of minimum range for the index used to the new value.
Find.Builder	Find.Builder.setNumberToSkip(int numberToSkip) Sets the value of the number of documents to skip before returning the first document to the new value.
Find.Builder	Find.Builder.setPartialOk(boolean partialOk) Sets the value of partial okay to the new value.
Find.Builder	Find.Builder.setQuery(DocumentAssignable query) Sets the value of the query document to the new value.
Find.Builder	Find.Builder.setReadPreference(ReadPreference readPreference) Sets the preference for the set of servers to retrieve the results from.
Find.Builder	Find.Builder.setReturnFields(DocumentAssignable returnFields) Sets the value of the fields to be returned from the matching documents to the new value.
Find.Builder	Find.Builder.setReturnIndexKeysOnly(boolean returnIndexKeysOnly) Sets the value for if only index keys should be returned to the new value.
Find.Builder	Find.Builder.setShowDiskLocation(boolean showDiskLocation) Sets the value if the disk location for each document should be returned to the new value.
Find.Builder	Find.Builder.setSnapshot(boolean snapshot) Sets the value of snapshot to the new value.
Find.Builder	Find.Builder.setSort(DocumentAssignable sortFields) Sets the value of the fields to to sort matching documents by.
Find.Builder	Find.Builder.setSort(IntegerElement... sortFields) Sets the value of the fields to to sort matching documents by.
Find.Builder	Find.Builder.setTailable(boolean tailable) If set to true the cursor returned from the query will be tailable.
Find.Builder	Find.Builder.showDiskLoc() Sets that the disk location for each document should be returned.
Find.Builder	Find.Builder.showDiskLoc(boolean showDiskLocation) Sets the value if the disk location for each document should be returned to the new value.
Find.Builder	Find.Builder.skip(int numberToSkip) Sets the value of the number of documents to skip before returning the first document to the new value.
Find.Builder	Find.Builder.snapshot() Sets that the query should ensure that documents are only returned once.
Find.Builder	Find.Builder.snapshot(boolean snapshot) Sets the value of snapshot to the new value.
Find.Builder	Find.Builder.sort(DocumentAssignable sortFields) Sets the value of the fields to to sort matching documents by.
Find.Builder	Find.Builder.sort(IntegerElement... sortFields) Sets the value of the fields to to sort matching documents by.
Find.Builder	Find.Builder.tailable() Sets the the cursor returned from the query to be setTailable(true) and setAwaitData(true).

Constructors in com.allanbank.mongodb.builder with parameters of type Find.Builder

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

Uses of Find.Builder in com.allanbank.mongodb.client

Methods in com.allanbank.mongodb.client with parameters of type Find.Builder

Modifier and Type	Method and Description
Document	AbstractMongoCollection.explain(Find.Builder query) Explains the way that the document will be performed.
void	AbstractMongoCollection.explainAsync(Callback<Document> results, Find.Builder query) Explains the way that the document will be performed.
Future<Document>	AbstractMongoCollection.explainAsync(Find.Builder query) Explains the way that the document will be performed.
MongoIterator<Document>	AbstractMongoCollection.find(Find.Builder query) Finds the set of documents matching the query in the collection.
void	AbstractMongoCollection.findAsync(Callback<MongoIterator<Document>> results, Find.Builder query) Finds the set of documents matching the query in the collection.
Future<MongoIterator<Document>>	AbstractMongoCollection.findAsync(Find.Builder query) Finds the set of documents matching the query in the collection.
Document	AbstractMongoCollection.findOne(Find.Builder query) Finds a single matching document in the collection.
void	AbstractMongoCollection.findOneAsync(Callback<Document> results, Find.Builder query) Finds a single matching document in the collection.
Future<Document>	AbstractMongoCollection.findOneAsync(Find.Builder query) Finds a single matching document in the collection.
MongoCursorControl	AbstractMongoCollection.streamingFind(StreamCallback<Document> results, Find.Builder query) Finds the set of documents matching the query in the collection and streams them to the provided callback one at a time.