com.netease.nimlib.sdk.lucene.LuceneService接口 参考

全文检索接口 更多...

Public 成员函数
InvocationFuture< List< MsgIndexRecord > >	searchAllSession (String query, int limit)
	检索所有会话，返回每个会话与检索串匹配的消息数及最近一条匹配的消息记录。（异步函数） 更多...
List< MsgIndexRecord >	searchAllSessionBlock (String query, int limit)
	检索所有会话，返回每个会话与检索串匹配的消息数及最近一条匹配的消息记录。（同步函數） 更多...
InvocationFuture< List< MsgIndexRecord > >	searchSession (String query, SessionTypeEnum sessionType, String sessionId)
	检索指定的会话，返回该会话中与检索串匹配的所有消息记录。（异步函数） 更多...
List< MsgIndexRecord >	searchSessionBlock (String query, SessionTypeEnum sessionType, String sessionId)
	检索指定的会话，返回该会话中与检索串匹配的所有消息记录。（同步函数） 更多...
InvocationFuture< List< MsgIndexRecord > >	searchSessionPage (String query, SessionTypeEnum sessionType, String sessionId, int pageIndex, int pageSize)
	指定会话关键字查询（分页返回匹配记录）（异步） 更多...
List< MsgIndexRecord >	searchSessionPageBlock (String query, SessionTypeEnum sessionType, String sessionId, int pageIndex, int pageSize)
	指定会话关键字查询（分页返回匹配记录）（同步） 更多...
InvocationFuture< List< MsgIndexRecord > >	searchSessionNextPage (String query, SessionTypeEnum sessionType, String sessionId, MsgIndexRecord anchor, int pageSize)
	指定会话关键字查询（分页查询：根据锚点，返回下一页匹配记录）（异步） 更多...
List< MsgIndexRecord >	searchSessionNextPageBlock (String query, SessionTypeEnum sessionType, String sessionId, MsgIndexRecord anchor, int pageSize)
	指定会话关键字查询（分页查询：根据锚点，返回下一页匹配记录）（同步） 更多...
int	searchSessionMatchCount (String query, SessionTypeEnum sessionType, String sessionId)
	指定会话关键字查询匹配记录总数（同步） 更多...
int	searchSessionPageCount (String query, SessionTypeEnum sessionType, String sessionId, int pageSize)
	指定会话关键字查询匹配记录总页数（同步） 更多...
long	getCacheSize ()
	获取所有缓存数据的大小 更多...
void	clearCache ()
	删除所有缓存数据 更多...

详细描述

全文检索接口

在文件 LuceneService.java 第 14 行定义.

成员函数说明

clearCache()

void com.netease.nimlib.sdk.lucene.LuceneService.clearCache

(

)

删除所有缓存数据

getCacheSize()

long com.netease.nimlib.sdk.lucene.LuceneService.getCacheSize

(

)

获取所有缓存数据的大小

返回

缓存数据字节数

searchAllSession()

InvocationFuture<List<MsgIndexRecord> > com.netease.nimlib.sdk.lucene.LuceneService.searchAllSession	(	String	query,
		int	limit
	)

检索所有会话，返回每个会话与检索串匹配的消息数及最近一条匹配的消息记录。（异步函数）

参数

query	待检索的字符串
limit	最多返回多少条记录

返回

InvocationFuture 可以设置回调函数，回调时返回聊天消息全文检索结果集

searchAllSessionBlock()

List<MsgIndexRecord> com.netease.nimlib.sdk.lucene.LuceneService.searchAllSessionBlock	(	String	query,
		int	limit
	)

检索所有会话，返回每个会话与检索串匹配的消息数及最近一条匹配的消息记录。（同步函數）

参数

query	待检索的字符串
limit	最多返回多少条记录

返回

聊天消息全文检索结果集

searchSession()

InvocationFuture<List<MsgIndexRecord> > com.netease.nimlib.sdk.lucene.LuceneService.searchSession	(	String	query,
		SessionTypeEnum	sessionType,
		String	sessionId
	)

检索指定的会话，返回该会话中与检索串匹配的所有消息记录。（异步函数）

参数

query	待检索的字符串
sessionType	待检索的会话类型（个人/群组）
sessionId	待检索的会话ID

返回

聊天消息全文检索结果集

searchSessionBlock()

List<MsgIndexRecord> com.netease.nimlib.sdk.lucene.LuceneService.searchSessionBlock	(	String	query,
		SessionTypeEnum	sessionType,
		String	sessionId
	)

检索指定的会话，返回该会话中与检索串匹配的所有消息记录。（同步函数）

参数

query	待检索的字符串
sessionType	待检索的会话类型（个人/群组）
sessionId	待检索的会话ID

返回

InvocationFuture 可以设置回调函数，回调时返回聊天消息全文检索结果集

searchSessionMatchCount()

int com.netease.nimlib.sdk.lucene.LuceneService.searchSessionMatchCount	(	String	query,
		SessionTypeEnum	sessionType,
		String	sessionId
	)

指定会话关键字查询匹配记录总数（同步）

参数

query	待检索的字符串
sessionType	待检索的会话类型（个人/群组）
sessionId	待检索的会话ID

返回

匹配的记录总数

searchSessionNextPage()

InvocationFuture<List<MsgIndexRecord> > com.netease.nimlib.sdk.lucene.LuceneService.searchSessionNextPage	(	String	query,
		SessionTypeEnum	sessionType,
		String	sessionId,
		MsgIndexRecord	anchor,
		int	pageSize
	)

指定会话关键字查询（分页查询：根据锚点，返回下一页匹配记录）（异步）

参数

query	待检索的字符串
sessionType	待检索的会话类型（个人/群组）
sessionId	待检索的会话ID
anchor	首页传null，下一页传上一页的最后一条记录
pageSize	分页大小

返回

InvocationFuture 可以设置回调函数，回调时返回聊天消息全文检索结果集

searchSessionNextPageBlock()

List<MsgIndexRecord> com.netease.nimlib.sdk.lucene.LuceneService.searchSessionNextPageBlock	(	String	query,
		SessionTypeEnum	sessionType,
		String	sessionId,
		MsgIndexRecord	anchor,
		int	pageSize
	)

指定会话关键字查询（分页查询：根据锚点，返回下一页匹配记录）（同步）

参数

query	待检索的字符串
sessionType	待检索的会话类型（个人/群组）
sessionId	待检索的会话ID
anchor	首页传null，下一页传上一页的最后一条记录
pageSize	分页大小

返回

聊天消息全文检索结果集

searchSessionPage()

InvocationFuture<List<MsgIndexRecord> > com.netease.nimlib.sdk.lucene.LuceneService.searchSessionPage	(	String	query,
		SessionTypeEnum	sessionType,
		String	sessionId,
		int	pageIndex,
		int	pageSize
	)

指定会话关键字查询（分页返回匹配记录）（异步）

参数

query	待检索的字符串
sessionType	待检索的会话类型（个人/群组）
sessionId	待检索的会话ID
pageIndex	页码（从第一页开始）
pageSize	分页大小

返回

InvocationFuture 可以设置回调函数，回调时返回聊天消息全文检索结果集

searchSessionPageBlock()

List<MsgIndexRecord> com.netease.nimlib.sdk.lucene.LuceneService.searchSessionPageBlock	(	String	query,
		SessionTypeEnum	sessionType,
		String	sessionId,
		int	pageIndex,
		int	pageSize
	)

指定会话关键字查询（分页返回匹配记录）（同步）

参数

query	待检索的字符串
sessionType	待检索的会话类型（个人/群组）
sessionId	待检索的会话ID
pageIndex	页码（从第一页开始）
pageSize	分页大小

返回

聊天消息全文检索结果集

searchSessionPageCount()

int com.netease.nimlib.sdk.lucene.LuceneService.searchSessionPageCount	(	String	query,
		SessionTypeEnum	sessionType,
		String	sessionId,
		int	pageSize
	)

指定会话关键字查询匹配记录总页数（同步）

参数

query	待检索的字符串
sessionType	待检索的会话类型（个人/群组）
sessionId	待检索的会话ID
pageSize	分页每页记录数

返回

匹配的记录总页数

---

该接口的文档由以下文件生成:

• plugins/lucene/src/com/netease/nimlib/sdk/lucene/LuceneService.java