org.springframework.data.mongodb.core.query

Class TextQuery

java.lang.Object

org.springframework.data.mongodb.core.query.Query

org.springframework.data.mongodb.core.query.TextQuery

public class TextQuery
extends Query

Query implementation to be used to for performing full text searches.

Since:

1.6

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
TextQuery(String wordsAndPhrases) Creates new TextQuery using the the given wordsAndPhrases with TextCriteria
TextQuery(String wordsAndPhrases, Locale locale) Creates new TextQuery using the locales language.
TextQuery(String wordsAndPhrases, String language) Creates new TextQuery in language.
TextQuery(TextCriteria criteria) Creates new TextQuery for given TextCriteria.

Method Summary

Modifier and Type	Method and Description
com.mongodb.DBObject	getFieldsObject()
String	getScoreFieldName() Get the fieldname used for scoring
com.mongodb.DBObject	getSortObject()
TextQuery	includeScore() Add field score holding the documents textScore to the returned fields.
TextQuery	includeScore(String fieldname) Include text search document score in returned fields using the given fieldname.
static TextQuery	queryText(TextCriteria criteria) Creates new TextQuery searching for given TextCriteria.
void	setScoreFieldName(String fieldName) Set the fieldname used for scoring.
TextQuery	sortByScore() Add sorting by text score.

Methods inherited from class org.springframework.data.mongodb.core.query.Query

addCriteria, comment, equals, exhaust, fields, getCriteria, getHint, getLimit, getMeta, getQueryObject, getRestrictedTypes, getSkip, hashCode, isRestrictedTypeKey, limit, maxScan, maxTime, maxTimeMsec, noCursorTimeout, partialResults, query, querySettingsEquals, restrict, setMeta, skip, slaveOk, toString, useSnapshot, with, with, withHint

Methods inherited from class java.lang.Object

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

Constructor Detail

TextQuery

public TextQuery(String wordsAndPhrases)

Creates new TextQuery using the the given wordsAndPhrases with TextCriteria

Parameters:

wordsAndPhrases -

See Also:

TextCriteria.matching(String)

TextQuery

public TextQuery(String wordsAndPhrases,
                 String language)

Creates new TextQuery in language.
For a full list of supported languages see the mongdodb reference manual for Text Search Languages.

Parameters:

wordsAndPhrases -

language -

See Also:

TextCriteria.forLanguage(String), TextCriteria.matching(String)

TextQuery

public TextQuery(String wordsAndPhrases,
                 Locale locale)

Creates new TextQuery using the locales language.
For a full list of supported languages see the mongdodb reference manual for Text Search Languages.

Parameters:

wordsAndPhrases -

locale -

TextQuery

public TextQuery(TextCriteria criteria)

Creates new TextQuery for given TextCriteria.

Parameters:

criteria. -

Method Detail

queryText

public static TextQuery queryText(TextCriteria criteria)

Creates new TextQuery searching for given TextCriteria.

Parameters:

criteria -

Returns:

sortByScore

public TextQuery sortByScore()

Add sorting by text score. Will also add text score to returned fields.

Returns:

See Also:

includeScore()

includeScore

public TextQuery includeScore()

Add field score holding the documents textScore to the returned fields.

Returns:

includeScore

public TextQuery includeScore(String fieldname)

Include text search document score in returned fields using the given fieldname.

Parameters:

fieldname -

Returns:

setScoreFieldName

public void setScoreFieldName(String fieldName)

Set the fieldname used for scoring.

Parameters:

fieldName -

getScoreFieldName

public String getScoreFieldName()

Get the fieldname used for scoring

Returns:

getFieldsObject

public com.mongodb.DBObject getFieldsObject()

Overrides:

getFieldsObject in class Query

getSortObject

public com.mongodb.DBObject getSortObject()

Overrides:

getSortObject in class Query