12.2.1 JSON-XML変換API変換定義の設定
JSON-XML変換API変換定義で,JSON-XML変換APIの変換動作を設定することができます。変換動作を設定する場合は,次に示すJsonXmlConverterPropertyクラスを使用します。
JSON-XML変換APIの詳細については,「12.2.3 JSON-XML変換APIの詳細」を参照してください。
- パッケージ
-
jp.co.Hitachi.soft.csc.common.converter.json
- クラス
-
JsonXmlConverterProperty
メソッド名とデフォルト値を次に示します。JSON形式からXML形式に変換する際の変換動作を変更できます。
項番 |
メソッド名 |
デフォルト値 |
説明 |
---|---|---|---|
1 |
setArrayName |
csc-array |
csc-array要素の要素名を変更できます。 |
2 |
setElementName |
csc-element |
csc-element要素の要素名を変更できます。 |
3 |
setSimpleElementName |
csc-simple |
csc-simple要素の要素名を変更できます。 |
4 |
setObjectName |
csc-object |
csc-object要素の要素名を変更できます。 |
5 |
setTypeIncludeEnabled |
false |
JSON形式データの種別を,XML形式データの属性に含めるかどうかを設定できます。 |
各メソッドの詳細を次に示します。(1)〜(5)と表の項番1〜5は対応しています。
- 〈この項の構成〉
(1) csc-array要素の要素名の変更
NCName書式の値で任意の名称を設定できます。配列から始まるJSON形式データをXML形式データに変換する際に使用される,csc-array要素の要素名です。
(2) csc-element要素の要素名の変更
NCName書式の値で任意の名称を設定できます。JSONの配列をXMLに変換する際に使用される,csc-element要素の要素名です。変換後の要素名は,「設定値+アンダーバー(_)+親要素名」となります。
(3) csc-simple要素の要素名の変更
NCName書式の値で任意の名称を設定できます。JSONの配列をXMLに変換する際に使用される,csc-simple要素の要素名です。
(4) csc-object要素の要素名の変更
NCName書式の値で任意の名称を設定できます。オブジェクトから始まるJSON形式データをXML形式データに変換する際に使用される,csc-object要素の要素名です。
(5) JSONのデータ種別をXMLの属性に含めるかどうかの設定
JSONの「文字列型」などのデータ種別を,変換後のXMLの属性に含めるかどうかの設定を変更できます。デフォルトでは,JSONのデータ種別をXMLの属性に含めません。JSONのデータ種別,および変換後のXMLに設定される属性を次の表に示します。
JSONのデータ種別 |
XMLの属性 |
---|---|
オブジェクト |
class="object" |
配列 |
class="array" |
文字列 |
type="string" |
数値 |
type="number" |
boolean |
type="boolean" |
JSONのデータ種別をXMLの属性に含める場合の変換例を,次の図に示します。
- 注
-
下線が付いている属性がJSONのデータ種別です。
- 注※
-
配列値が文字列型,数値型,boolean型の場合,属性はcsc-element要素に設定されます。csc-simple要素には設定されません。