程序包 ohos.data.search.schema

类 DocumentItem

java.lang.Object

ohos.data.search.model.IndexData

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

ohos.data.search.schema.DocumentItem

public final class DocumentItem
extends Schema<DocumentItem>

Represents the index schema for document items.

This schema is used to create indexes for document items. It supports index fields author, documentCategory, size, path, content, and all the fields in CommonItem. Among these fields, identifier is mandatory and can be set via the CommonItem#setIdentifier(String) method.

从以下版本开始:

5

SystemCapability

SystemCapability.Data#DATA_SEARCH

字段概要

字段

限定符和类型	字段	说明
static String	AUTHOR	Indicates the index field name of author.
static String	CONTENT	Indicates the index field name of content.
static String	DOCUMENT_CATEGORY	Indicates the index field name of documentCategory.
static String	PATH	Indicates the index field name of path.
static String	SIZE	Indicates the index field name of size.

构造器概要

构造器

构造器	说明
DocumentItem()	A constructor used to create a DocumentItem instance.

方法概要

限定符和类型	方法	说明
String	getAuthor()	Obtains the value of the author index field.
String	getContent()	Obtains the value of the content index field.
String	getDocumentCategory()	Obtains the value of the documentCategory index field.
static List<IndexForm>	getDocumentSchema()	Obtains a list of index field attributes in this DocumentItem object.
String	getPath()	Obtains the value of the path index field.
Integer	getSize()	Obtains the value of the size index field.
DocumentItem	setAuthor(String author)	Sets the author index field.
DocumentItem	setContent(String content)	Sets the content index field.
DocumentItem	setDocumentCategory(String documentCategory)	Sets the documentCategory index field.
DocumentItem	setPath(String path)	Sets the path index field.
DocumentItem	setSize(Integer size)	Sets the size index field.

从类继承的方法 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

从类继承的方法 ohos.data.search.schema.Schema

getAlternateName, getCategory, getDateCreate, getDescription, getIdentifier, getKeywords, getName, getPotentialAction, getReserved1, getReserved2, getSubtitle, getThumbnailUrl, getTitle, getUrl, setAlternateName, setCategory, setDateCreate, setDescription, setIdentifier, setKeywords, setName, setPotentialAction, setReserved1, setReserved2, setSubtitle, setThumbnailUrl, setTitle, setUrl

字段详细资料

AUTHOR

public static final String AUTHOR

Indicates the index field name of author.

从以下版本开始:

5

另请参阅:

常量字段值

CONTENT

public static final String CONTENT

Indicates the index field name of content.

从以下版本开始:

5

另请参阅:

常量字段值

DOCUMENT_CATEGORY

public static final String DOCUMENT_CATEGORY

Indicates the index field name of documentCategory.

从以下版本开始:

5

另请参阅:

常量字段值

PATH

public static final String PATH

Indicates the index field name of path.

从以下版本开始:

5

另请参阅:

常量字段值

SIZE

public static final String SIZE

Indicates the index field name of size.

从以下版本开始:

5

另请参阅:

常量字段值

构造器详细资料

DocumentItem

public DocumentItem()

A constructor used to create a DocumentItem instance.

从以下版本开始:

5

方法详细资料

getDocumentSchema

public static List<IndexForm> getDocumentSchema()

Obtains a list of index field attributes in this DocumentItem object.

返回:

Returns a list of index field attributes.

从以下版本开始:

5

setAuthor

public DocumentItem setAuthor(String author)

Sets the author index field.

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

参数:

author - Indicates the document author.

返回:

Returns the DocumentItem object.

从以下版本开始:

5

setDocumentCategory

public DocumentItem setDocumentCategory(String documentCategory)

Sets the documentCategory index field.

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

参数:

documentCategory - Indicates the document category.

返回:

Returns the DocumentItem object.

从以下版本开始:

5

setSize

public DocumentItem setSize(Integer size)

Sets the size index field.

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

参数:

size - Indicates the document size.

返回:

Returns the DocumentItem object.

从以下版本开始:

5

setContent

public DocumentItem setContent(String content)

Sets the content index field.

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

参数:

content - Indicates the document content.

返回:

Returns the DocumentItem object.

从以下版本开始:

5

setPath

public DocumentItem setPath(String path)

Sets the path index field.

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

参数:

path - Indicates the document path.

返回:

Returns the DocumentItem object.

从以下版本开始:

5

getAuthor

public String getAuthor()

Obtains the value of the author index field.

返回:

Returns the value of the author index field.

从以下版本开始:

5

getDocumentCategory

public String getDocumentCategory()

Obtains the value of the documentCategory index field.

返回:

Returns the value of the documentCategory index field.

从以下版本开始:

5

getSize

public Integer getSize()

Obtains the value of the size index field.

返回:

Returns the value of the size index field.

从以下版本开始:

5

getContent

public String getContent()

Obtains the value of the content index field.

返回:

Returns the value of the content index field.

从以下版本开始:

5

getPath

public String getPath()

Obtains the value of the path index field.

返回:

Returns the value of the path index field.

从以下版本开始:

5