6.3.2 CustomContent.simt
Simtデータを操作するメソッドを提供します。CustomContent.simtが提供するメソッドを次に示します。
|
項番 |
メソッド名 |
説明 |
|---|---|---|
|
1 |
encodeValue |
文字列をURLエンコードして返却するメソッドです。 |
|
2 |
decodeValue |
URLエンコードされた文字列をデコードして返却するメソッドです。 |
|
3 |
filter |
指定された構造化IDを含むSIDとそのvalue値を返却するメソッドです。 |
|
4 |
get |
指定されたSIDに一致するSIDとそのvalue値を返却するメソッドです。 |
|
5 |
pack |
構造化IDの種別と名称を結合し，生成した構造化IDを返却するメソッドです。 |
|
6 |
packHost |
構造化IDの種別とホスト名を結合し，生成した構造化IDを返却するメソッドです。 |
|
7 |
unpack |
構造化IDを種別と名称で分割し，返却するメソッドです。 |
|
8 |
join |
構造化ID を結合し，生成したSID を返却するメソッドです。 |
|
9 |
split |
SIDを構造化IDに分割し，返却するメソッドです。 |
|
10 |
parse |
SID を構造化IDに分割し，分割した構造化IDをさらに種別とURLデコードした名称に分割し返却するメソッドです。 |
|
11 |
data |
SIDとvalue値から，オブジェクトを生成し，返却するメソッドです。 |
- 〈この項の構成〉
(1) encodeValueメソッド
- 機能
-
パラメーターに指定された文字列の「.」「~」「-」「:」以外の記号，英数字以外をURLエンコードし，返却するメソッドです。
- 形式
-
encodeValue(value)
- 引数
-
- value
-
URLエンコードする文字列
- 戻り値
-
URLエンコードされた文字列
(2) decodeValueメソッド
- 機能
-
パラメーターに指定された文字列をデコードし，返却するメソッドです。
- 形式
-
decodeValue(value)
- 引数
-
- value
-
URLエンコードされた文字列
- 戻り値
-
URLデコードされた文字列
(3) filterメソッド
- 機能
-
第1パラメーターに指定されたSimtDataオブジェクト（SIDとvalue値の情報をまとめたオブジェクト）の配列から，第2パラメーターに指定された構造化IDを含むSIDを持つSimtDataオブジェクトを抜き出して返却するメソッドです。
- 形式
-
filter(array, pattern)
- 引数
-
- array
-
SimtDataオブジェクト※の配列
- pattern
-
構造化ID
- 戻り値
-
SimtDataオブジェクト※の配列
指定された構造化IDを含むSIDを持つSimtData※
オブジェクトが存在しない場合は空の配列を返却します。
- 注※ SimtDataオブジェクトには次に示すプロパティが存在します。
-
-
sid：SIDを示す文字列
-
value：SIDの値を格納するオブジェクト
-
(4) getメソッド
- 機能
-
第1パラメーターに指定されたSimtDataオブジェクト（SIDとvalue値の情報をまとめたオブジェクト）の配列から，第2パラメーターに指定されたSIDに一致するSIDを持つSimtDataオブジェクトを抜き出して返却するメソッドです。
- 形式
-
get(array, sid)
- 引数
-
- array
-
SimtDataオブジェクト※の配列
- pattern
-
SID
- 戻り値
-
SimtDataオブジェクト※
指定されたSIDと一致するSIDを持つSimtDataオブジェクト※
オブジェクトが存在しない場合は空のnullを返却します。
- 注※ SimtDataオブジェクトには次に示すプロパティが存在します。
-
-
sid：SIDを示す文字列
-
value：SIDの値を格納するオブジェクト
-
(5) packメソッド
- 機能
-
第1パラメーターに指定された構造化IDの種別（アンダースコア以外）を「_（アンダースコア）」で括り，第2パラメーターに指定された名称のうち「.」「~」「-」「:」以外の記号，英数字以外をURLエンコードしたあとに，種別，名称の順で結合し，生成した構造化IDを返却するメソッドです。
- 形式
-
pack(key, value)
- 引数
-
- key
-
構造化IDの種別
- value
-
構造化IDの名称
- 戻り値
-
構造化IDの文字列
(6) packHostメソッド
- 機能
-
第1パラメーターに指定された構造化IDの種別（アンダースコア以外）を「_（アンダースコア）」で括り，第2パラメーターに指定された名称（ホスト名）を大文字変換および「.」「~」「-」「:」以外の記号，英数字以外をURLエンコードしたあとに，種別，名称の順で結合し，生成した構造化IDを返却するメソッドです。
名称がホスト名以外の構造化IDを作成する場合は，CustomContent.simt.packメソッドを使用します。
- 形式
-
packHost(key, value)
- 引数
-
- key
-
構造化IDの種別
- value
-
構造化IDの名称（ホスト）
- 戻り値
-
構造化IDの文字列
(7) unpackメソッド
- 機能
-
指定された構造化IDを種別（アンダースコア以外）とURLデコードした名称に分割し，両者を格納したSimtIdUnitオブジェクトを返却するメソッドです。
- 形式
-
unpack(simtId)
- 引数
-
- simtId
-
構造化ID
- 戻り値
-
SimtIdUnitオブジェクト※
- 注※ SimtIdUnitオブジェクトには次に示すプロパティが存在します。
-
-
key：構造化IDの種別（アンダースコア以外）
-
value：構造化IDのURLデコードした名称
-
(8) joinメソッド
- 機能
-
パラメーターに指定された複数の構造化IDを「/（スラッシュ）」で結合し，生成したSIDを返却するメソッドです。
- 形式
-
join(...simtId)
- 引数
-
- simtId
-
構造化ID
- 戻り値
-
SIDの文字列
(9) splitメソッド
- 機能
-
パラメーターに指定されたSIDを「/（スラッシュ）」で分割し，構造化IDを返却するメソッドです。
- 形式
-
split(sid)
- 引数
-
- sid
-
SID
- 戻り値
-
構造化IDの文字列の配列
(10) parseメソッド
- 機能
-
パラメーターに指定されたSIDを構造化IDに分割し，分割した構造化IDをさらに「_（アンダースコア）」を除外した種別とURLデコードした名称に分割します。それらの情報をSimtIdUnitオブジェクトとして格納し，SimtIdUnitオブジェクトを格納した配列を返却するメソッドです。
- 形式
-
parse(sid)
- 引数
-
- sid
-
SID
- 戻り値
-
SimtIdUnitオブジェクト※の配列
- 注※ SimtIdUnitオブジェクトには次に示すプロパティが存在します。
-
-
key：構造化IDの種別（アンダースコア以外）
-
value：構造化IDのURLデコードした名称
-
(11) dataメソッド
- 機能
-
パラメーターに指定されたSIDとvalue値から，SimtDataオブジェクトを生成し，返却するメソッドです。
- 形式
-
data(sid, value)
- 引数
-
- sid
-
SID
- value
-
value値
- 戻り値
-
SID とvalue値の情報をまとめたSimtDataオブジェクト※
- 注※ SimtDataオブジェクトには次に示すプロパティが存在します。
-
-
sid：SIDを示す文字列
-
value：SIDのvalue値を格納するオブジェクト
-