nablarch.fw.reader

クラス ValidatableFileDataReader

java.lang.Object

nablarch.fw.reader.FileDataReader

nablarch.fw.reader.ValidatableFileDataReader

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

DataReader<DataRecord>

public class ValidatableFileDataReader
extends FileDataReader

ファイル内容のバリデーション機能を追加したデータリーダ。

ファイル全件の読み込みを行い、このリーダが提供するValidatableFileDataReader.FileValidatorActionに実装されたバリデーションロジックを setValidatorAction(FileValidatorAction)から設定することができる。 バリデーションが正常終了した場合は、入力ファイルを開きなおして本処理を行う。
また、setUseCache(boolean)にtrueを設定することで、バリデーション時に読み込んだデータを メモリ上にキャッシュし、都度2回の読み込みを1回に削減することができる。
ただし、データ量によってはメモリリソースを大幅に消費する点に注意すること。

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static interface	ValidatableFileDataReader.FileValidatorAction バリデーションを行うオブジェクトが実装するインタフェース。

インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.DataReader

DataReader.NoMoreRecord

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

コンストラクタ

コンストラクタと説明
ValidatableFileDataReader() ValidatableFileDataReaderオブジェクトを生成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	close(ExecutionContext ctx) このリーダの利用を停止し、内部的に保持している各種リソースを解放する。
boolean	hasNext(ExecutionContext ctx) 次に読み込むデータが存在するかどうかを返却する。
protected void	initialize() キャッシュを使用しない場合、ファイルリーダを初期化する。
DataRecord	read(ExecutionContext ctx) データファイルを1レコードづつ読み込む。
ValidatableFileDataReader	setUseCache(boolean useCache) バリデーション時に読み込んだデータをキャッシュし、本処理で使用するかどうかを設定する。
ValidatableFileDataReader	setValidatorAction(ValidatableFileDataReader.FileValidatorAction validatorAction) バリデーション処理を実装したアクションクラスを設定する。
protected void	validate(ExecutionContext ctx) バリデーションを行う。

クラスから継承されたメソッド nablarch.fw.reader.FileDataReader

createFileRecordReader, getFileReader, setBufferSize, setDataFile, setDataFile, setFileReader, setLayoutFile, setLayoutFile

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ValidatableFileDataReader

@Published(tag="architect")
public ValidatableFileDataReader()

ValidatableFileDataReaderオブジェクトを生成する。

メソッドの詳細

read

public DataRecord read(ExecutionContext ctx)

データファイルを1レコードづつ読み込む。

ファイルがバリデーション済みでない場合、バリデーションを行う。
次に読み込むレコードが存在しない場合、nullを返す。

データをキャッシュしている場合、キャッシュからデータを読み込み返却する。
キャッシュしていない場合、データファイルからデータを読み込み返却する。

定義:

read インタフェース内 DataReader<DataRecord>

オーバーライド:

read クラス内 FileDataReader

パラメータ:

ctx - 実行コンテキスト

戻り値:

１レコード分のデータレコード

hasNext

public boolean hasNext(ExecutionContext ctx)

次に読み込むデータが存在するかどうかを返却する。

データをキャッシュしている場合、キャッシュから結果を返却する。
キャッシュしていない場合、データファイルから結果を返却する。

定義:

hasNext インタフェース内 DataReader<DataRecord>

オーバーライド:

hasNext クラス内 FileDataReader

パラメータ:

ctx - 実行コンテキスト

戻り値:

次に読み込むデータが存在する場合は true

close

public void close(ExecutionContext ctx)

このリーダの利用を停止し、内部的に保持している各種リソースを解放する。

キャッシュを有効にしていた場合、キャッシュを削除する。

定義:

close インタフェース内 DataReader<DataRecord>

オーバーライド:

close クラス内 FileDataReader

パラメータ:

ctx - 実行コンテキスト

validate

protected void validate(ExecutionContext ctx)

バリデーションを行う。

キャッシュを有効にしている場合、読み込んだデータをキャッシュする。
無効にしている場合、入力ファイルの再読み込みを行うため、FileDataReaderを初期化する。

パラメータ:

ctx - 実行コンテキスト

例外:

java.lang.IllegalStateException - バリデーション処理を実装したオブジェクトがnullの場合

java.lang.RuntimeException - 実行時例外が発生した場合

java.lang.Error - エラーが発生した場合

initialize

protected void initialize()

キャッシュを使用しない場合、ファイルリーダを初期化する。

setUseCache

@Published(tag="architect")
public ValidatableFileDataReader setUseCache(boolean useCache)

バリデーション時に読み込んだデータをキャッシュし、本処理で使用するかどうかを設定する。

パラメータ:

useCache - キャッシュを有効化する場合はtrue

戻り値:

このオブジェクト自体

setValidatorAction

@Published(tag="architect")
public ValidatableFileDataReader setValidatorAction(ValidatableFileDataReader.FileValidatorAction validatorAction)

バリデーション処理を実装したアクションクラスを設定する。

パラメータ:

validatorAction - バリデーションを実装したアクションクラス

戻り値:

このオブジェクト自体

例外:

java.lang.IllegalArgumentException - バリデーションを実装したアクションクラスがnullの場合