com.netease.nimlib.sdk.lucene

接口 LuceneService

public interface LuceneService

全文检索接口

方法概要

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

方法详细资料

searchAllSession

InvocationFuture<java.util.List<MsgIndexRecord>> searchAllSession(java.lang.String query,
                                                                  int limit)

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

参数:

query - 待检索的字符串

limit - 最多返回多少条记录

返回:

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

searchAllSessionBlock

java.util.List<MsgIndexRecord> searchAllSessionBlock(java.lang.String query,
                                                     int limit)

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

参数:

query - 待检索的字符串

limit - 最多返回多少条记录

返回:

聊天消息全文检索结果集

searchSession

InvocationFuture<java.util.List<MsgIndexRecord>> searchSession(java.lang.String query,
                                                               SessionTypeEnum sessionType,
                                                               java.lang.String sessionId)

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

参数:

query - 待检索的字符串

sessionType - 待检索的会话类型（个人/群组）

sessionId - 待检索的会话ID

返回:

聊天消息全文检索结果集

searchSessionBlock

java.util.List<MsgIndexRecord> searchSessionBlock(java.lang.String query,
                                                  SessionTypeEnum sessionType,
                                                  java.lang.String sessionId)

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

参数:

query - 待检索的字符串

sessionType - 待检索的会话类型（个人/群组）

sessionId - 待检索的会话ID

返回:

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

searchSessionPage

InvocationFuture<java.util.List<MsgIndexRecord>> searchSessionPage(java.lang.String query,
                                                                   SessionTypeEnum sessionType,
                                                                   java.lang.String sessionId,
                                                                   int pageIndex,
                                                                   int pageSize)

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

参数:

query - 待检索的字符串

sessionType - 待检索的会话类型（个人/群组）

sessionId - 待检索的会话ID

pageIndex - 页码（从第一页开始）

pageSize - 分页大小

返回:

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

searchSessionPageBlock

java.util.List<MsgIndexRecord> searchSessionPageBlock(java.lang.String query,
                                                      SessionTypeEnum sessionType,
                                                      java.lang.String sessionId,
                                                      int pageIndex,
                                                      int pageSize)

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

参数:

query - 待检索的字符串

sessionType - 待检索的会话类型（个人/群组）

sessionId - 待检索的会话ID

pageIndex - 页码（从第一页开始）

pageSize - 分页大小

返回:

聊天消息全文检索结果集

searchSessionNextPage

InvocationFuture<java.util.List<MsgIndexRecord>> searchSessionNextPage(java.lang.String query,
                                                                       SessionTypeEnum sessionType,
                                                                       java.lang.String sessionId,
                                                                       MsgIndexRecord anchor,
                                                                       int pageSize)

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

参数:

query - 待检索的字符串

sessionType - 待检索的会话类型（个人/群组）

sessionId - 待检索的会话ID

anchor - 首页传null，下一页传上一页的最后一条记录

pageSize - 分页大小

返回:

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

searchSessionNextPageBlock

java.util.List<MsgIndexRecord> searchSessionNextPageBlock(java.lang.String query,
                                                          SessionTypeEnum sessionType,
                                                          java.lang.String sessionId,
                                                          MsgIndexRecord anchor,
                                                          int pageSize)

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

参数:

query - 待检索的字符串

sessionType - 待检索的会话类型（个人/群组）

sessionId - 待检索的会话ID

anchor - 首页传null，下一页传上一页的最后一条记录

pageSize - 分页大小

返回:

聊天消息全文检索结果集

searchSessionMatchCount

int searchSessionMatchCount(java.lang.String query,
                            SessionTypeEnum sessionType,
                            java.lang.String sessionId)

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

参数:

query - 待检索的字符串

sessionType - 待检索的会话类型（个人/群组）

sessionId - 待检索的会话ID

返回:

匹配的记录总数

searchSessionPageCount

int searchSessionPageCount(java.lang.String query,
                           SessionTypeEnum sessionType,
                           java.lang.String sessionId,
                           int pageSize)

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

参数:

query - 待检索的字符串

sessionType - 待检索的会话类型（个人/群组）

sessionId - 待检索的会话ID

pageSize - 分页每页记录数

返回:

匹配的记录总页数

getCacheSize

long getCacheSize()

获取所有缓存数据的大小

返回:

缓存数据字节数

clearCache

void clearCache()

删除所有缓存数据