DataFile (Nablarch-API)

java.lang.Object
- nablarch.test.core.file.DataFile

直系の既知のサブクラス:

FixedLengthFile, VariableLengthFile
```
@Published(tag="architect")
public abstract class DataFile
extends java.lang.Object
```
ファイルを表すクラス。

ファイルへ書き出す機能（準備データ作成用）とファイルから読み込む機能（結果ファイル確認用）を持つ。

本インスタンスは複数のDataFileFragmentにより構成される。ファイル全体に関わる情報（ディレクティブなど）は本クラスが保持し、レコードレイアウト毎の情報（レコード長など）はDataFileFragmentが保持する。
ほとんどの機能は本クラスで実装されているが、ファイルタイプにより処理が異なる部分はサブクラスで定義される。

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected java.util.List<DataFileFragment>`	`all` この固定長ファイルを構成する断片
`protected java.util.Map<java.lang.String,java.lang.Object>`	`directives` ディレクティブ一覧

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

コンストラクタ
修飾子コンストラクタと説明

protected DataFile(java.lang.String path)
コンストラクタ。

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`DataFile(java.lang.String path)` コンストラクタ。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected java.lang.Object`	`convertDirectiveValue(DataRecordFormatterSupport.Directive directive, java.lang.String stringValue)` ディレクティブの値を、文字列から各ディレクティブが許容する型に変換する。
`LayoutDefinition`	`createLayout()` フォーマット定義を作成する。
`LayoutDefinition`	`createLayout(DataFileFragment... fragments)` フォーマット定義を作成する。
`protected abstract DataFileFragment`	`createNewFragment()` 新しいファイルの断片を生成する。
`protected java.nio.charset.Charset`	`getEncodingFromDirectives()` ディレクティブからエンコーディングを取得する。
`protected abstract java.lang.String`	`getFileType()` ファイルタイプを取得する。
`DataFileFragment`	`getNewFragment()` この固定長ファイルを構成する、新しい断片を取得する。
`java.lang.String`	`getPath()` ファイルパスを取得する。
`protected void`	`prepareDefaultDirectives(java.lang.String key)` デフォルトのディレクティブを取得する。
`java.util.List<DataRecord>`	`read()` ファイルから読み込む。
`void`	`setDirective(java.lang.String directiveName, java.lang.String stringValue)` ディレクティブを設定する。
`java.util.List<DataRecord>`	`toDataRecords()` `DataRecord`へ変換する。
`protected abstract DataRecordFormatterSupport.Directive`	`valueOf(java.lang.String directiveName)` ディレクティブ名称からディレクティブを取得する。
`void`	`write()` ファイルへ出力する。

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

- フィールドの詳細
  - all
```
protected final java.util.List<DataFileFragment> all
```
    この固定長ファイルを構成する断片
  - directives
```
protected final java.util.Map<java.lang.String,java.lang.Object> directives
```
    ディレクティブ一覧
- コンストラクタの詳細
  - DataFile
```
protected DataFile(java.lang.String path)
```
    コンストラクタ。
    
    パラメータ:
    
    path - ファイルパス
- メソッドの詳細
  - prepareDefaultDirectives
```
protected final void prepareDefaultDirectives(java.lang.String key)
```
    デフォルトのディレクティブを取得する。
    デフォルト値が設定されていない場合は空のMapを返却する（デフォルト値なし）。
    
    パラメータ:
    
    key - コンポーネント設定ファイルのキー
  - getFileType
```
protected abstract java.lang.String getFileType()
```
    ファイルタイプを取得する。
    
    戻り値:
    
    ファイルタイプ
  - write
```
public void write()
```
    ファイルへ出力する。
    出力先はコンストラクタで設定したパスとなる。
  - getNewFragment
```
public DataFileFragment getNewFragment()
```
    この固定長ファイルを構成する、新しい断片を取得する。
    
    戻り値:
    
    DataFileFragment
  - createNewFragment
```
protected abstract DataFileFragment createNewFragment()
```
    新しいファイルの断片を生成する。
    生成された断片はこのファイルの管理下に置かれる。
    
    戻り値:
    
    新しいファイル断片
  - toDataRecords
```
public java.util.List<DataRecord> toDataRecords()
```
    DataRecordへ変換する。
    本メソッドの結果と、read()メソッドの結果を突合することで、期待データと実際のファイルとの比較を行うことができる。
    
    戻り値:
    
    変換結果
  - read
```
public java.util.List<DataRecord> read()
```
    ファイルから読み込む。
    
    読み込み先はコンストラクタで指定したファイルパスとなる。読み込み時に使用されるファイルフォーマットは、本インスタンスが持つDataFileFragmentを使用する。
    
    本インスタンスに対応するデータを読み終えたあとで、入力ストリームが終端に達していない場合、最末尾のレコードレイアウトで残りのストリームを読み切る。
    
    戻り値:
    
    読み込み結果
  - createLayout
```
public LayoutDefinition createLayout()
```
    フォーマット定義を作成する。
    本インスタンスおよび所有するDataFileFragmentのレイアウト情報を元にフォーマット定義を生成する。書き込み時に使用する。（書き込み時はレイアウト種別を明示的に指定できるため、１つのレイアウトでまかなえる）
    
    戻り値:
    
    フォーマット定義
  - createLayout
```
public LayoutDefinition createLayout(DataFileFragment... fragments)
```
    フォーマット定義を作成する。
    本インスタンスおよび所有するDataFileFragmentのレイアウト情報を元にフォーマット定義を生成する。
    
    パラメータ:
    
    fragments - 元となる断片
    
    戻り値:
    
    フォーマット定義
  - setDirective
```
public void setDirective(java.lang.String directiveName,
                         java.lang.String stringValue)
                  throws java.lang.IllegalArgumentException
```
    ディレクティブを設定する。
    
    パラメータ:
    
    directiveName - ディレクティブ名称
    
    stringValue - 値
    
    例外:
    
    java.lang.IllegalArgumentException - 許容されないディレクティブが設定された場合
  - getPath
```
public java.lang.String getPath()
```
    ファイルパスを取得する。
    
    戻り値:
    
    ファイルパス
  - convertDirectiveValue
```
protected java.lang.Object convertDirectiveValue(DataRecordFormatterSupport.Directive directive,
                                                 java.lang.String stringValue)
```
    ディレクティブの値を、文字列から各ディレクティブが許容する型に変換する。
    
    パラメータ:
    
    directive - ディレクティブ
    
    stringValue - 値
    
    戻り値:
    
    変換後の値
  - valueOf
```
protected abstract DataRecordFormatterSupport.Directive valueOf(java.lang.String directiveName)
```
    ディレクティブ名称からディレクティブを取得する。
    
    パラメータ:
    
    directiveName - ディレクティブ名称
    
    戻り値:
    
    ディレクティブ
  - getEncodingFromDirectives
```
protected final java.nio.charset.Charset getEncodingFromDirectives()
```
    ディレクティブからエンコーディングを取得する。
    
    戻り値:
    
    ディレクティブで定義されたエンコーディングF

クラス DataFile

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

all

directives

コンストラクタの詳細

DataFile

メソッドの詳細

prepareDefaultDirectives

getFileType

write

getNewFragment

createNewFragment

toDataRecords

read

createLayout

createLayout

setDirective

getPath

convertDirectiveValue

valueOf

getEncodingFromDirectives