com.docomostar.ui.avplayer
クラス DataManager

Object
  上位を拡張 com.docomostar.ui.avplayer.DataManager

public final class DataManager
extends Object
 [iアプリオプションAPI]

音楽プレイヤーで利用するデータベースを管理するクラスを定義します。

データベースは ManagedData のサブクラス(プレイリストコンテンツなど)を管理します。 このクラスではデータベースの更新機能、及びデータベースからコンテンツやプレイリストを取得する機能を提供します。

データベース内の全てのプレイリストを取得したい場合は getAllPlaylists(int) メソッドを使用してください。 データベース内の全てのコンテンツを取得したい場合は getAllContents(int) メソッドを使用してください。 コンテンツをフィルタリングして取得したい場合は、このクラスのフィルタリングメソッド、及び Filterable のインタフェース説明を参照してください。

データベースの更新が必要な状態、およびデータベースの更新中において、 データベースからコンテンツやプレイリストの取得を試みた場合は UIException(UNDEFINED) が発生します。

導入されたバージョン:
Star-1.5

メソッドの概要
static AlbumList getAlbums(int fileType, int target, String str)
           条件を指定して、アルバムの一覧を取得します。
static AlbumList getAllAlbums(int fileType)
           アルバムの一覧を取得します。
static ArtistList getAllArtists(int fileType)
           アーティストの一覧を取得します。
static ContentList getAllContents(int fileType)
           コンテンツの一覧を取得します。
static GenreList getAllGenres(int fileType)
           ジャンルの一覧を取得します。
static Playlist[] getAllPlaylists(int fileType)
           端末に保持されているプレイリストの一覧を取得します。
static ArtistList getArtists(int fileType, int target, String str)
           条件を指定して、アーティストの一覧を取得します。
static ContentList getContents(int fileType, int target, String str)
           条件を指定して、コンテンツの一覧を取得します。
static GenreList getGenres(int fileType, int target, String str)
           条件を指定して、ジャンルの一覧を取得します。
static boolean isDirtyDataBase()
           データベースの更新が必要かどうかをチェックします。
static void updateDataBase()
           データベースを更新します。
 
クラス Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

isDirtyDataBase

public static boolean isDirtyDataBase()

データベースの更新が必要かどうかをチェックします。

このメソッドが true を返す場合、音楽プレイヤーのデータベースの更新が必要となります。 ネイティブのデータベースの情報と音楽プレイヤーのデータベースの情報に不整合がある場合に、 音楽プレイヤーのデータベースの更新が必要となります。

データベースの更新が必要な状態において、 データベースへアクセスが必要なメソッドを呼び出した場合、 そのメソッドにおいて例外が発生します。 データベースにアクセスが必要なメソッドについては DataManager を参照してください。

外部メモリが挿抜されたり、 マルチタスク機能によってネイティブでコンテンツやプレイリストが編集されたり、 コンテンツ取得保存機能によるコンテンツ取得などによって、 ネイティブのデータベース情報と音楽プレイヤーのデータベースの情報に不整合が生じた場合に 音楽プレイヤーのデータベースの更新が必要となります。 PlayerEvent.ERROR_DATABASE_NEED_UPDATE イベントが発生した場合や、 レジュームから復帰した場合にこのメソッドを呼んでください。

戻り値:
データベースの更新が必要な場合は true, そうでない場合は false を返します。
例外:
UnsupportedOperationException -
音楽プレイヤー機能をサポートしていない場合に発生します。
UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。
UIException -
(UNDEFINED)
何らかの理由によりデータベース更新フラグの取得に失敗した場合に発生します。

updateDataBase

public static void updateDataBase()

データベースを更新します。

音楽プレイヤーのデータベースの更新が必要な状態でこのメソッドを実行すると、データベースを更新して整合性を確保します。 データベースの更新には時間がかかりますが、処理が完了するまでこのメソッドはブロックされます。 データベースの更新中にデータベースへアクセスが必要なメソッドを呼び出した場合、 そのメソッドにおいて例外が発生します。 データベースにアクセスが必要なメソッドについては DataManager を参照してください。

データベースの更新が必要な状態(isDirtyDataBase()true を返す状態)でこのメソッドを呼んでください。 データベースの更新が必要ない状態でこのメソッドが呼ばれても何も行いません。 ただし、音楽再生ソフトウェアが利用不可能状態でこのメソッドが呼ばれた場合は、例外が発生します。

関連項目:
isDirtyDataBase()
例外:
UnsupportedOperationException -
音楽プレイヤー機能をサポートしていない場合に発生します。
UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。
UIException -
(NO_RESOURCES)
リソース不足によりデータベースの更新に失敗した場合に発生します。
UIException -
(UNDEFINED)
何らかの理由によりデータベースの更新に失敗した場合に発生します。

getAllArtists

public static ArtistList getAllArtists(int fileType)

アーティストの一覧を取得します。

getArtists(fileType, Filterable.TYPE_ARTIST, null) の取得結果と同じです。

引数 fileType には取得するコンテンツのファイル種別を指定して下さい。

アーティストが 1 件も見つからなかった場合 null を返します。

このメソッドを実行するには、 ADF に AccessUserInfo キーが指定されている必要があります。

パラメータ:
fileType - 取得するコンテンツのファイル種別を指定します。FilteringResult.FILE_MUSIC のみ指定できます。
戻り値:
アーティスト一覧を返します。
関連項目:
FilteringResult.FILE_MUSIC
例外:
UnsupportedOperationException -
音楽プレイヤー機能をサポートしていない場合に発生します。
IllegalArgumentException -
引数 fileType が不正な場合に発生します。
SecurityException -
ADF に AccessUserInfo キーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。
UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。
UIException -
(NO_RESOURCES)
リソース不足により一覧の取得に失敗した場合に発生します。
UIException -
(UNDEFINED)
何らかの理由で一覧の取得に失敗した場合に発生します。

getArtists

public static ArtistList getArtists(int fileType,
                                    int target,
                                    String str)

条件を指定して、アーティストの一覧を取得します。

引数 fileType には取得するコンテンツのファイル種別を指定して下さい。 引数 target と引数 str の詳細は、Filterable インタフェースを参照して下さい。

条件に合うアーティストが 1 件も見つからなかった場合 null を返します。

このメソッドを実行するには、 ADF に AccessUserInfo キーが指定されている必要があります。

パラメータ:
fileType - 取得するコンテンツのファイル種別を指定します。FilteringResult.FILE_MUSIC のみ指定できます。
target - フィルタリング対象タイプを指定します。
str - フィルタリング文字列を指定します。
戻り値:
アーティスト一覧を返します。
関連項目:
FilteringResult.FILE_MUSIC, Filterable.TYPE_ARTIST, Filterable.TYPE_ALBUM, Filterable.TYPE_GENRE, Filterable.TYPE_CONTENT
例外:
UnsupportedOperationException -
音楽プレイヤー機能をサポートしていない場合に発生します。
IllegalArgumentException -
引数 fileType, target が不正な場合に発生します。
SecurityException -
ADF に AccessUserInfo キーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。
UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。
UIException -
(NO_RESOURCES)
リソース不足により一覧の取得に失敗した場合に発生します。
UIException -
(UNDEFINED)
何らかの理由で一覧の取得に失敗した場合に発生します。

getAllAlbums

public static AlbumList getAllAlbums(int fileType)

アルバムの一覧を取得します。

getAlbums(fileType, Filterable.TYPE_ALBUM, null) の取得結果と同じです。

引数 fileType には取得するコンテンツのファイル種別を指定して下さい。

アルバムが 1 件も見つからなかった場合 null を返します。

このメソッドを実行するには、 ADF に AccessUserInfo キーが指定されている必要があります。

パラメータ:
fileType - 取得するコンテンツのファイル種別を指定します。FilteringResult.FILE_MUSIC のみ指定できます。
戻り値:
アルバム一覧を返します。
関連項目:
FilteringResult.FILE_MUSIC
例外:
UnsupportedOperationException -
音楽プレイヤー機能をサポートしていない場合に発生します。
IllegalArgumentException -
引数 fileType が不正な場合に発生します。
SecurityException -
ADF に AccessUserInfo キーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。
UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。
UIException -
(NO_RESOURCES)
リソース不足により一覧の取得に失敗した場合に発生します。
UIException -
(UNDEFINED)
何らかの理由で一覧の取得に失敗した場合に発生します。

getAlbums

public static AlbumList getAlbums(int fileType,
                                  int target,
                                  String str)

条件を指定して、アルバムの一覧を取得します。

引数 fileType には取得するコンテンツのファイル種別を指定して下さい。 引数 target と引数 str の詳細は、Filterable インタフェースを参照して下さい。

条件に合うアルバムが 1 件も見つからなかった場合 null を返します。

このメソッドを実行するには、 ADF に AccessUserInfo キーが指定されている必要があります。

パラメータ:
fileType - 取得するコンテンツのファイル種別を指定します。FilteringResult.FILE_MUSIC のみ指定できます。
target - フィルタリング対象タイプを指定します。
str - フィルタリング文字列を指定します。
戻り値:
アルバム一覧を返します。
関連項目:
FilteringResult.FILE_MUSIC, Filterable.TYPE_ARTIST, Filterable.TYPE_ALBUM, Filterable.TYPE_GENRE, Filterable.TYPE_CONTENT
例外:
UnsupportedOperationException -
音楽プレイヤー機能をサポートしていない場合に発生します。
IllegalArgumentException -
引数 fileType, target が不正な場合に発生します。
SecurityException -
ADF に AccessUserInfo キーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。