com.couchbase.lite

Class FullTextResult

java.lang.Object

com.couchbase.lite.Result

com.couchbase.lite.FullTextResult

All Implemented Interfaces:

Iterable<String>

public class FullTextResult
extends Result

A single result from a full-text Query.

Method Summary

Modifier and Type	Method and Description
String	getFullTextMatched() Get the text emitted when the view was indexed which contains the match(es).
long	getMatchCount() Get the number of query words that were found in the full-text.
int	getTermIndexOfMatch(int matchNumber) Get the index of the search term matched by a particular match.
Range	getTextRangeOfMatch(int matchNumber) Get the character range in the full-text of a particular match.

Methods inherited from class com.couchbase.lite.Result

contains, count, getArray, getArray, getBlob, getBlob, getBoolean, getBoolean, getC4enum, getDate, getDate, getDictionary, getDictionary, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getKeys, getLong, getLong, getNumber, getNumber, getObject, getObject, getRs, getString, getString, iterator, toList, toMap, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getFullTextMatched

public String getFullTextMatched()

Get the text emitted when the view was indexed which contains the match(es).

Returns:

the text containing the match(es).

getMatchCount

public long getMatchCount()

Get the number of query words that were found in the full-text. If a query word appears more than once, only the first instance is counted.

Returns:

the number of query words found.

getTermIndexOfMatch

public int getTermIndexOfMatch(int matchNumber)

Get the index of the search term matched by a particular match. Search terms are the individual words in the full-text search expression, skipping duplicates and noise/stop-words. They're numbered from zero.

Parameters:

matchNumber - the zero based index number of the matched word found in the full-text.

Returns:

the index of the search term.

getTextRangeOfMatch

public Range getTextRangeOfMatch(int matchNumber)

Get the character range in the full-text of a particular match.

Parameters:

matchNumber - the zero based index number of the matched word found in the full-text.

Returns:

the character range in the fullText of the given match index.