Foxit PDF SDK
fs_fulltextsearch.h
Go to the documentation of this file.
1 
15 #ifndef FS_FULLTEXTSEARCH_H_
16 #define FS_FULLTEXTSEARCH_H_
17 
18 #include "common/fs_common.h"
19 
25 namespace foxit {
29 namespace fts {
38  public:
44  virtual void Release() = 0;
57  virtual int RetrieveSearchResult(const wchar_t* file_path, int page_index, const WString& match_result,
58  int match_start_text_index, int match_end_text_index) = 0;
59 
60  protected:
61  ~SearchCallback() {}
62 };
63 
68 class DocumentsSource FS_FINAL : public Base{
69  public:
75  explicit DocumentsSource(const char* directory);
83  DocumentsSource(const DocumentsSource& other);
92 
100  bool operator == (const DocumentsSource& other) const;
108  bool operator != (const DocumentsSource& other) const;
109 
117  bool IsEmpty() const;
118 
119  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
120  explicit DocumentsSource(FS_HANDLE handle = NULL);
121 
122 };
123 
127 class FullTextSearch FS_FINAL : public Base{
128  public:
134  typedef enum _RankMode {
147  } RankMode;
148 
149 
151  FullTextSearch();
153  ~FullTextSearch();
159  FullTextSearch(const FullTextSearch& other);
168 
176  bool operator == (const FullTextSearch& other) const;
184  bool operator != (const FullTextSearch& other) const;
192  bool IsEmpty() const;
193 
207  void SetDataBasePath(const char* path_of_data_base);
208 
229  bool reupdate = false);
230 
240  bool UpdateIndexWithFilePath(const char* file_path);
241 
258  bool SearchOf(const char* match_string, RankMode rank_mode, SearchCallback* callback);
259 
260  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
261  explicit FullTextSearch(FS_HANDLE handle);
262 };
263 } // namespace fts
264 }; // namespace foxit
265 
266 #endif // FS_FULLTEXTSEARCH_H_
267 
virtual void Release()=0
A callback function used to release current callback object itself.
DocumentsSource(const char *directory)
Constructor, with a directory.
Definition: fs_fulltextsearch.h:68
No ranking mode is used for searching results.
Definition: fs_fulltextsearch.h:136
Definition: fs_fulltextsearch.h:37
bool IsEmpty() const
Check whether current object is empty or not.
bool UpdateIndexWithFilePath(const char *file_path)
Update the index result of a specified PDF file.
WIDE STRING CLASS.
Definition: fx_string.h:1452
Rank the searching results according to how the result matches the expected searching patten,...
Definition: fs_fulltextsearch.h:146
FullTextSearch & operator=(const FullTextSearch &other)
Assign operator.
Definition: fs_fulltextsearch.h:127
void SetDataBasePath(const char *path_of_data_base)
Set a file path as sqlite data base which is used for storing the indexed data.
DocumentsSource & operator=(const DocumentsSource &other)
Assign operator.
RankMode
Enumeration for rank mode of full text search.
Definition: fs_fulltextsearch.h:134
virtual int RetrieveSearchResult(const wchar_t *file_path, int page_index, const WString &match_result, int match_start_text_index, int match_end_text_index)=0
A callback function used to retrieve the searching result.
Definition: fx_basic.h:3761
Definition: fs_common.h:336
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Header file for common definitions and classes.
bool operator !=(const FullTextSearch &other) const
Not equal operator.
Definition: fs_basictypes.h:407
bool SearchOf(const char *match_string, RankMode rank_mode, SearchCallback *callback)
Search for specified text among the indexed PDF files.
bool operator==(const DocumentsSource &other) const
Equal operator.
common::Progressive StartUpdateIndex(const DocumentsSource &source, common::PauseCallback *pause=0, bool reupdate=false)
Start to update the index of PDF files defined in a documents source object.
Foxit namespace.
Definition: fs_taggedpdf.h:27
bool operator !=(const DocumentsSource &other) const
Not equal operator.
bool IsEmpty() const
Check whether current object is empty or not.
#define NULL
The null-pointer value.
Definition: fx_system.h:780
FullTextSearch()
Constructor.
Rank the searching results according to how the result matches the expected searching patten,...
Definition: fs_fulltextsearch.h:141
bool operator==(const FullTextSearch &other) const
Equal operator.