com.allanbank.mongodb.builder

Class Text.Builder

java.lang.Object

com.allanbank.mongodb.builder.Text.Builder

Enclosing class:

Text

public static class Text.Builder
extends Object

Builder provides a builder for Text commands.

API Warning:

This class is NOT part of the Public API. This class may be mutated in incompatible ways between any two releases of the driver. This class WILL, eventually, be part of the driver's API. Until 10gen finalizes the text query interface we are keeping this class out of the Public API so we can track any changes more closely.

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
protected String	myLanguage The language to use when stemming the search terms.
protected int	myLimit Maximum number of document to return.
protected Document	myQuery A standard MongoDB query document to limit the final results.
protected ReadPreference	myReadPreference The read preference to use.
protected Document	myReturnFields The fields to return from the query.
protected String	mySearchTerm The search terms.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Text	build() Creates a new Text based on the current state of the builder.
Text.Builder	language(String language) Sets the language to use when stemming the search terms to the new value.
Text.Builder	limit(int limit) Sets the maximum number of document to return to the new value.
Text.Builder	query(DocumentAssignable query) Sets the standard MongoDB query document to limit the final results to the new value.
Text.Builder	readPreference(ReadPreference readPreference) Sets the ReadPreference specifying which servers may be used to execute the Text command.
Text.Builder	reset() Resets the builder back to its initial state.
Text.Builder	returnFields(DocumentAssignable returnFields) Sets the fields to return from the query to the new value.
Text.Builder	searchTerm(String searchTerm) Sets the search term to the new value.
Text.Builder	setLanguage(String language) Sets the language to use when stemming the search terms to the new value.
Text.Builder	setLimit(int limit) Sets the maximum number of document to return to the new value.
Text.Builder	setQuery(DocumentAssignable query) Sets the standard MongoDB query document to limit the final results to the new value.
Text.Builder	setReadPreference(ReadPreference readPreference) Sets the ReadPreference specifying which servers may be used to execute the Text command.
Text.Builder	setReturnFields(DocumentAssignable returnFields) Sets the fields to return from the query to the new value.
Text.Builder	setSearchTerm(String searchTerm) Sets the search term to the new value.

Methods inherited from class java.lang.Object

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

Field Detail

myLanguage

protected String myLanguage

The language to use when stemming the search terms.

myLimit

protected int myLimit

Maximum number of document to return.

myQuery

protected Document myQuery

A standard MongoDB query document to limit the final results.

myReadPreference

protected ReadPreference myReadPreference

The read preference to use.

myReturnFields

protected Document myReturnFields

The fields to return from the query.

mySearchTerm

protected String mySearchTerm

The search terms.

Constructor Detail

Text.Builder

public Text.Builder()

Creates a new Builder.

Method Detail

build

public Text build()

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

Returns:

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

Throws:

IllegalArgumentException - On the search term not being set.

language

public Text.Builder language(String language)

Sets the language to use when stemming the search terms to the new value.

This method delegates to setLanguage(String)

Parameters:

language - The new value for the language to use when stemming the search terms.

Returns:

This Text.Builder for method call chaining.

limit

public Text.Builder limit(int limit)

Sets the maximum number of document to return to the new value.

This method delegates to setLimit(int)

Parameters:

limit - The new value for the maximum number of document to return.

Returns:

This Text.Builder for method call chaining.

query

public Text.Builder query(DocumentAssignable query)

Sets the standard MongoDB query document to limit the final results to the new value.

This method delegates to setQuery(DocumentAssignable)

Parameters:

query - The new value for the standard MongoDB query document to limit the final results.

Returns:

This Text.Builder for method call chaining.

readPreference

public Text.Builder readPreference(ReadPreference readPreference)

Sets the ReadPreference specifying which servers may be used to execute the Text 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 Text.Builder reset()

Resets the builder back to its initial state.

Returns:

This Text.Builder for method call chaining.

returnFields

public Text.Builder returnFields(DocumentAssignable returnFields)

Sets the fields to return from the query to the new value.

This method delegates to setReturnFields(DocumentAssignable)

Parameters:

returnFields - The new value for the fields to return from the query.

Returns:

This Text.Builder for method call chaining.

searchTerm

public Text.Builder searchTerm(String searchTerm)

Sets the search term to the new value.

This method delegates to setSearchTerm(String)

Parameters:

searchTerm - The new value for the search terms.

Returns:

This Text.Builder for method call chaining.

setLanguage

public Text.Builder setLanguage(String language)

Sets the language to use when stemming the search terms to the new value.

Parameters:

language - The new value for the language to use when stemming the search terms.

Returns:

This Text.Builder for method call chaining.

setLimit

public Text.Builder setLimit(int limit)

Sets the maximum number of document to return to the new value.

Parameters:

limit - The new value for the maximum number of document to return.

Returns:

This Text.Builder for method call chaining.

setQuery

public Text.Builder setQuery(DocumentAssignable query)

Sets the standard MongoDB query document to limit the final results to the new value.

Parameters:

query - The new value for the standard MongoDB query document to limit the final results.

Returns:

This Text.Builder for method call chaining.

setReadPreference

public Text.Builder setReadPreference(ReadPreference readPreference)

Sets the ReadPreference specifying which servers may be used to execute the Text 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()

setReturnFields

public Text.Builder setReturnFields(DocumentAssignable returnFields)

Sets the fields to return from the query to the new value.

Parameters:

returnFields - The new value for the fields to return from the query.

Returns:

This Text.Builder for method call chaining.

setSearchTerm

public Text.Builder setSearchTerm(String searchTerm)

Sets the search term to the new value.

Parameters:

searchTerm - The new value for the search terms.

Returns:

This Text.Builder for method call chaining.