程序包 ohos.data.search

类 SearchSession

java.lang.Object

ohos.data.search.SearchSession

public class SearchSession
extends Object

Represents a session used for pagination or group search.

You can obtain a search session by calling SearchAbility#beginSearch(String, String) and perform search operations. If the search session is no longer needed, call SearchAbility#endSearch(String, String, SearchSession) to end the session and release resources. This class is thread-safe. A search session can be used by multiple threads.

从以下版本开始:

3

SystemCapability

SystemCapability.Data#DATA_SEARCH

方法概要

限定符和类型	方法	说明
int	getSearchHitCount(String queryJsonStr)	Obtains the number of results matching a specified string.
List<Recommendation>	groupSearch(String queryJsonStr, int groupLimit)	Obtains and groups the results matching a specified string.
List<IndexData>	search(String queryJsonStr, int start, int limit)	Obtains the results matching a specified string on a page.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

getSearchHitCount

public int getSearchHitCount(String queryJsonStr)

Obtains the number of results matching a specified string.

This method quickly returns the number of matched results. After obtaining this number, you can call search(java.lang.String,int,int) to perform a pagination search.

参数:

queryJsonStr - Indicates the string to match.

返回:

Returns the number of results matching the specified string.

从以下版本开始:

3

search

public List<IndexData> search(String queryJsonStr,
                              int start,
                              int limit)

Obtains the results matching a specified string on a page.

This method is generally called after the total number of results matching a specified string is obtained using getSearchHitCount(java.lang.String).

参数:

queryJsonStr - Indicates the string to match.

start - Indicates the index of the first matched result in the result set. The value starts from 0. If the value is greater than the total number of matched results, an empty list will be returned.

limit - Indicates the maximum number of results allowed on this page. The value cannot exceed 10,000.

返回:

Returns the results matching the specified string on a page.

从以下版本开始:

3

groupSearch

public List<Recommendation> groupSearch(String queryJsonStr,
                                        int groupLimit)

Obtains and groups the results matching a specified string.

The matched results are grouped based on fields. The recommended maximum number of groups returned for each field (Recommendation) is specified by groupLimit.

参数:

queryJsonStr - Indicates the string to match.

groupLimit - Indicates the maximum number of groups returned for each field.

返回:

Returns the search results in multiple groups.

从以下版本开始:

3