Detailed Description

A single result from a full-text CBLQuery.

Inheritance diagram for CBLFullTextQueryRow:

Instance Methods
(NSRange)	- textRangeOfMatch:
	The character range in the fullText of a particular match. More...

(NSUInteger)	- termIndexOfMatch:
	The index of the search term matched by a particular match. More...

Instance Methods inherited from CBLQueryRow
(nullable id)	- valueAtIndex:
	The result value at the given index (if the query has a "returning" specification.) More...

(bool)	- booleanAtIndex:

(NSInteger)	- integerAtIndex:

(float)	- floatAtIndex:

(double)	- doubleAtIndex:

(nullable NSString *)	- stringAtIndex:

(nullable NSDate *)	- dateAtIndex:

(nullable id)	- objectAtIndexedSubscript:

(instancetype)	- NS_UNAVAILABLE

Properties
NSString *	fullTextMatched
	The text emitted when the view was indexed (the argument to CBLTextKey()) which contains the match(es). More...

NSUInteger	matchCount
	The number of query words that were found in the fullText. More...

Properties inherited from CBLQueryRow
NSString *	documentID
	The ID of the document that produced this row. More...

uint64_t	sequence
	The sequence number of the document revision that produced this row. More...

CBLDocument *	document
	The document that produced this row. More...

Method Documentation

- (NSRange) textRangeOfMatch: (NSUInteger) matchNumber

The character range in the fullText of a particular match.

- (NSUInteger) termIndexOfMatch: (NSUInteger) matchNumber

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.

- (NSString*) fullTextMatched

readatomicassign

The text emitted when the view was indexed (the argument to CBLTextKey()) which contains the match(es).

- (NSUInteger) matchCount

readnonatomicassign

The number of query words that were found in the fullText.

(If a query word appears more than once, only the first instance is counted.)

The documentation for this class was generated from the following file: