程序包 ohos.data.search.schema

类 MusicItem

java.lang.Object

ohos.data.search.model.IndexData

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

ohos.data.search.schema.MusicItem

public final class MusicItem
extends Schema<MusicItem>

Represents the index schema for music items.

This schema is used to create indexes for music items. It supports index fields album, genre, artist, duration, size, 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	ALBUM	Indicates the index field name of album.
static String	ARTIST	Indicates the index field name of artist.
static String	DURATION	Indicates the index field name of duration.
static String	GENRE	Indicates the index field name of genre.
static String	SIZE	Indicates the index field name of size.

构造器概要

构造器

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

方法概要

限定符和类型	方法	说明
String	getAlbum()	Obtains the value of the album index field.
String	getArtist()	Obtains the value of the artist index field.
Integer	getDuration()	Obtains the value of the duration index field.
String	getGenre()	Obtains the value of the genre index field.
static List<IndexForm>	getMusicSchema()	Obtains a list of index field attributes in this MusicItem object.
Integer	getSize()	Obtains the value of the size index field.
MusicItem	setAlbum(String album)	Sets the album index field.
MusicItem	setArtist(String artist)	Sets the artist index field.
MusicItem	setDuration(Integer duration)	Sets the duration index field.
MusicItem	setGenre(String genre)	Sets the genre index field.
MusicItem	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

字段详细资料

ALBUM

public static final String ALBUM

Indicates the index field name of album.

从以下版本开始:

5

另请参阅:

常量字段值

ARTIST

public static final String ARTIST

Indicates the index field name of artist.

从以下版本开始:

5

另请参阅:

常量字段值

DURATION

public static final String DURATION

Indicates the index field name of duration.

从以下版本开始:

5

另请参阅:

常量字段值

GENRE

public static final String GENRE

Indicates the index field name of genre.

从以下版本开始:

5

另请参阅:

常量字段值

SIZE

public static final String SIZE

Indicates the index field name of size.

从以下版本开始:

5

另请参阅:

常量字段值

构造器详细资料

MusicItem

public MusicItem()

A constructor used to create a MusicItem instance.

从以下版本开始:

5

方法详细资料

getMusicSchema

public static List<IndexForm> getMusicSchema()

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

返回:

Returns a list of index field attributes.

从以下版本开始:

5

setArtist

public MusicItem setArtist(String artist)

Sets the artist index field.

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

参数:

artist - Indicates the artist who plays the music.

返回:

Returns the MusicItem object.

从以下版本开始:

5

setGenre

public MusicItem setGenre(String genre)

Sets the genre index field.

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

参数:

genre - Indicates the music genre.

返回:

Returns the MusicItem object.

从以下版本开始:

5

setDuration

public MusicItem setDuration(Integer duration)

Sets the duration index field.

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

参数:

duration - Indicates the music duration in seconds.

返回:

Returns the MusicItem object.

从以下版本开始:

5

setAlbum

public MusicItem setAlbum(String album)

Sets the album index field.

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

参数:

album - Indicates the album to which the music belongs.

返回:

Returns the MusicItem object.

从以下版本开始:

5

setSize

public MusicItem 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 music file size.

返回:

Returns the MusicItem object.

从以下版本开始:

5

getDuration

public Integer getDuration()

Obtains the value of the duration index field.

返回:

Returns the value of the duration index field.

从以下版本开始:

5

getArtist

public String getArtist()

Obtains the value of the artist index field.

返回:

Returns the value of the artist index field.

从以下版本开始:

5

getGenre

public String getGenre()

Obtains the value of the genre index field.

返回:

Returns the value of the genre index field.

从以下版本开始:

5

getAlbum

public String getAlbum()

Obtains the value of the album index field.

返回:

Returns the value of the album index field.

从以下版本开始:

5

getSize

public Integer getSize()

Obtains the value of the size index field.

返回:

Returns the value of the size index field.

从以下版本开始:

5