com.allanbank.mongodb.builder

Class Text

java.lang.Object

com.allanbank.mongodb.builder.Text

public class Text
extends Object

Text provides a wrapper for a text command to query a collection with a text index.

The result of a text command is a document that looks like the following:

 
 > db.collection.runCommand( { "text": "collection" , search: "coffee magic" } )
 {
     "queryDebugString" : "coffe|magic||||||",
     "language" : "english",
     "results" : [
         {
             "score" : 2.25,
             "obj" : {
                 "_id" : ObjectId("51376ab8602c316554cfe248"),
                 "content" : "Coffee is full of magical powers."
             }
         },
         {
             "score" : 0.625,
             "obj" : {
                 "_id" : ObjectId("51376a80602c316554cfe246"),
                 "content" : "Now is the time to drink all of the coffee."
             }
         }
     ],
     "stats" : {
         "nscanned" : 3,
         "nscannedObjects" : 0,
         "n" : 2,
         "nfound" : 2,
         "timeMicros" : 97
     },
     "ok" : 1
 }
 
 

The TextResult class wraps a single entry from the results array.

Since:

MongoDB 2.4

See Also:

MongoDB Text Queries

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Text.Builder Builder provides a builder for Text commands.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static Text.Builder	builder() Creates a new builder for a Text command.
String	getLanguage() Returns the language to use when stemming the search terms.
int	getLimit() Returns the maximum number of document to return.
Document	getQuery() Returns the query document to limit the final results.
ReadPreference	getReadPreference() Returns the ReadPreference specifying which servers may be used to execute the Text command.
Document	getReturnFields() Returns the fields to return from the query.
String	getSearchTerm() Returns the search terms.

Methods inherited from class java.lang.Object

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

Constructor Detail

Text

protected Text(Text.Builder builder)

Creates a new Text.

Parameters:

builder - The builder containing the state of the text command.

Throws:

IllegalArgumentException - On the search term not being set.

Method Detail

builder

public static Text.Builder builder()

Creates a new builder for a Text command.

Returns:

The builder to construct a Text command.

getLanguage

public String getLanguage()

Returns the language to use when stemming the search terms.

Returns:

The language to use when stemming the search terms.

getLimit

public int getLimit()

Returns the maximum number of document to return.

Returns:

The maximum number of document to return.

getQuery

public Document getQuery()

Returns the query document to limit the final results.

Returns:

The query document to limit the final results.

getReadPreference

public ReadPreference getReadPreference()

Returns the ReadPreference specifying which servers may be used to execute the Text command.

If null then the MongoCollection instance's ReadPreference will be used.

Returns:

The read preference to use.

See Also:

MongoCollection.getReadPreference()

getReturnFields

public Document getReturnFields()

Returns the fields to return from the query.

Returns:

The fields to return from the query.

getSearchTerm

public String getSearchTerm()

Returns the search terms.

Returns:

The search terms.