程序包 ohos.data.search.model

接口 SearchParameter

public interface SearchParameter

Defines keywords of search types supported by fusion search.

A search string is generated by JSONObject. When creating a JSONObject used for search, use the keywords defined by this class as keys, and use the subsearches as values.

从以下版本开始:

3

SystemCapability

SystemCapability.Data#DATA_SEARCH

字段概要

字段

限定符和类型	字段	说明
static String	ASC	Keyword used for sorting indexes in ascending order based on a specified field.
static String	DEFAULT_GROUP	Keyword specifying the path where the indexes of the local device are stored.
static String	DESC	Keyword used for sorting indexes in descending order based on a specified field.
static String	DEVICE_ID_LIST	Keyword that maps to a JSONObject consisting of device IDs.
static String	FILTER_CONDITION	Keyword that maps to a JSONArray consisting of specified filters.
static String	GROUP_FIELD_LIST	Keyword that maps to a JSONArray consisting of index fields used for group search.
static String	LOWER	Keyword used for obtaining indexes whose values are greater than a specified field value based on the lexicographical order.
static String	ORDER_BY	Keyword that maps to a JSONObject consisting of specified sorting fields and orders.
static String	QUERY	Keyword that maps to a JSONObject consisting of a user input and specified search fields.
static String	RAW_QUERY	Keyword used as the key of the key-value pair (whose value is the passed search string) contained in IndexData returned by SearchAbility#deleteByQuery(String,String,String)
static String	UPPER	Keyword used for obtaining indexes whose values are less than a specified field value based on the lexicographical order.

字段详细资料

ASC

static final String ASC

Keyword used for sorting indexes in ascending order based on a specified field. When creating a JSONObject for sorting indexes, use a specified field as the key and use this keyword as the value. Note that you can use multiple sorting fields. When two indexes tie on the first field, the next one will be used to sort.

从以下版本开始:

3

另请参阅:

常量字段值

DEFAULT_GROUP

static final String DEFAULT_GROUP

Keyword specifying the path where the indexes of the local device are stored. When calling the SearchAbility#beginSearch(String,String) method, you should pass this keyword to groupId.

从以下版本开始:

3

另请参阅:

常量字段值

DESC

static final String DESC

Keyword used for sorting indexes in descending order based on a specified field. When creating a JSONObject for sorting indexes, use a specified field as the key and use this keyword as the value. Note that you can use multiple sorting fields. When two indexes tie on the first field, the next one will be used to sort.

从以下版本开始:

3

另请参阅:

常量字段值

DEVICE_ID_LIST

static final String DEVICE_ID_LIST

Keyword that maps to a JSONObject consisting of device IDs.

从以下版本开始:

3

另请参阅:

常量字段值

FILTER_CONDITION

static final String FILTER_CONDITION

Keyword that maps to a JSONArray consisting of specified filters.

从以下版本开始:

3

另请参阅:

常量字段值

GROUP_FIELD_LIST

static final String GROUP_FIELD_LIST

Keyword that maps to a JSONArray consisting of index fields used for group search.

从以下版本开始:

3

另请参阅:

常量字段值

LOWER

static final String LOWER

Keyword used for obtaining indexes whose values are greater than a specified field value based on the lexicographical order. When creating a JSONObject for a range query, use this keyword as the key and use the specified field value as the value.

从以下版本开始:

3

另请参阅:

常量字段值

ORDER_BY

static final String ORDER_BY

Keyword that maps to a JSONObject consisting of specified sorting fields and orders.

从以下版本开始:

3

另请参阅:

常量字段值

QUERY

static final String QUERY

Keyword that maps to a JSONObject consisting of a user input and specified search fields.

从以下版本开始:

3

另请参阅:

常量字段值

RAW_QUERY

static final String RAW_QUERY

Keyword used as the key of the key-value pair (whose value is the passed search string) contained in IndexData returned by SearchAbility#deleteByQuery(String,String,String)

另请参阅:

常量字段值

UPPER

static final String UPPER

Keyword used for obtaining indexes whose values are less than a specified field value based on the lexicographical order. When creating a JSONObject for a range query, use this keyword as the key and use the specified field value as the value.

从以下版本开始:

3

另请参阅:

常量字段值