nablarch.fw.reader

クラス DatabaseRecordReader

java.lang.Object

nablarch.fw.reader.DatabaseRecordReader

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

DataReader<SqlRow>

public class DatabaseRecordReader
extends java.lang.Object
implements DataReader<SqlRow>

データベースの参照結果を1レコードづつ読み込むデータリーダ。

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

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

DataReader.NoMoreRecord

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	close(ExecutionContext ctx) 内部的にキャッシュしている各種リソースを解放する。
boolean	hasNext(ExecutionContext ctx) 参照結果から次のレコードが存在するかどうかを返却する。
SqlRow	read(ExecutionContext ctx) 参照結果のレコードを1行づつ返却する。
void	reopen(ExecutionContext ctx) ステートメントを再実行し、最新の情報を取得し直す。
DatabaseRecordReader	setListener(DatabaseRecordListener listener) データベースレコードリスナを設定する。
DatabaseRecordReader	setStatement(ParameterizedSqlPStatement parameterizedSqlPStatement, java.lang.Object condition) テーブルを参照するSQLステートメント及び条件を設定する。
DatabaseRecordReader	setStatement(SqlPStatement statement) テーブルを参照するSQLステートメントを設定する。

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

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

コンストラクタの詳細

DatabaseRecordReader

@Published
public DatabaseRecordReader()

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

メソッドの詳細

read

public SqlRow read(ExecutionContext ctx)

参照結果のレコードを1行づつ返却する。

初回読み込み時にデータベースからレコードを取得し、キャッシュする。
レコードはそのキャッシュから返却する。
参照結果に次のレコードが存在しない場合、nullを返す。

定義:

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

パラメータ:

ctx - 実行コンテキスト

戻り値:

レコードデータをキャッシュするオブジェクト

hasNext

public boolean hasNext(ExecutionContext ctx)

参照結果から次のレコードが存在するかどうかを返却する。

初回読み込み時にデータベースからレコードを取得し、キャッシュする。
結果はそのキャッシュから返却する。

定義:

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

パラメータ:

ctx - 実行コンテキスト

戻り値:

次に読み込むレコードが存在する場合 true

close

public void close(ExecutionContext ctx)

内部的にキャッシュしている各種リソースを解放する。

この実装では、レコードの読み込みに使用したステートメントオブジェクトが nullでない場合、解放する。

定義:

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

パラメータ:

ctx - 実行コンテキスト

reopen

public void reopen(ExecutionContext ctx)

ステートメントを再実行し、最新の情報を取得し直す。

取得した参照結果をキャッシュする。

パラメータ:

ctx - 実行コンテキスト

setStatement

@Published
public DatabaseRecordReader setStatement(SqlPStatement statement)

テーブルを参照するSQLステートメントを設定する。

パラメータ:

statement - SQLステートメント

戻り値:

このオブジェクト自体

setStatement

@Published
public DatabaseRecordReader setStatement(ParameterizedSqlPStatement parameterizedSqlPStatement,
                                                    java.lang.Object condition)

テーブルを参照するSQLステートメント及び条件を設定する。

パラメータ:

parameterizedSqlPStatement - SQLステートメント

condition - ステートメントのINパラメータに設定する値を持つオブジェクト

戻り値:

このオブジェクト自体

setListener

@Published
public DatabaseRecordReader setListener(DatabaseRecordListener listener)

データベースレコードリスナを設定する。

リスナに定義されたコールバック処理は、 処理対象レコードをキャッシュするためのデータベースアクセス前に実行される。

本リーダにリスナを設定することで、 処理対象レコードをデータベースから取得する前に任意の処理を実行することができる。

パラメータ:

listener - データベースレコードリスナ

戻り値:

このオブジェクト自体