com.docomostar.ui.avplayer
クラス FilteringResult

Object
  com.docomostar.ui.avplayer.FilteringResult

すべての実装されたインタフェース:

Filterable

直系の既知のサブクラス:

AlbumList, ArtistList, ContentList, GenreList

public abstract class FilteringResult
extends Object
implements Filterable

[iアプリオプションAPI]

フィルタリングによるコンテンツのフィルタリング結果(コンテンツの一覧)を定義します。

フィルタリング結果自身も Filterable インタフェースを実装しているため、 このフィルタリング結果を元に、更に条件を追加してフィルタリングすることが可能です。 具体的なフィルタリングの方法については Filterable インタフェースの説明を参照して下さい。

フィルタリング結果は getPlaylist() を呼び出すことでプレイリスト化することが可能です。

導入されたバージョン:

Star-1.5

関連項目:

DataManager.getAlbums(int, int, String), DataManager.getArtists(int, int, String), DataManager.getGenres(int, int, String), DataManager.getContents(int, int, String), DataManager.getAllAlbums(int), DataManager.getAllArtists(int), DataManager.getAllGenres(int), DataManager.getAllContents(int), Filterable.filter(int, int, String), Filterable.filter(FilteringElement)

フィールドの概要

static int

FILE_MUSIC フィルタリングの対象を表す定数の 1 つで、音楽のみをフィルタリングすることを表します(=1)。

インタフェース com.docomostar.ui.avplayer.Filterable から継承されたフィールド

TYPE_ALBUM, TYPE_ARTIST, TYPE_CONTENT, TYPE_GENRE

メソッドの概要

FilteringResult	filter(FilteringElement element) 検索条件を指定してフィルタリングを行います。
FilteringResult	filter(int resultType, int target, String str) 検索条件を指定してフィルタリングを行います。
int[]	getAvailableTargetType() フィルタリング時に検索条件として指定可能な検索対象のリストを返します。
int	getFileType() このフィルタリング結果が保持しているコンテンツのファイル種別を取得します。
FilteringElement[]	getFilteringElements() フィルタリング要素履歴を取得します。
Playlist	getPlaylist() このフィルタリング結果からプレイリストを生成します。

クラス Object から継承されたメソッド

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

フィールドの詳細

FILE_MUSIC

public static final int FILE_MUSIC

フィルタリングの対象を表す定数の 1 つで、音楽のみをフィルタリングすることを表します(=1)。

関連項目:

DataManager, getFileType(), 定数フィールド値

メソッドの詳細

getFileType

public int getFileType()

このフィルタリング結果が保持しているコンテンツのファイル種別を取得します。

このフィルタリング結果が DataManager の各メソッド呼び出しにより取得したものである場合は、 その時に、 そのメソッドの引数に指定したファイル種別と同じ値が返されます。

一方、このフィルタリング結果が、 Filterable.filter(int, int, String) メソッド呼び出しや Filterable.filter(FilteringElement) メソッド呼び出しによって取得したものである場合は、 元となったフィルタリング結果オブジェクトの getFileType() の値と同じ値が返されます。

戻り値:

このフィルタリング結果が保持しているコンテンツのファイル種別を返します。

関連項目:

FILE_MUSIC

getPlaylist

public Playlist getPlaylist()

このフィルタリング結果からプレイリストを生成します。

生成されたプレイリストのタイトル名は機種依存です。

戻り値:

このフィルタリング結果をもとに生成されたプレイリストを返します。

例外:

UIException -
(NO_RESOURCES)
リソース不足によりプレイリストの取得に失敗した場合に発生します。

UIException -
(UNDEFINED)
何らかの理由でプレイリストの取得に失敗した場合に発生します。

getFilteringElements

public FilteringElement[] getFilteringElements()

フィルタリング要素履歴を取得します。 このフィルタリング結果に辿り着くまでに指定してきた検索条件全てを取得します。

検索条件の履歴は FilteringElement の配列として取得できます。 その配列には、インデックスが若い要素ほど、古い検索条件が格納されています。

戻り値:

このフィルタリング結果に辿りつくまでの検索条件全てを、 FilteringElement の配列として返します。

filter

public FilteringResult filter(int resultType,
                              int target,
                              String str)

インタフェース Filterable の記述:

検索条件を指定してフィルタリングを行います。 検索条件の指定方法については、 Filterable インタフェース説明を参照して下さい。

定義:

インタフェース Filterable 内の filter

パラメータ:

resultType - フィルタリング結果タイプを指定します。

target - 検索対象を指定します。

str - 検索文字列を指定します。

戻り値:

指定された検索条件にマッチするコンテンツのみにフィルタリングした結果を返します。 検索条件にマッチするものが無かった場合には null を返します。

関連項目:

Filterable.TYPE_ARTIST, Filterable.TYPE_ALBUM, Filterable.TYPE_GENRE, Filterable.TYPE_CONTENT

例外:

UnsupportedOperationException -
フィルタリング結果に対する再フィルタリングをサポートしていない場合に発生します。

IllegalArgumentException -
引数 resultType が不正な場合に発生します。

IllegalArgumentException -
引数 target が不正な場合に発生します。

UIException -
(NO_RESOURCES)
リソース不足によりフィルタリングに失敗した場合に発生します。

UIException -
(UNDEFINED)
何らかの理由でフィルタリングに失敗した場合に発生します。

filter

public FilteringResult filter(FilteringElement element)

インタフェース Filterable の記述:

検索条件を指定してフィルタリングを行います。 検索条件の指定方法については、 Filterable インタフェース説明を参照して下さい。

定義:

インタフェース Filterable 内の filter

パラメータ:

element - フィルタリングのための検索条件を指定します。

戻り値:

指定された検索条件にマッチするコンテンツのみにフィルタリングした結果を返します。 検索条件にマッチするものが無かった場合には null を返します。

例外:

UnsupportedOperationException -
フィルタリング結果に対する再フィルタリングをサポートしていない場合に発生します。

NullPointerException -
引数 element が null の場合に発生します。

UIException -
(NO_RESOURCES)
リソース不足によりフィルタリングに失敗した場合に発生します。

UIException -
(UNDEFINED)
何らかの理由でフィルタリングに失敗した場合に発生します。

getAvailableTargetType

public int[] getAvailableTargetType()

フィルタリング時に検索条件として指定可能な検索対象のリストを返します。

本メソッドを呼び出すことによって、このフィルタリング結果から再フィルタリングを行う際に、 検索条件として指定可能な検索対象の値を確認することができます。

このメソッドによって取得した値以外を検索対象に指定して、 filter メソッドを呼び出した場合、UnsupportedOperationException が発生します。

戻り値:

検索条件として指定可能な検索対象のリストを返します。 指定可能な検索対象が無い場合は null を返します。

関連項目:

Filterable.TYPE_ARTIST, Filterable.TYPE_ALBUM, Filterable.TYPE_GENRE