com.netease.nimlib.sdk.lucene

Interface LuceneService

public interface LuceneService

Global search interface

Method Summary

Modifier and Type	Method and Description
void	clearCache() Delete all cached data
long	getCacheSize() Get the size of the cached data
InvocationFuture<java.util.List<MsgIndexRecord>>	searchAllSession(java.lang.String query, int limit) Query all sessions and return the count of all matched messages from each session and the most recent message that hit the search condition.
java.util.List<MsgIndexRecord>	searchAllSessionBlock(java.lang.String query, int limit) Query all sessions and return the count of all matched messages from each session and the most recent message that hit the search condition.
InvocationFuture<java.util.List<MsgIndexRecord>>	searchSession(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId) Query messages in a specified session and return the matched result.
java.util.List<MsgIndexRecord>	searchSessionBlock(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId) Query messages in a specified session and return the matched result.
int	searchSessionMatchCount(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId) Result count for a search with specified keywords (sync)
InvocationFuture<java.util.List<MsgIndexRecord>>	searchSessionNextPage(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId, MsgIndexRecord anchor, int pageSize) Specify keywords for search.
java.util.List<MsgIndexRecord>	searchSessionNextPageBlock(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId, MsgIndexRecord anchor, int pageSize) Specify keywords for search.
InvocationFuture<java.util.List<MsgIndexRecord>>	searchSessionPage(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId, int pageIndex, int pageSize) Specify keywords for search.
java.util.List<MsgIndexRecord>	searchSessionPageBlock(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId, int pageIndex, int pageSize) Specify keywords for search.
int	searchSessionPageCount(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId, int pageSize) Number of pages for a search with specified keywords (sync)

Method Detail

searchAllSession

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

Query all sessions and return the count of all matched messages from each session and the most recent message that hit the search condition. (async)

Parameters:

query - The strings to be queried

limit - The limit of returned messages

Returns:

InvocationFuture Callback that return the matched result.

searchAllSessionBlock

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

Query all sessions and return the count of all matched messages from each session and the most recent message that hit the search condition. (sync)

Parameters:

query - The strings to be queried

limit - The limit of returned messages

Returns:

the matched result

searchSession

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

Query messages in a specified session and return the matched result. (async)

Parameters:

query - The strings to be queried

sessionType - The session type (P2P or group)

sessionId - the session ID

Returns:

the matched result

searchSessionBlock

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

Query messages in a specified session and return the matched result. (sync)

Parameters:

query - The strings to be queried

sessionType - The session type (P2P or group)

sessionId - the session ID

Returns:

InvocationFuture Callback that return the matched result.

searchSessionPage

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

Specify keywords for search. The result is displayed on paginated pages (async)

Parameters:

query - The strings to be queried

sessionType - The session type (P2P or group)

sessionId - the session ID

pageIndex - Page number starting from 1

pageSize - Number of entries displayed per page

Returns:

InvocationFuture Callback that return the matched result.

searchSessionPageBlock

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

Specify keywords for search. The result is displayed on paginated pages (sync)

Parameters:

query - The strings to be queried

sessionType - The session type (P2P or group)

sessionId - the session ID

pageIndex - Page number starting from 1

pageSize - Number of entries displayed per page

Returns:

the matched result

searchSessionNextPage

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

Specify keywords for search. The result is displayed based on a specified anchor on paginated pages (async)

Parameters:

query - The strings to be queried

sessionType - The session type (P2P or group)

sessionId - the session ID

anchor - pass in null for the first page, and last entry of the previous page for the next page.

pageSize - Number of entries displayed per page

Returns:

InvocationFuture Callback that return the matched result.

searchSessionNextPageBlock

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

Specify keywords for search. The result is displayed based on a specified anchor on paginated pages (sync)

Parameters:

query - The strings to be queried

sessionType - The session type (P2P or group)

sessionId - the session ID

anchor - pass in null for the first page, and last entry of the previous page for the next page.

pageSize - Number of entries displayed per page

Returns:

the matched result

searchSessionMatchCount

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

Result count for a search with specified keywords (sync)

Parameters:

query - The strings to be queried

sessionType - The session type (P2P or group)

sessionId - the session ID

Returns:

total count of search result

searchSessionPageCount

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

Number of pages for a search with specified keywords (sync)

Parameters:

query - The strings to be queried

sessionType - The session type (P2P or group)

sessionId - the session ID

pageSize - Number of entries displayed per page

Returns:

total number of pages

getCacheSize

long getCacheSize()

Get the size of the cached data

Returns:

size of cached data

clearCache

void clearCache()

Delete all cached data