コンテンツにスキップ

abstract Resource

リソースを表現するクラスです。 URLやキャッシュ、クラウドサービス等、各種リソースへのアクセス（認証処理含む）を同一インターフェースで提供することを目的とした抽象クラスです。

基本機能:

  • コンストラクタ等によりあらかじめURLやデータの位置を示すプロパティを設定
  • load() によりメインリソースを読み込む
  • loadSubResource(url) によりサブリソースを読み込む
  • resolveResource(url) により、関連リソースを作成する。

Filter:

  • loadSubResourceSupported(url) により、サブリソースを読み込むことができるか判定する
  • resolveResourceSupported(url) により、関連リソースを作成できるか判定する
  • Resource.setFilter(filter) により、上記判定を行うフィルタを設定する
  • Resource.setFallbackResource(resource) により、このリソースが処理できない場合に、処理を代替するリソースを指定する

デフォルトの動作は、フィルタは全ての url を許可し fallback_resource は指定されていない。

Extended by

Constructors

new Resource()

new Resource(): Resource

Returns

Resource

Properties

_filter

protected _filter: FilterFunc = DEFAULT_FILTER

Methods

cancel()

cancel(): void

リソースの読み込みをキャンセルできる場合はキャンセルします。

Returns

void

load()

load(options): Promise<any>

リソースを読み込みます。

Parameters

Parameter Type
options Option

Returns

Promise<any>

loadAsBinary()

loadAsBinary(options): Promise<ArrayBuffer>

バイナリリソースを読み込みます。

Parameters

Parameter Type
options Option

Returns

Promise<ArrayBuffer>

loadAsImage()

loadAsImage(options): Promise<HTMLImageElement>

イメージリソースを読み込みます。

Parameters

Parameter Type
options Option

Returns

Promise<HTMLImageElement>

loadAsJson()

loadAsJson(options): Promise<object>

Jsonリソースを読み込みます。

Parameters

Parameter Type
options Option

Returns

Promise<object>

loadAsText()

loadAsText(options): Promise<string>

テキストリソースを読み込みます。

Parameters

Parameter Type
options Option

Returns

Promise<string>

loadSubResource()

loadSubResource(url, options): Promise<any>

サブリソースを読み込みます。

Parameters

Parameter Type Description
url string URL
options Option

Returns

Promise<any>

options.type に応じた型で返却されます。

See

loadSubResourceSupported

loadSubResourceAsBinary()

loadSubResourceAsBinary(url, options): Promise<ArrayBuffer>

バイナリリソースを読み込みます。

Parameters

Parameter Type
url string
options Option

Returns

Promise<ArrayBuffer>

loadSubResourceAsImage()

loadSubResourceAsImage(url, options): Promise<HTMLImageElement>

イメージリソースを読み込みます。

Parameters

Parameter Type
url string
options Option

Returns

Promise<HTMLImageElement>

loadSubResourceAsJson()

loadSubResourceAsJson(url, options): Promise<object>

Jsonリソースを読み込みます。

Parameters

Parameter Type
url string
options Option

Returns

Promise<object>

loadSubResourceAsText()

loadSubResourceAsText(url, options): Promise<string>

テキストリソースを読み込みます。

Parameters

Parameter Type
url string
options Option

Returns

Promise<string>

loadSubResourceSupported()

loadSubResourceSupported(url): boolean

サブリソース（url）へのアクセスをサポートするかを判定します。

Parameters

Parameter Type
url string

Returns

boolean

resolveResource()

resolveResource(url): Resource

関連リソースを読み込みます。

このクラスでの実装は、 - フォールバックリソースが設定されている場合はそのリソースに処理を委託し、 - フォールバックリソースがない場合は例外をスローします。 具象クラスにおいて、処理可能な url について処理を行い、それ以外の url についてこの関数で処理する想定です。

Parameters

Parameter Type
url string

Returns

Resource

See

resolveResourceSupported

resolveResourceSupported()

resolveResourceSupported(url): boolean

関連リソース(url)を作成可能かを判定します。

Parameters

Parameter Type
url string

Returns

boolean

setFallbackResource()

setFallbackResource(resource?): void

フォールバックリソースを設定します。

このリソースで処理できない url については、フォールバックリソースによって処理されます。

Parameters

Parameter Type
resource? Resource

Returns

void

See

resolveResourceSupported

setFilter()

setFilter(filter): void

このリソースにおいて、サブリソースの読み込みおよび関連リソースの作成が可能な url であるかを判別する filter を設定します。

Parameters

Parameter Type
filter Filter

Returns

void

See

resolveResourceSupported

toString()

toString(): string

リソースのテキスト表現

Returns

string