LuceneService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.lucene;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.msg.constant.SessionTypeEnum;
import com.netease.nimlib.sdk.search.model.MsgIndexRecord;

import java.util.List;

/**
 * 全文检索接口
 */
@NIMService("全文检索服务")
public interface LuceneService {

    /**
     * 检索所有会话，返回每个会话与检索串匹配的消息数及最近一条匹配的消息记录。（异步函数）
     *
     * @param query 待检索的字符串
     * @param limit 最多返回多少条记录
     * @return InvocationFuture 可以设置回调函数，回调时返回聊天消息全文检索结果集
     */
    public InvocationFuture<List<MsgIndexRecord>> searchAllSession(String query, int limit);

    /**
     * 检索所有会话，返回每个会话与检索串匹配的消息数及最近一条匹配的消息记录。（同步函數）
     *
     * @param query 待检索的字符串
     * @param limit 最多返回多少条记录
     * @return 聊天消息全文检索结果集
     */
    public List<MsgIndexRecord> searchAllSessionBlock(String query, int limit);

    /**
     * 检索指定的会话，返回该会话中与检索串匹配的所有消息记录。（异步函数）
     *
     * @param query       待检索的字符串
     * @param sessionType 待检索的会话类型（个人/群组）
     * @param sessionId   待检索的会话ID
     * @return 聊天消息全文检索结果集
     */
    public InvocationFuture<List<MsgIndexRecord>> searchSession(String query, SessionTypeEnum sessionType, String sessionId);

    /**
     * 检索指定的会话，返回该会话中与检索串匹配的所有消息记录。（同步函数）
     *
     * @param query       待检索的字符串
     * @param sessionType 待检索的会话类型（个人/群组）
     * @param sessionId   待检索的会话ID
     * @return InvocationFuture 可以设置回调函数，回调时返回聊天消息全文检索结果集
     */
    public List<MsgIndexRecord> searchSessionBlock(String query, SessionTypeEnum sessionType, String sessionId);

    /**
     * 指定会话关键字查询（分页返回匹配记录）（异步）
     *
     * @param query       待检索的字符串
     * @param sessionType 待检索的会话类型（个人/群组）
     * @param sessionId   待检索的会话ID
     * @param pageIndex   页码（从第一页开始）
     * @param pageSize    分页大小
     * @return InvocationFuture 可以设置回调函数，回调时返回聊天消息全文检索结果集
     */
    public InvocationFuture<List<MsgIndexRecord>> searchSessionPage(String query, SessionTypeEnum sessionType, String sessionId,
                                                                    int pageIndex, int pageSize);

    /**
     * 指定会话关键字查询（分页返回匹配记录）（同步）
     *
     * @param query       待检索的字符串
     * @param sessionType 待检索的会话类型（个人/群组）
     * @param sessionId   待检索的会话ID
     * @param pageIndex   页码（从第一页开始）
     * @param pageSize    分页大小
     * @return 聊天消息全文检索结果集
     */
    public List<MsgIndexRecord> searchSessionPageBlock(String query, SessionTypeEnum sessionType, String sessionId,
                                                       int pageIndex, int pageSize);

    /**
     * 指定会话关键字查询（分页查询：根据锚点，返回下一页匹配记录）（异步）
     *
     * @param query       待检索的字符串
     * @param sessionType 待检索的会话类型（个人/群组）
     * @param sessionId   待检索的会话ID
     * @param anchor      首页传null，下一页传上一页的最后一条记录
     * @param pageSize    分页大小
     * @return InvocationFuture 可以设置回调函数，回调时返回聊天消息全文检索结果集
     */
    public InvocationFuture<List<MsgIndexRecord>> searchSessionNextPage(String query, SessionTypeEnum sessionType, String sessionId,
                                                                        MsgIndexRecord anchor, int pageSize);

    /**
     * 指定会话关键字查询（分页查询：根据锚点，返回下一页匹配记录）（同步）
     *
     * @param query       待检索的字符串
     * @param sessionType 待检索的会话类型（个人/群组）
     * @param sessionId   待检索的会话ID
     * @param anchor      首页传null，下一页传上一页的最后一条记录
     * @param pageSize    分页大小
     * @return 聊天消息全文检索结果集
     */
    public List<MsgIndexRecord> searchSessionNextPageBlock(String query, SessionTypeEnum sessionType, String sessionId,
                                                           MsgIndexRecord anchor, int pageSize);

    /**
     * 指定会话关键字查询匹配记录总数（同步）
     *
     * @param query       待检索的字符串
     * @param sessionType 待检索的会话类型（个人/群组）
     * @param sessionId   待检索的会话ID
     * @return 匹配的记录总数
     */
    public int searchSessionMatchCount(String query, SessionTypeEnum sessionType, String sessionId);

    /**
     * 指定会话关键字查询匹配记录总页数（同步）
     *
     * @param query       待检索的字符串
     * @param sessionType 待检索的会话类型（个人/群组）
     * @param sessionId   待检索的会话ID
     * @param pageSize    分页每页记录数
     * @return 匹配的记录总页数
     */
    public int searchSessionPageCount(String query, SessionTypeEnum sessionType, String sessionId, int pageSize);

    /**
     * 获取所有缓存数据的大小
     *
     * @return 缓存数据字节数
     */
    public long getCacheSize();

    /**
     * 删除所有缓存数据
     */
    public void clearCache();
}