com.allanbank.mongodb.builder

Class TextResult

java.lang.Object

com.allanbank.mongodb.builder.TextResult

public class TextResult
extends Object

TextResult provides a wrapper for a single result of a text command.

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
 }
 
 

This 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

Constructor Summary

Constructors

Constructor and Description
TextResult(DocumentAssignable document) Creates a new Text.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
Document	getDocument() Returns the document.
Document	getRawDocument() Returns the un-processed result document.
double	getScore() Returns the score for the document.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

TextResult

public TextResult(DocumentAssignable document)

Creates a new Text.

Parameters:

document - The document containing the 'score' and 'obj' fields.

Throws:

AssertionError - On the search term not being set.

Method Detail

equals

public boolean equals(Object object)

Overridden to compare equal to an equivalent text result.

Overrides:

equals in class Object

getDocument

public Document getDocument()

Returns the document.

Returns:

The document.

getRawDocument

public Document getRawDocument()

Returns the un-processed result document. It is expected to be a document containing two fields: 'score' and 'obj'.

Returns:

The un-processed result document.

getScore

public double getScore()

Returns the score for the document.

Returns:

The score for the document.

hashCode

public int hashCode()

Overridden to return the hashCode of the raw document.

Overrides:

hashCode in class Object