Couchbase Lite
Objective-C API for iOS and Mac OS
CBLQuery+FullTextSearch.h
Go to the documentation of this file.
1 //
2 // CBLQuery+FullTextSearch.h
3 // CouchbaseLite
4 //
5 // Created by Jens Alfke on 9/21/13.
6 // Copyright (c) 2013 Couchbase, Inc. All rights reserved.
7 //
8 
9 #import "CBLQuery.h"
10 
11 
17 
32 @property (copy, nullable) NSString* fullTextQuery;
33 
36 @property BOOL fullTextSnippets;
37 
42 @property BOOL fullTextRanking;
43 
44 @end
45 
46 
47 
51 
54 @property (readonly, nullable) NSString* fullText;
55 
62 - (NSString*) snippetWithWordStart: (NSString*)wordStart
63  wordEnd: (NSString*)wordEnd;
64 
67 @property (readonly) NSUInteger matchCount;
68 
70 - (NSRange) textRangeOfMatch: (NSUInteger)matchNumber;
71 
75 - (NSUInteger) termIndexOfMatch: (NSUInteger)matchNumber;
76 
77 @end
78 
79 
CBLQuery interface for full-text searches.
Definition: CBLQuery+FullTextSearch.h:16
#define NS_ASSUME_NONNULL_BEGIN
Definition: CBLBase.h:20
#define nullable
Definition: CBLBase.h:22
BOOL fullTextSnippets
If set to YES, the query will collect snippets of the text surrounding each match, available via the CBLFullTextQueryRow's -snippetWithWordStart:wordEnd: method.
Definition: CBLQuery+FullTextSearch.h:36
#define NS_ASSUME_NONNULL_END
Definition: CBLBase.h:21
A result row from a CouchbaseLite view query.
Definition: CBLQuery.h:229
A result row from a full-text query.
Definition: CBLQuery+FullTextSearch.h:50
BOOL fullTextRanking
If YES (the default) the full-text query result rows will be sorted by (approximate) relevance...
Definition: CBLQuery+FullTextSearch.h:42