FileRecordReader (Nablarch-API)

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

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

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

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

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

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

コンストラクタ
コンストラクタと説明
`FileRecordReader(java.io.File dataFile, java.io.File layoutFile)` コンストラクタ。
`FileRecordReader(java.io.File dataFile, java.io.File layoutFile, int bufferSize)` コンストラクタ。
`FileRecordReader(java.io.File dataFile, LayoutDefinition layoutDefinition)` コンストラクタ。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`close()` 指定されたデータファイルに対するストリームを閉じ、ファイルハンドラを開放する。
`protected void`	`createInputStream()` 入力ストリームを生成する。
`int`	`getRecordNumber()` 読み込み中のレコードのレコード番号を返却する。
`boolean`	`hasNext()` 次に読み込むレコードがあるかどうかを返却する。
`protected FileRecordReader`	`initialize()` 初期化処理を行う。
`protected FileRecordReader`	`initialize(DataRecordFormatter formatter)` 初期化を行う。
`DataRecord`	`read()` 指定されたデータファイルから次のレコードを読み込んで返す。
`protected DataRecord`	`readRecord()` レコードを1行読み込み、結果を返却する。

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

- コンストラクタの詳細
  - FileRecordReader
```
public FileRecordReader(java.io.File dataFile,
                        java.io.File layoutFile)
```
    コンストラクタ。
    
    パラメータ:
    
    dataFile - データファイル
    
    layoutFile - フォーマット定義ファイル
  - FileRecordReader
```
public FileRecordReader(java.io.File dataFile,
                        java.io.File layoutFile,
                        int bufferSize)
```
    コンストラクタ。
    
    パラメータ:
    
    dataFile - データファイル
    
    layoutFile - フォーマット定義ファイル
    
    bufferSize - ファイル読み込みの際に使用するバッファのサイズ
  - FileRecordReader
```
public FileRecordReader(java.io.File dataFile,
                        LayoutDefinition layoutDefinition)
```
    コンストラクタ。
    
    パラメータ:
    
    dataFile - データファイル
    
    layoutDefinition - フォーマット定義情報保持クラス
- メソッドの詳細
  - initialize
```
protected FileRecordReader initialize()
```
    初期化処理を行う。
    
    戻り値:
    
    このオブジェクト自体
  - initialize
```
protected FileRecordReader initialize(DataRecordFormatter formatter)
```
    初期化を行う。
    
    パラメータ:
    
    formatter - フォーマッタ
    
    戻り値:
    
    このオブジェクト自体
  - createInputStream
```
protected void createInputStream()
```
    入力ストリームを生成する。
  - read
```
public DataRecord read()
```
    指定されたデータファイルから次のレコードを読み込んで返す。
    
    戻り値:
    
    データレコード
  - hasNext
```
public boolean hasNext()
```
    次に読み込むレコードがあるかどうかを返却する。
    
    戻り値:
    
    次に読み込むレコードがある場合、true
  - readRecord
```
protected DataRecord readRecord()
```
    レコードを1行読み込み、結果を返却する。
    
    戻り値:
    
    読み込んだ結果が格納されるデータレコード
  - close
```
public void close()
```
    指定されたデータファイルに対するストリームを閉じ、ファイルハンドラを開放する。
    
    定義:
    
    close インタフェース内 java.io.Closeable
    
    定義:
    
    close インタフェース内 java.lang.AutoCloseable
  - getRecordNumber
```
public int getRecordNumber()
```
    読み込み中のレコードのレコード番号を返却する。
    
    戻り値:
    
    レコード番号

クラス FileRecordReader

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

メソッドのサマリー

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

コンストラクタの詳細

FileRecordReader

FileRecordReader

FileRecordReader

メソッドの詳細

initialize

initialize

createInputStream

read

hasNext

readRecord

close

getRecordNumber