FileRecordWriter (Nablarch-API)

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

すべての実装されたインタフェース:

java.io.Closeable, java.lang.AutoCloseable
```
@Published(tag="architect")
public class FileRecordWriter
extends java.lang.Object
implements java.io.Closeable
```
データレコードをファイルに出力するクラス。
出力形式のフォーマット定義ファイルと出力先ファイルを指定する。明示的に指定しなかった場合のフォーマット定義ファイルの参照ディレクトリは、 "format"論理ベースパスに設定されたパスとなる。同様に、データファイルの出力先は"output"論理ベースパスに設定されたパスとなる。

アプリケーションから、本クラスを直接使用することは許可しない。

本クラスはスレッドセーフな実装にはなっていないので、呼び出し元で同期化の制御を行うこと。

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

コンストラクタ
コンストラクタと説明
`FileRecordWriter(java.io.File dataFile, java.io.File layoutFile)` 書き込むデータファイルのファイル名を指定するコンストラクタ。
`FileRecordWriter(java.io.File dataFile, java.io.File layoutFile, int bufferSize)` 書き込むデータファイルのベースパス論理名およびファイル名を指定するコンストラクタ。
`FileRecordWriter(java.io.File dataFile, LayoutDefinition layoutDefinition)` コンストラクタ。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`close()` 書き込み先のファイルストリームを閉じる。
`protected void`	`createOutputStream()` 出力ストリームを生成する。
`protected java.io.OutputStream`	`createOutputStream(java.io.File dataFile, int bufferSize)` 出力ストリームを生成する。
`protected FileRecordWriter`	`doWrite(DataRecordFormatter formatter, java.lang.String recordType, java.util.Map<java.lang.String,?> record)` レコードタイプを指定してレコードを出力する。
`protected FileRecordWriter`	`doWrite(java.lang.String recordType, java.util.Map<java.lang.String,?> record)` レコードタイプを指定してレコードを出力する。
`protected void`	`initialize()` フォーマット定義を読み込み、出力先ストリームを作成する。
`protected void`	`initialize(DataRecordFormatter formatter)` 初期化処理を行う。
`FileRecordWriter`	`write(java.util.Map<java.lang.String,?> record)` 指定されたレコードデータファイルに出力する。
`FileRecordWriter`	`write(java.lang.String recordType, java.util.Map<java.lang.String,?> record)` レコードタイプを明示的に指定してレコードを出力する。

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

- コンストラクタの詳細
  - FileRecordWriter
```
public FileRecordWriter(java.io.File dataFile,
                        java.io.File layoutFile)
```
    書き込むデータファイルのファイル名を指定するコンストラクタ。 "input"論理ベースパス配下に存在する当該のファイル名のファイルにデータを書き出す。
    
    パラメータ:
    
    dataFile - データファイル
    
    layoutFile - フォーマット定義ファイル
  - FileRecordWriter
```
public FileRecordWriter(java.io.File dataFile,
                        java.io.File layoutFile,
                        int bufferSize)
```
    書き込むデータファイルのベースパス論理名およびファイル名を指定するコンストラクタ。指定されたベースパス配下に存在する当該のファイル名のファイルにデータを書き出す。
    
    パラメータ:
    
    dataFile - データファイル
    
    layoutFile - フォーマット定義ファイル
    
    bufferSize - ファイル読み込みの際に使用するバッファのサイズ
  - FileRecordWriter
```
public FileRecordWriter(java.io.File dataFile,
                        LayoutDefinition layoutDefinition)
```
    コンストラクタ。
    フォーマット定義ファイルを読まずに、LayoutDefinitionを直接指定する。
    
    パラメータ:
    
    dataFile - データファイル
    
    layoutDefinition - フォーマット定義
- メソッドの詳細
  - initialize
```
protected void initialize()
```
    フォーマット定義を読み込み、出力先ストリームを作成する。
  - initialize
```
protected void initialize(DataRecordFormatter formatter)
```
    初期化処理を行う。
    出力ストリームを作成し、フォーマッタに設定する。
    
    パラメータ:
    
    formatter - フォーマッタ
  - write
```
public FileRecordWriter write(java.util.Map<java.lang.String,?> record)
```
    指定されたレコードデータファイルに出力する。本メソッドでは、データファイルのストリームに対して書き込みを行うが、フラッシュは行わず、ストリームも開いたまま維持される。そのため、try-finally句で囲うなどして、書き込み終了後に必ずclose()メソッドを実行する必要がある。なお、本メソッドの処理中に例外が発生した場合、データファイルのストリームは自動的にクローズされる。（クローズメソッドを複数回呼んだとしても特に問題は発生しない。）
    
    パラメータ:
    
    record - ファイルに出力するレコード
    
    戻り値:
    
    このオブジェクト自体
  - write
```
public FileRecordWriter write(java.lang.String recordType,
                              java.util.Map<java.lang.String,?> record)
```
    レコードタイプを明示的に指定してレコードを出力する。
    
    パラメータ:
    
    recordType - 出力するレコードのレコードタイプ
    
    record - 出力するレコード
    
    戻り値:
    
    このオブジェクト自体
  - doWrite
```
protected FileRecordWriter doWrite(java.lang.String recordType,
                                   java.util.Map<java.lang.String,?> record)
```
    レコードタイプを指定してレコードを出力する。
    
    パラメータ:
    
    recordType - 出力するレコードのレコードタイプ
    
    record - 出力するレコード
    
    戻り値:
    
    このオブジェクト自体
  - doWrite
```
protected FileRecordWriter doWrite(DataRecordFormatter formatter,
                                   java.lang.String recordType,
                                   java.util.Map<java.lang.String,?> record)
```
    レコードタイプを指定してレコードを出力する。
    
    パラメータ:
    
    formatter - フォーマッタ
    
    recordType - 出力するレコードのレコードタイプ
    
    record - 出力するレコード
    
    戻り値:
    
    このオブジェクト自体
  - createOutputStream
```
protected void createOutputStream()
```
    出力ストリームを生成する。
  - createOutputStream
```
protected java.io.OutputStream createOutputStream(java.io.File dataFile,
                                                  int bufferSize)
```
    出力ストリームを生成する。
    
    パラメータ:
    
    dataFile - 出力先ファイル
    
    bufferSize - バッファサイズ
    
    戻り値:
    
    出力ストリーム
  - close
```
public void close()
```
    書き込み先のファイルストリームを閉じる。
    
    定義:
    
    close インタフェース内 java.io.Closeable
    
    定義:
    
    close インタフェース内 java.lang.AutoCloseable

クラス FileRecordWriter

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

メソッドのサマリー

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

コンストラクタの詳細

FileRecordWriter

FileRecordWriter

FileRecordWriter

メソッドの詳細

initialize

initialize

write

write

doWrite

doWrite

createOutputStream

createOutputStream

close