程序包 ohos.data.search.schema

类 Schema<T>

java.lang.Object

ohos.data.search.model.IndexData

ohos.data.search.schema.Schema<T>

直接已知子类:

ActionItem, AppItem, CommonItem, ContactItem, DocumentItem, EmailItem, EventItem, MessageItem, MusicItem, NotepadItem, NoticeItem, PhotoItem, PlaceItem, VideoItem

public abstract class Schema<T>
extends IndexData

Represents an index schema.

The index schema supports the following index fields: identifier, title, subtitle, name, alternateName, category, dateCreate, keywords, description, thumbnailUrl, url, potentialAction, reserved1, and reserved2. All other schemas will inherit this class, for example, ContactItem, MessageItem, DocumentItem, EmailItem, and ContactItem.

从以下版本开始:

5

SystemCapability

SystemCapability.Data#DATA_SEARCH

构造器概要

构造器

构造器	说明
Schema()

方法概要

限定符和类型	方法	说明
String	getAlternateName()	Obtains the value of the alternateName index field.
String	getCategory()	Obtains the value of the category index field.
Long	getDateCreate()	Obtains the value of the dateCreate index field.
String	getDescription()	Obtains the value of the description index field.
String	getIdentifier()	Obtains the value of the identifier index field.
String	getKeywords()	Obtains the value of the keywords index field.
String	getName()	Obtains the value of the name index field.
String	getPotentialAction()	Obtains the value of the potentialAction index field.
String	getReserved1()	Obtains the value of the reserved1 index field.
String	getReserved2()	Obtains the value of the reserved2 index field.
String	getSubtitle()	Obtains the value of the subtitle index field.
String	getThumbnailUrl()	Obtains the value of the thumbnailUrl index field.
String	getTitle()	Obtains the value of the title index field.
String	getUrl()	Obtains the value of the url index field.
T	setAlternateName(String alternateName)	Sets the alternateName index field.
T	setCategory(String category)	Sets the category index field.
T	setDateCreate(Long dateCreate)	Sets the dateCreate index field.
T	setDescription(String description)	Sets the description index field.
T	setIdentifier(String identifier)	Sets the identifier index field.
T	setKeywords(String keywords)	Sets the keywords index field.
T	setName(String name)	Sets the name index field.
T	setPotentialAction(String potentialAction)	Sets the potentialAction index field, which describes the available action in an application, such as opening or downloading an application item.
T	setReserved1(String reserved1)	Sets the reserved1 index field, which is used to store custom attributes.
T	setReserved2(String reserved2)	Sets the reserved2 index field, which is used to store custom attributes.
T	setSubtitle(String subtitle)	Sets the subtitle index field.
T	setThumbnailUrl(String thumbnailUrl)	Sets the thumbnailUrl index field, which is used for displaying the thumbnail.
T	setTitle(String title)	Sets the title index field.
T	setUrl(String url)	Sets the url index field, which is used for redirecting the access.

从类继承的方法 ohos.data.search.model.IndexData

clear, get, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsString, getValues, isEmpty, put, put, put, put, put, remove, setValues, size

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

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

构造器详细资料

Schema

public Schema()

方法详细资料

getDateCreate

public Long getDateCreate()

Obtains the value of the dateCreate index field.

返回:

Returns the value of the dateCreate index field.

从以下版本开始:

5

getAlternateName

public String getAlternateName()

Obtains the value of the alternateName index field.

返回:

Returns the value of the alternateName index field.

从以下版本开始:

5

getCategory

public String getCategory()

Obtains the value of the category index field.

返回:

Returns the value of the category index field.

从以下版本开始:

5

getDescription

public String getDescription()

Obtains the value of the description index field.

返回:

Returns the value of the description index field.

从以下版本开始:

5

getIdentifier

public String getIdentifier()

Obtains the value of the identifier index field.

返回:

Returns the value of the identifier index field.

从以下版本开始:

5

getKeywords

public String getKeywords()

Obtains the value of the keywords index field.

返回:

Returns the value of the keywords index field.

从以下版本开始:

5

getName

public String getName()

Obtains the value of the name index field.

返回:

Returns the value of the name index field.

从以下版本开始:

5

getPotentialAction

public String getPotentialAction()

Obtains the value of the potentialAction index field.

返回:

Returns the value of the potentialAction index field.

从以下版本开始:

5

getReserved1

public String getReserved1()

Obtains the value of the reserved1 index field.

返回:

Returns the value of the reserved1 index field.

从以下版本开始:

5

getReserved2

public String getReserved2()

Obtains the value of the reserved2 index field.

返回:

Returns the value of the reserved2 index field.

从以下版本开始:

5

getSubtitle

public String getSubtitle()

Obtains the value of the subtitle index field.

返回:

Returns the value of the subtitle index field.

从以下版本开始:

5

getThumbnailUrl

public String getThumbnailUrl()

Obtains the value of the thumbnailUrl index field.

返回:

Returns the value of the thumbnailUrl index field.

从以下版本开始:

5

getTitle

public String getTitle()

Obtains the value of the title index field.

返回:

Returns the value of the title index field.

从以下版本开始:

5

getUrl

public String getUrl()

Obtains the value of the url index field.

返回:

Returns the value of the url index field.

从以下版本开始:

5

setAlternateName

public T setAlternateName(String alternateName)

Sets the alternateName index field.

Attributes of this index field: IndexForm.indexFieldName = "alternateName"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;

参数:

alternateName - Indicates the alternate name to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setCategory

public T setCategory(String category)

Sets the category index field.

Attributes of this index field: IndexForm.indexFieldName = "category"; IndexForm.indexType = IndexType.SORTED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;

参数:

category - Indicates the data category to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setDateCreate

public T setDateCreate(Long dateCreate)

Sets the dateCreate index field.

Attributes of this index field: IndexForm.indexFieldName = "dateCreate"; IndexForm.indexType = IndexType.LONG; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = false;

参数:

dateCreate - Indicates the creation date to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setDescription

public T setDescription(String description)

Sets the description index field.

Attributes of this index field: IndexForm.indexFieldName = "description"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;

参数:

description - Indicates the description to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setIdentifier

public T setIdentifier(String identifier)

Sets the identifier index field.

Attributes of this index field: IndexForm.indexFieldName = "identifier"; IndexForm.indexType = IndexType.NO_ANALYZED; IndexForm.isPrimaryKey = true; IndexForm.isStore = true; IndexForm.isSearch = false;

参数:

identifier - Indicates the identifier to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setKeywords

public T setKeywords(String keywords)

Sets the keywords index field.

Attributes of this index field: IndexForm.indexFieldName = "keywords"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;

参数:

keywords - Indicates the keywords to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setName

public T setName(String name)

Sets the name index field.

Attributes of this index field: IndexForm.indexFieldName = "name"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;

参数:

name - Indicates the name to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setPotentialAction

public T setPotentialAction(String potentialAction)

Sets the potentialAction index field, which describes the available action in an application, such as opening or downloading an application item.

Attributes of this index field: IndexForm.indexFieldName = "potentialAction"; IndexForm.indexType = IndexType.NO; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = false;

参数:

potentialAction - Indicates the potential action to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setReserved1

public T setReserved1(String reserved1)

Sets the reserved1 index field, which is used to store custom attributes.

Attributes of this index field: IndexForm.indexFieldName = "reserved1"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;

参数:

reserved1 - Indicates the reserved field to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setReserved2

public T setReserved2(String reserved2)

Sets the reserved2 index field, which is used to store custom attributes.

Attributes of this index field: IndexForm.indexFieldName = "reserved2"; IndexForm.indexType = IndexType.NO_ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = false;

参数:

reserved2 - Indicates the reserved field to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setSubtitle

public T setSubtitle(String subtitle)

Sets the subtitle index field.

Attributes of this index field: IndexForm.indexFieldName = "subtitle"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;

参数:

subtitle - Indicates the subtitle to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setThumbnailUrl

public T setThumbnailUrl(String thumbnailUrl)

Sets the thumbnailUrl index field, which is used for displaying the thumbnail.

Attributes of this index field: IndexForm.indexFieldName = "thumbnailUrl"; IndexForm.indexType = IndexType.NO; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = false;

参数:

thumbnailUrl - Indicates the thumbnail URL to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setTitle

public T setTitle(String title)

Sets the title index field.

Attributes of this index field: IndexForm.indexFieldName = "title"; IndexForm.indexType = IndexType.ANALYZED; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = true;

参数:

title - Indicates the title to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5

setUrl

public T setUrl(String url)

Sets the url index field, which is used for redirecting the access.

Attributes of this index field: IndexForm.indexFieldName = "url"; IndexForm.indexType = IndexType.NO; IndexForm.isPrimaryKey = false; IndexForm.isStore = true; IndexForm.isSearch = false;

参数:

url - Indicates the URL to set.

返回:

Returns the object that calls this method, for example, the DocumentItem object.

从以下版本开始:

5