类 com.foxit.sdk.fts.FullTextSearch 继承关系图:

Public 成员函数
	FullTextSearch ()
	构造函数。

	FullTextSearch (FullTextSearch other)
	用另一个全文搜索对象构造函数。更多...

synchronized void	delete ()
	直接清除C++相关资源。更多...

boolean	isEmpty ()
	检查当前对象是否为空。更多...

boolean	searchOf (String match_string, int rank_mode, SearchCallback callback) throws com.foxit.sdk.PDFException
	在已索引的PDF文件中搜索指定的文本。更多...

void	setDataBasePath (String path_of_data_base) throws com.foxit.sdk.PDFException
	设置文件路径作为用于存储索引数据的sqlite数据库。更多...

Progressive	startUpdateIndex (DocumentsSource source, PauseCallback pause, boolean reupdate) throws com.foxit.sdk.PDFException
	开始更新文档源对象中定义的PDF文件的索引。更多...

boolean	updateIndexWithFilePath (String file_path) throws com.foxit.sdk.PDFException
	更新指定PDF文件的索引结果。更多...

Public 成员函数继承自 com.foxit.sdk.common.Base
synchronized void	delete ()
	直接清除C++相关资源。更多...

静态 Public 属性
static final int	e_RankHitCountASC = 1
	根据结果与预期搜索模式的匹配程度对搜索结果进行排序，按升序排列（从相似度较低到最相似或相同）。

static final int	e_RankHitCountDESC = 2
	根据结果与预期搜索模式的匹配程度对搜索结果进行排序，按降序排列（从相同或最相似到相似度较低）。

static final int	e_RankNone = 0
	搜索结果不使用排序模式。

详细描述

此类用于索引一些PDF文件，然后在这些已索引的PDF文件中搜索指定的文本。

构造及析构函数说明

◆ FullTextSearch()

com.foxit.sdk.fts.FullTextSearch.FullTextSearch ( FullTextSearch other )

用另一个全文搜索对象构造函数。

参数

[in] other 另一个全文搜索对象。

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.fts.FullTextSearch.delete ( )

直接清除C++相关资源。

返回: 无。

注解: 一旦这个接口被调用，这个对象将不能再被使用。

◆ isEmpty()

boolean com.foxit.sdk.fts.FullTextSearch.isEmpty ( )

检查当前对象是否为空。

当当前对象为空时，意味着当前对象是无用的。

返回: true 表示当前对象为空，false 表示不为空。

◆ searchOf()

boolean com.foxit.sdk.fts.FullTextSearch.searchOf	(	String	match_string,
		int	rank_mode,
		SearchCallback	callback
	)		throws com.foxit.sdk.PDFException

在已索引的PDF文件中搜索指定的文本。

此函数可用于在多个PDF文件中进行搜索，这些文件已通过函数 FullTextSearch.startUpdateIndex 或 FullTextSearch.updateIndexWithFilePath 被索引。搜索结果将通过回调函数 SearchCallback.retrieveSearchResult 返回，按指定的排序模式。

参数

[in]	match_string	要搜索的字符串。它不应是空字符串，并应是UTF-8编码。
[in]	rank_mode	用于搜索结果的排序模式。请参考从 com.foxit.sdk.fts.FullTextSearch.e_RankNone 开始的值，这应该是这些值中的一个。
[in]	callback	SearchCallback 对象。它不应为null。用户应实现它并使用它来检索搜索结果。

返回: true 表示成功，false 表示失败。

◆ setDataBasePath()

void com.foxit.sdk.fts.FullTextSearch.setDataBasePath ( String path_of_data_base ) throws com.foxit.sdk.PDFException

设置文件路径作为用于存储索引数据的sqlite数据库。

此函数只在第一次通过函数 FullTextSearch.startUpdateIndex 或 FullTextSearch.updateIndexWithFilePath 更新PDF文件索引之前有用。一旦更新完成，此函数将变为无用。
如果从未为当前全文搜索对象成功调用过此函数，sqlite数据的默认文件将被命名为"fts.db"并与应用程序文件位于同一位置。

参数

[in] path_of_data_base 指定文件作为sqlite数据库的文件路径。它不应是空字符串，并应是UTF-8编码。

返回: 无。

◆ startUpdateIndex()

Progressive com.foxit.sdk.fts.FullTextSearch.startUpdateIndex	(	DocumentsSource	source,
		PauseCallback	pause,
		boolean	reupdate
	)		throws com.foxit.sdk.PDFException

开始更新文档源对象中定义的PDF文件的索引。

此更新可能需要很长时间，因此Foxit PDF SDK使用渐进式过程来完成此操作。
只有在文档源定义的指定目录（包括子目录）下的PDF文件才能被索引。数据库中不位于文档源定义的指定目录（包括子目录）内的PDF文件的索引将被删除。

参数

[in]	source	文档源对象，定义要索引的目录。
[in]	pause	暂停回调对象，决定更新过程是否需要暂停。这可以是null，意味着在更新过程中不暂停。如果这不是null，它应该是用户实现的有效暂停对象。默认值：null。
[in]	reupdate	true 表示重新更新数据库中现有的索引信息，false 表示不重新更新数据库中现有的索引信息。默认值：false。

返回: 渐进对象。请通过函数 common.Progressive.getRateOfProgress 检查当前进度的比率。如果比率还不是100，调用函数 common.Progressive.resume 继续进度，直到进度完成。

◆ updateIndexWithFilePath()

boolean com.foxit.sdk.fts.FullTextSearch.updateIndexWithFilePath ( String file_path ) throws com.foxit.sdk.PDFException

更新指定PDF文件的索引结果。

此函数可用于更新单个PDF文件的索引结果。

参数

[in] file_path 现有的PDF文件路径。它不应是空字符串，并应是UTF-8编码。

返回: true 表示成功，false 表示失败。

Public 成员函数

静态 Public 属性

详细描述

构造及析构函数说明

◆ FullTextSearch()

成员函数说明

◆ delete()

◆ isEmpty()

◆ searchOf()

◆ setDataBasePath()

◆ startUpdateIndex()

◆ updateIndexWithFilePath()