FieldDefinition (Nablarch-API)

java.lang.Object
- nablarch.core.dataformat.FieldDefinition

```
@Published(tag="architect")
public class FieldDefinition
extends java.lang.Object
```
フォーマット定義ファイル内の、レコード内の各フィールドの定義情報を保持するクラス。フォーマット定義ファイルのパース結果として生成される。各フィールド定義に関連するコンバータは、パース後にDataRecordFormatterが本クラスに設定する。

関連項目:

LayoutDefinition, RecordDefinition, DataRecordFormatter

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

FieldDefinition()

コンストラクタ
コンストラクタと説明
`FieldDefinition()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`FieldDefinition`	`addConvertor(ValueConvertor<?,?> convertor)` コンバータを追加する。
`FieldDefinition`	`addConvertorSetting(java.lang.String convertor, java.lang.Object[] convertorArgs)` フォーマット定義ファイルで指定されたコンバータの定義を追加する。
`java.util.List<ValueConvertor>`	`getConvertors()` コンバータのリストを取得する。
`java.util.Map<java.lang.String,java.lang.Object[]>`	`getConvertorSettingList()` フォーマット定義ファイルで指定されたコンバータの定義を取得する。
`DataType<?,?>`	`getDataType()` フォーマット定義ファイルで指定されたデータタイプ名に対応するデータタイプを取得する。
`java.nio.charset.Charset`	`getEncoding()` フィールドの文字エンコーディングを返却する。
`int`	`getMaxArraySize()` フィールドの最大配列要素数を返却する。
`int`	`getMinArraySize()` フィールドの最小配列要素数を返却する。
`java.lang.String`	`getName()` フィールド名称を返却する。
`java.lang.Object`	`getPaddingValue()` フィールドのパディング/トリムに使用する値を返却する。
`int`	`getPosition()` このフィールドの開始位置を返却する。
`int`	`getSize()` このフィールドの長さを返却する。
`boolean`	`isArray()` このフィールドが配列項目であればtrueを返却する。
`boolean`	`isAttribute()` このフィールドが属性項目であればtrueを返却する。
`boolean`	`isFiller()` このフィールドがFILLER項目であればtrueを返却する。
`boolean`	`isRequired()` このフィールドが必須項目であればtrueを返却する。
`FieldDefinition`	`markAsArray()` このフィールドが配列項目に設定する。
`FieldDefinition`	`markAsAttribute()` このフィールドが属性項目に設定する。
`FieldDefinition`	`markAsFiller()` このフィールドがFILLER項目に設定する。
`FieldDefinition`	`markAsNotRequired()` このフィールドが任意項目に設定する。
`FieldDefinition`	`setDataType(DataType<?,?> dataType)` フォーマット定義ファイルで指定されたデータタイプ名に対応するデータタイプを設定する。
`FieldDefinition`	`setEncoding(java.nio.charset.Charset encoding)` フィールドの文字エンコーディングを設定する。
`FieldDefinition`	`setMaxArraySize(int maxArraySize)` フィールドの最大配列要素数を設定する。
`FieldDefinition`	`setMinArraySize(int minArraySize)` フィールドの最小配列要素数を設定する。
`FieldDefinition`	`setName(java.lang.String name)` フィールド名称を設定する。
`FieldDefinition`	`setPaddingValue(java.lang.Object value)` フィールドのパディング/トリムに使用する値を設定する。
`FieldDefinition`	`setPosition(int position)` このフィールドの開始位置を設定する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - FieldDefinition
```
public FieldDefinition()
```
- メソッドの詳細
  - addConvertorSetting
```
public FieldDefinition addConvertorSetting(java.lang.String convertor,
                                           java.lang.Object[] convertorArgs)
```
    フォーマット定義ファイルで指定されたコンバータの定義を追加する。
    
    パラメータ:
    
    convertor - コンバータ名
    
    convertorArgs - 引数
    
    戻り値:
    
    このオブジェクト自体
  - getConvertorSettingList
```
public java.util.Map<java.lang.String,java.lang.Object[]> getConvertorSettingList()
```
    フォーマット定義ファイルで指定されたコンバータの定義を取得する。
    
    戻り値:
    
    フォーマット定義ファイルで指定されたコンバータ
  - getName
```
public java.lang.String getName()
```
    フィールド名称を返却する。
    
    戻り値:
    
    フィールド名
  - setName
```
public FieldDefinition setName(java.lang.String name)
```
    フィールド名称を設定する。
    
    パラメータ:
    
    name - フィールド名称
    
    戻り値:
    
    このオブジェクト自体
  - getEncoding
```
public java.nio.charset.Charset getEncoding()
```
    フィールドの文字エンコーディングを返却する。
    
    戻り値:
    
    フィールドの文字エンコーディング
  - setEncoding
```
public FieldDefinition setEncoding(java.nio.charset.Charset encoding)
```
    フィールドの文字エンコーディングを設定する。
    
    パラメータ:
    
    encoding - フィールドの文字エンコーディング
    
    戻り値:
    
    このオブジェクト自体
  - getPaddingValue
```
public java.lang.Object getPaddingValue()
```
    フィールドのパディング/トリムに使用する値を返却する。
    
    戻り値:
    
    フィールドのパディング/トリムに使用する値
  - setPaddingValue
```
public FieldDefinition setPaddingValue(java.lang.Object value)
```
    フィールドのパディング/トリムに使用する値を設定する。
    
    パラメータ:
    
    value - フィールドのパディング/トリムに使用する値
    
    戻り値:
    
    このオブジェクト自体
  - isFiller
```
public boolean isFiller()
```
    このフィールドがFILLER項目であればtrueを返却する。
    
    戻り値:
    
    FILLER項目であればtrue
  - markAsFiller
```
public FieldDefinition markAsFiller()
```
    このフィールドがFILLER項目に設定する。
    
    戻り値:
    
    このオブジェクト自体
  - isRequired
```
public boolean isRequired()
```
    このフィールドが必須項目であればtrueを返却する。
    
    戻り値:
    
    必須項目であればtrue
  - markAsNotRequired
```
public FieldDefinition markAsNotRequired()
```
    このフィールドが任意項目に設定する。
    
    戻り値:
    
    このオブジェクト自体
  - isAttribute
```
public boolean isAttribute()
```
    このフィールドが属性項目であればtrueを返却する。
    
    戻り値:
    
    属性項目であればtrue
  - markAsAttribute
```
public FieldDefinition markAsAttribute()
```
    このフィールドが属性項目に設定する。
    
    戻り値:
    
    このオブジェクト自体
  - isArray
```
public boolean isArray()
```
    このフィールドが配列項目であればtrueを返却する。
    
    戻り値:
    
    配列項目であればtrue
  - markAsArray
```
public FieldDefinition markAsArray()
```
    このフィールドが配列項目に設定する。
    
    戻り値:
    
    このオブジェクト自体
  - getMinArraySize
```
public int getMinArraySize()
```
    フィールドの最小配列要素数を返却する。
    
    戻り値:
    
    フィールドの最小配列要素数
  - setMinArraySize
```
public FieldDefinition setMinArraySize(int minArraySize)
```
    フィールドの最小配列要素数を設定する。
    
    パラメータ:
    
    minArraySize - フィールドの最小配列要素数
    
    戻り値:
    
    このオブジェクト自体
  - getMaxArraySize
```
public int getMaxArraySize()
```
    フィールドの最大配列要素数を返却する。
    
    戻り値:
    
    フィールドの最大配列要素数
  - setMaxArraySize
```
public FieldDefinition setMaxArraySize(int maxArraySize)
```
    フィールドの最大配列要素数を設定する。
    
    パラメータ:
    
    maxArraySize - フィールドの最大配列要素数
    
    戻り値:
    
    このオブジェクト自体
  - setPosition
```
public FieldDefinition setPosition(int position)
```
    このフィールドの開始位置を設定する。
    
    パラメータ:
    
    position - 開始位置
    
    戻り値:
    
    このオブジェクト自体
  - getPosition
```
public int getPosition()
```
    このフィールドの開始位置を返却する。
    
    戻り値:
    
    開始位置
  - getSize
```
public int getSize()
```
    このフィールドの長さを返却する。
```
 バイナリモード：バイト長
 キャラクタモード：1
 
```
    戻り値:
    
    フィールドの長さ
  - addConvertor
```
public FieldDefinition addConvertor(ValueConvertor<?,?> convertor)
```
    コンバータを追加する。 nullが渡された場合は何もしない。
    
    パラメータ:
    
    convertor - 追加するコンバータ
    
    戻り値:
    
    このオブジェクト自体
  - getConvertors
```
public java.util.List<ValueConvertor> getConvertors()
```
    コンバータのリストを取得する。
    
    戻り値:
    
    コンバータのリスト
  - setDataType
```
public FieldDefinition setDataType(DataType<?,?> dataType)
```
    フォーマット定義ファイルで指定されたデータタイプ名に対応するデータタイプを設定する。
    
    パラメータ:
    
    dataType - データタイプ名
    
    戻り値:
    
    このオブジェクト自体
  - getDataType
```
public DataType<?,?> getDataType()
```
    フォーマット定義ファイルで指定されたデータタイプ名に対応するデータタイプを取得する。
    
    戻り値:
    
    データタイプ

クラス FieldDefinition

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

FieldDefinition

メソッドの詳細

addConvertorSetting

getConvertorSettingList

getName

setName

getEncoding

setEncoding

getPaddingValue

setPaddingValue

isFiller

markAsFiller

isRequired

markAsNotRequired

isAttribute

markAsAttribute

isArray

markAsArray

getMinArraySize

setMinArraySize

getMaxArraySize

setMaxArraySize

setPosition

getPosition

getSize

addConvertor

getConvertors

setDataType

getDataType