7.4.2.3.1.1. フォーマット定義ファイルの記述ルール¶

7.4.2.3.1.1.1.1. 文字コード¶

フォーマット定義ファイルの文字コードは UTF-8 となる。

7.4.2.3.1.1.1.2. リテラル表記¶

設定値にリテラルを記述する場合は、以下のルールに準拠すること。

7.4.2.3.1.1.1.3. コメント¶

行中の # 以降をコメントとして扱う。

以下に例を示す。

#
# サンプルファイル
#
file-type:     "Fixed"  # 固定長
text-encoding: "ms932"  # 文字コードはms932
record-length:  120     # 各業の長さは120バイト

7.4.2.3.1.1.3.1. 共通で使用可能なディレクティブ一覧¶

全てのデータ形式で使用するディレクティブ定義は以下のとおり。

7.4.2.3.1.1.3.2. Fixed(固定長)形式で指定可能なディレクティブ一覧¶

Fixed(固定長)形式のデータで使用するディレクティブは以下のとおり。

以下に例を示す。

#
# ディレクティブ定義部
#
file-type:                      "Fixed"  # 固定長ファイル
text-encoding:                  "ms932"  # 文字列型フィールドの文字エンコーディング
record-length:                  120      # 各レコードbyte長
positive-zone-sign-nibble:      "C"      # ゾーン数値の正符号
negative-zone-sign-nibble:      "D"      # ゾーン数値の負符号
positive-pack-sign-nibble:      "C"      # パック数値の正符号
negative-pack-sign-nibbleL      "D"      # パック数値の負符号
required-decimal-point:         true     # 小数点あり
fixed-sign-position:            true     # 符号は先頭に
required-plus-sign:             false    # 正符号は付加しない

7.4.2.3.1.1.3.3. Variable(可変長)形式で指定可能なディレクティブ一覧¶

Variable(可変長)形式のデータで使用するディレクティブは以下のとおり。

以下に例を示す。

#
# ディレクティブ定義部
#
file-type:                  "Variable"  # 可変長ファイル
text-encoding:              "utf-8"     # 文字列型フィールドの文字エンコーディング
record-separator:           "\\r\\n"    # 改行

field-separator:            ","         # CSV
quoting-delimiter:          "\""        # ダブルクォートで項目を囲む
ignore-blank-lines:         true        # 空行は無視
requires-title:             false       # タイトルレコードは無し
max-record-length:          1000        # このcsvのレコードには最大でも1000文字まで

7.4.2.3.1.1.3.4. JSON形式で指定可能なディレクティブ一覧¶

JSONデータ形式固有のディレクティブは存在しない。

以下に例を示す。

file-type:      "JSON"      # jsonフォーマット
text-encoding:  "utf-8"     # 文字列型フィールドの文字エンコーディング

7.4.2.3.1.1.3.5. XML形式で指定可能なディレクティブ一覧¶

XMLデータ形式固有のディレクティブは存在いない。

以下に例を示す。

file-type:      "XML"       # xmlフォーマット
text-encoding:  "utf-8"     # 文字列型フィールドの文字エンコーディング

7.4.2.3.1.1.4.1. フィールド定義¶

フィールド定義は、以下の形式で定義する。

<フィールド開始位置> <フィールド名> <多重度> <フィールドタイプ> <フィールドコンバータ>

フィールド定義の各要素の詳細は以下のとおり。

[tagName]
@attr

<tagName attr="val">
・・・
</tagName>

address [1..3]    # 1から3の定義が可能
address           # 省略しているので1つだけ可能
address [0..*]    # 条件なし(0から無制限)
address [*]       # 条件なし(0から無制限)
address [1..*]    # 1以上

<person>
  <address>自宅住所</address>
  <address>勤務先住所</address>
</person>

{
  "address" : ["自宅住所", "勤務先住所", "送付先住所"]
}

7.4.2.3.1.1.4.2. マルチフォーマット形式のレコードを定義する¶

マルチフォーマット形式のデータの場合は、フォーマット定義ファイル上に複数のレコードフォーマットを定義する。

入出力データが、どのレコードフォーマットかは、特定のフィールドの値によって自動的に判定される。 もし、入出力対象のデータが、どのレコードタイプにもマッチしない場合は、不正データ扱いとし処理を異常終了する。

以下にマルチフォーマット形式のフォーマット定義例を示す。

ポイント

• レコード識別フィールドを定義する。レコードタイプ名は Classifier とする。
• 各レコード定義のレコードタイプ名直下に、レコードと判断するための条件を定義する。
• レコード識別(Classifier)に定義したフィールドは、レコード定義内に存在している必要がある。

file-type:        "Fixed" # 固定長
text-encoding:    "MS932" # 文字列型フィールドの文字エンコーディング
record-length:    40      # 各レコードの長さ
record-separator: "\r\n"  # 改行コード(crlf)

# レコード識別条件の定義
[Classifier]
1 dataKbn X(1)      # 先頭1バイトのフィールドを使用してどのレコードかを判定する

# ヘッダレコードの定義
[header]
dataKbn = "1"         # dataKbnが"1"の場合ヘッダレコード
1 dataKbn X(1)
2 data    X(39)

# データレコードの定義
[data]
dataKbn = "2"        # dataKbnが"2"の場合データレコード
1 dataKbn X(1)
2 data    X(39)

マルチフォーマットの定義サンプルは、以下のリンク先を参照。

7.4.2.3.1.1.4.3. フィールドタイプ一覧¶

標準で提供するデータタイプ定義一覧を以下に示す。

Fixed(固定長)データ形式で使用可能なフィールドタイプ一覧

タイプ	Java型	説明
X	String	シングルバイト文字列(バイト長 = 文字列長) デフォルトでは、半角空白による右トリム及びパディングが行われる。 引数: バイト長(数値) 必須 出力対象の値が null の場合、値を空文字に変換してから処理を行う。 読み込んだ値が空文字列の場合は、 null に変換する。 空文字列を null に変換したくない場合は、 convertEmptyToNull に false を設定する。
N	String	ダブルバイト文字列 (バイト長 = 文字数 ÷ 2) デフォルトでは、全角空白による右トリム・パディングを行う。 引数: バイト長(数値) 必須 ※バイト長が2の倍数でない場合は構文エラーとなる。 出力対象の値が null の場合や、読み込んだ値が空文字列の場合の扱いは、 シングルバイト文字列のフィールドタイプ と同じ。
XN	String	マルチバイト文字列 UTF-8のようにバイト長の異なる文字が混在するフィールドを扱う場合に、このフィールドタイプを指定する。 また、全角文字列（ダブルバイト文字列）のパディングに半角スペースを使用する場合にも本フィールドタイプを使用する。 デフォルトでは、半角空白による右トリム・パディングを行う。 引数: バイト長(数値) 必須 出力対象の値が null の場合や、読み込んだ値が空文字列の場合の扱いは、 シングルバイト文字列のフィールドタイプ と同じ。
Z	BigDecimal	ゾーン数値(バイト長 = 桁数) デフォルトでは、 0 による左トリム・パディングを行う。 引数1: バイト長(数値) 必須 引数2: 小数点以下桁数(数値) 任意 デフォルト: 0 出力対象の値が null の場合、値を 0 に変換してから処理を行う。 読み込んだ値のバイト数が 0 の場合は、 null に変換する。 バイト数が 0 の場合に null に変換したくない場合は、 convertEmptyToNull に false を設定する。
SZ	BigDecimal	符号付きゾーン数値 (バイト長 = 桁数) デフォルトでは、 0 による左トリム・パディングを行う。 引数1: バイト長(数値) 必須 引数2: 少数点以下桁数(数値) 任意 デフォルト: 0 引数3: ゾーン部に設定する正符号(16進表記の文字列) 任意 引数4: ゾーン部に設定する負符号(16進表記の文字列) 任意 引数3及び引数4は、 符号付きゾーン数値の正符号 及び 符号付きゾーン数値の負符号 を上書きする場合に設定する。 出力対象の値が null の場合や、読み込んだ値のバイト数が 0 の場合の扱いは、 ゾーン数値のフィールドタイプ と同じ。
P	BigDecimal	パック数値 (バイト長 = 桁数 ÷ 2 [端数切り上げ]) デフォルトでは、 0 による左トリム・パディングを行う。 引数1: バイト長(数値) 必須 引数2: 少数点以下桁数(数値) 任意 デフォルト: 0 出力対象の値が null の場合や、読み込んだ値のバイト数が 0 の場合の扱いは、 ゾーン数値のフィールドタイプ と同じ。
SP	BigDecimal	符号付きパック数値 (バイト長 = (桁数 + 1) ÷ 2 [端数切り上げ]) デフォルトでは、 0 による左トリム・パディングを行う。 引数1: バイト長(数値) 必須 引数2: 少数点以下桁数(数値) 任意 デフォルト: 0 引数3: 符号ビットに設定する正符号 (16進表記の文字列) 任意 引数4: 符号ビットに設定する負符号 (16進表記の文字列) 任意 引数3及び引数4は、 符号付きパック数値の正符号 及び 符号付きパック数値の負符号 を上書きする場合に設定する。 出力対象の値が null の場合や、読み込んだ値のバイト数が 0 の場合の扱いは、 ゾーン数値のフィールドタイプ と同じ。
B	byte[]	バイナリ列 パディングやトリムは行わない。 引数: バイト長(数値) 必須 出力対象の値が null の場合の変換仕様はアプリケーションごとに様々である。 そのため、本フィールドタイプではその場合でも値の変換は行わず、 InvalidDataFormatException を送出する。 本フィールドタイプを使用する場合、要件に合わせてアプリケーション側で明示的に値を設定すること。
X9	BigDecimal	符号無し数値文字列 (バイト長 = 文字数) フィールド中のシングルバイト文字列(X)を数値として扱う。 デフォルトでは、 0 による左トリム・パディングを行う。 文字列中に小数点記号( . )を含めることできる。 引数1: バイト長(数値) 必須 引数2: 固定小数点の場合の小数点以下桁数(数値) 任意 デフォルト: 0 出力対象の値が null の場合の扱いは、 ゾーン数値のフィールドタイプ と同じ。 読み込んだ値が空文字列の場合の扱いは、 シングルバイト文字列のフィールドタイプ と同じ。
SX9	BigDecimal	符号付き数値文字列 (バイト長 = 文字数) フィールド中のシングルバイト文字列(X)を符号付き数値として扱う。 デフォルトでは、 0 による左トリム・パディングを行う。 引数1: バイト長(数値) 必須 引数2: 固定小数点の場合の小数点以下桁数(数値) 任意 デフォルト: 0 出力対象の値が null の場合の扱いは、 ゾーン数値のフィールドタイプ と同じ。 読み込んだ値が空文字列の場合の扱いは、 シングルバイト文字列のフィールドタイプ と同じ。 符号文字(+ 、-)を変更したい場合は、以下のクラスの実装を参考にプロジェクト固有のフィールドタイプを作成して対応する。 SignedNumberStringDecimal フィールドタイプの追加については、 フィールドタイプを追加する を参照。

Variable(可変長)データ形式で使用可能なフィールドタイプ一覧

タイプ	Java型	説明
X N XN X9 SX9	String	可変長データ形式では、すべてのフィールドを文字列（String）として読み書きする。 どのタイプ識別子を指定しても動作は変わらない。 また、フィールド長の概念が無いので、引数は不要である。 もし、文字列を数値形式(BigDecimal)として読み書きしたい場合は、 numberコンバータ または signed_numberコンバータ を使用すること。 出力対象の値が null の場合、値を空文字に変換してから処理を行う。 読み込んだ値が空文字列の場合は、 null に変換する。 空文字列を null に変換したくない場合は、 convertEmptyToNull に false を設定する。

JSONおよびXMLデータ形式で使用可能なフィールドタイプ一覧

タイプ	Java型	説明
X N XN	String	文字列データタイプ パディングなどの編集は行わない。 JSONの場合は、出力時に値がダブルクォート " で括られる。 出力対象の値が null の場合、JSONでは値の変換は行わなず、 XMLでは空文字に変換する。
X9 SX9	String	数値文字列タイプ パディングなどのデータ編集は行わない。出力時は値がそのまま出力される。 もし、文字列を数値形式(BigDecimal)として読み書きしたい場合は、 numberコンバータ または signed_numberコンバータ 使用すること。 出力対象の値が null の場合の扱いは、 文字列データタイプのフィールドタイプ と同じ。
BL	String	文字列（ true or false を文字列で表したもの） パディングなどのデータ編集は行わない。出力時は値がそのまま出力される。 出力対象の値が null の場合の扱いは、 文字列データタイプのフィールドタイプ と同じ。
OB	-	ネストされたレコードタイプを指定する場合に使用する。 フィールド名に対応した、レコードタイプがネストした要素として入出力される。 出力対象の値が null の場合の扱いは、 文字列データタイプのフィールドタイプ と同じ。 以下に使用例を示す。 json { "users": [ { "name" : "名前", "age" : 30, "address" : "住所" }, { "name" : "名前1", "age" : 31, "address" : "住所1" } ] } xml <users> <user> <name>名前</name> <age>30</age> <address>住所</address> </user> <user> <name>名前1</name> <age>31</age> <address>住所1</address> </user> </users> 上記のjson及びxmlに対応したフォーマット定義ファイルは以下のとおり。 [users] # ルート要素 1 user [1..*] OB [user] # ネストした要素 1 name N # 最下層の要素 2 age X9 3 address N

7.4.2.3.1.1.4.4. フィールドコンバータ一覧¶

標準で提供するデータコンバータ一覧を以下に示す。