CBLFullTextQueryRow

@interface CBLFullTextQueryRow : CBLQueryRow

A single result from a full-text CBLQuery.

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

    Declaration

    Objective-C

    @property (readonly, atomic, nullable) NSString *fullTextMatched;

    Swift

    var fullTextMatched: String? { get }

  • 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.)

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSUInteger matchCount;

    Swift

    var matchCount: UInt { get }

  • The character range in the fullText of a particular match.

    Declaration

    Objective-C

    - (NSRange)textRangeOfMatch:(NSUInteger)matchNumber;

    Swift

    func textRange(ofMatch matchNumber: UInt) -> NSRange

    Parameters

    matchNumber

    The zero based match index.

    Return Value

    The charater range in the fullText of the given match index.

  • 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.

    Declaration

    Objective-C

    - (NSUInteger)termIndexOfMatch:(NSUInteger)matchNumber;

    Swift

    func termIndex(ofMatch matchNumber: UInt) -> UInt

    Parameters

    matchNumber

    The zero based match index.

    Return Value

    The index of the search term matched by the given match index.