Package nablarch.core.dataformat
Class FieldDefinition
java.lang.Object
nablarch.core.dataformat.FieldDefinition
フォーマット定義ファイル内の、レコード内の各フィールドの定義情報を保持するクラス。
フォーマット定義ファイルのパース結果として生成される。
各フィールド定義に関連するコンバータは、パース後に
DataRecordFormatter
が本クラスに設定する。-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddConvertor
(ValueConvertor<?, ?> convertor) コンバータを追加する。 nullが渡された場合は何もしない。addConvertorSetting
(String convertor, Object[] convertorArgs) フォーマット定義ファイルで指定されたコンバータの定義を追加する。コンバータのリストを取得する。フォーマット定義ファイルで指定されたコンバータの定義を取得する。DataType<?,
?> フォーマット定義ファイルで指定されたデータタイプ名に対応するデータタイプを取得する。フィールドの文字エンコーディングを返却する。int
フィールドの最大配列要素数を返却する。int
フィールドの最小配列要素数を返却する。getName()
フィールド名称を返却する。フィールドのパディング/トリムに使用する値を返却する。int
このフィールドの開始位置を返却する。int
getSize()
このフィールドの長さを返却する。boolean
isArray()
このフィールドが配列項目であればtrueを返却する。boolean
このフィールドが属性項目であればtrueを返却する。boolean
isFiller()
このフィールドがFILLER項目であればtrueを返却する。boolean
このフィールドが必須項目であればtrueを返却する。このフィールドが配列項目に設定する。このフィールドが属性項目に設定する。このフィールドがFILLER項目に設定する。このフィールドが任意項目に設定する。setDataType
(DataType<?, ?> dataType) フォーマット定義ファイルで指定されたデータタイプ名に対応するデータタイプを設定する。setEncoding
(Charset encoding) フィールドの文字エンコーディングを設定する。setMaxArraySize
(int maxArraySize) フィールドの最大配列要素数を設定する。setMinArraySize
(int minArraySize) フィールドの最小配列要素数を設定する。フィールド名称を設定する。setPaddingValue
(Object value) フィールドのパディング/トリムに使用する値を設定する。setPosition
(int position) このフィールドの開始位置を設定する。
-
Constructor Details
-
FieldDefinition
public FieldDefinition()
-
-
Method Details
-
addConvertorSetting
フォーマット定義ファイルで指定されたコンバータの定義を追加する。- Parameters:
convertor
- コンバータ名convertorArgs
- 引数- Returns:
- このオブジェクト自体
-
getConvertorSettingList
フォーマット定義ファイルで指定されたコンバータの定義を取得する。- Returns:
- フォーマット定義ファイルで指定されたコンバータ
-
getName
フィールド名称を返却する。- Returns:
- フィールド名
-
setName
フィールド名称を設定する。- Parameters:
name
- フィールド名称- Returns:
- このオブジェクト自体
-
getEncoding
フィールドの文字エンコーディングを返却する。- Returns:
- フィールドの文字エンコーディング
-
setEncoding
フィールドの文字エンコーディングを設定する。- Parameters:
encoding
- フィールドの文字エンコーディング- Returns:
- このオブジェクト自体
-
getPaddingValue
フィールドのパディング/トリムに使用する値を返却する。- Returns:
- フィールドのパディング/トリムに使用する値
-
setPaddingValue
フィールドのパディング/トリムに使用する値を設定する。- Parameters:
value
- フィールドのパディング/トリムに使用する値- Returns:
- このオブジェクト自体
-
isFiller
public boolean isFiller()このフィールドがFILLER項目であればtrueを返却する。- Returns:
- FILLER項目であればtrue
-
markAsFiller
このフィールドがFILLER項目に設定する。- Returns:
- このオブジェクト自体
-
isRequired
public boolean isRequired()このフィールドが必須項目であればtrueを返却する。- Returns:
- 必須項目であればtrue
-
markAsNotRequired
このフィールドが任意項目に設定する。- Returns:
- このオブジェクト自体
-
isAttribute
public boolean isAttribute()このフィールドが属性項目であればtrueを返却する。- Returns:
- 属性項目であればtrue
-
markAsAttribute
このフィールドが属性項目に設定する。- Returns:
- このオブジェクト自体
-
isArray
public boolean isArray()このフィールドが配列項目であればtrueを返却する。- Returns:
- 配列項目であればtrue
-
markAsArray
このフィールドが配列項目に設定する。- Returns:
- このオブジェクト自体
-
getMinArraySize
public int getMinArraySize()フィールドの最小配列要素数を返却する。- Returns:
- フィールドの最小配列要素数
-
setMinArraySize
フィールドの最小配列要素数を設定する。- Parameters:
minArraySize
- フィールドの最小配列要素数- Returns:
- このオブジェクト自体
-
getMaxArraySize
public int getMaxArraySize()フィールドの最大配列要素数を返却する。- Returns:
- フィールドの最大配列要素数
-
setMaxArraySize
フィールドの最大配列要素数を設定する。- Parameters:
maxArraySize
- フィールドの最大配列要素数- Returns:
- このオブジェクト自体
-
setPosition
このフィールドの開始位置を設定する。- Parameters:
position
- 開始位置- Returns:
- このオブジェクト自体
-
getPosition
public int getPosition()このフィールドの開始位置を返却する。- Returns:
- 開始位置
-
getSize
public int getSize()このフィールドの長さを返却する。バイナリモード:バイト長 キャラクタモード:1
- Returns:
- フィールドの長さ
-
addConvertor
コンバータを追加する。 nullが渡された場合は何もしない。- Parameters:
convertor
- 追加するコンバータ- Returns:
- このオブジェクト自体
-
getConvertors
コンバータのリストを取得する。- Returns:
- コンバータのリスト
-
setDataType
フォーマット定義ファイルで指定されたデータタイプ名に対応するデータタイプを設定する。- Parameters:
dataType
- データタイプ名- Returns:
- このオブジェクト自体
-
getDataType
フォーマット定義ファイルで指定されたデータタイプ名に対応するデータタイプを取得する。- Returns:
- データタイプ
-