Class TextQuery

java.lang.Object

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

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

All Implemented Interfaces:

ReadConcernAware, ReadPreferenceAware

public class TextQuery
extends Query

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

Since:

1.6

Author:

Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
TextQuery(String wordsAndPhrases)	Creates new TextQuery using the the given wordsAndPhrases with TextCriteria
TextQuery(String wordsAndPhrases, @Nullable String language)	Creates new TextQuery in language.
TextQuery(String wordsAndPhrases, @Nullable 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.
TextQuery(TextCriteria criteria)	Creates new TextQuery for given TextCriteria.

Method Summary

Modifier and Type	Method	Description
org.bson.Document	getFieldsObject()
String	getScoreFieldName()	Get the fieldname used for scoring
org.bson.Document	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.
boolean	isSorted()	Returns true if the Query has a sort parameter.
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 Query

addCriteria, allowDiskUse, allowSecondaryReads, collation, comment, cursorBatchSize, diskUse, equals, exhaust, fields, getCollation, getCriteria, getHint, getKeyset, getLimit, getMeta, getQueryObject, getReadConcern, getReadPreference, getRestrictedTypes, getSkip, hashCode, hasKeyset, hasReadConcern, hasReadPreference, isLimited, isRestrictedTypeKey, limit, limit, maxTime, maxTimeMsec, noCursorTimeout, of, partialResults, query, querySettingsEquals, restrict, setMeta, skip, toString, with, with, with, with, with, withHint, withHint, withReadConcern, withReadPreference

Methods inherited from class Object

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

Constructor Details

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,
 @Nullable 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,
 @Nullable 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 - must not be null.

locale - can be null.

TextQuery

public TextQuery(TextCriteria criteria)

Creates new TextQuery for given TextCriteria.

Parameters:

criteria - must not be null.

Method Details

queryText

public static TextQuery queryText(TextCriteria criteria)

Creates new TextQuery searching for given TextCriteria.

Parameters:

criteria - must not be null.

Returns:

new instance of TextQuery.

sortByScore

@Contract("-> this")
public TextQuery sortByScore()

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

Returns:

this.

See Also:

• includeScore()

includeScore

@Contract("-> this")
public TextQuery includeScore()

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

Returns:

this.

includeScore

@Contract("_ -> this")
public TextQuery includeScore(String fieldname)

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

Parameters:

fieldname - must not be null.

Returns:

this.

setScoreFieldName

public void setScoreFieldName(String fieldName)

Set the fieldname used for scoring.

Parameters:

fieldName - must not be null.

getScoreFieldName

public String getScoreFieldName()

Get the fieldname used for scoring

Returns:

never null.

getFieldsObject

public org.bson.Document getFieldsObject()

Overrides:

getFieldsObject in class Query

Returns:

the field Document.

getSortObject

public org.bson.Document getSortObject()

Overrides:

getSortObject in class Query

Returns:

the sort Document.

isSorted

public boolean isSorted()

Description copied from class: Query

Returns true if the Query has a sort parameter.

Overrides:

isSorted in class Query

Returns:

true if sorted.

See Also:

• Sort.isSorted()