Package nablarch.fw

Interface DataReader<TData>

Type Parameters:
TData - このクラスが読み込んだデータの型
All Known Implementing Classes:
DatabaseRecordReader, DatabaseTableQueueReader, FileDataReader, FwHeaderReader, MessageReader, ResumeDataReader, ValidatableFileDataReader
@Published(tag="architect") public interface DataReader<TData>
Handlerが処理する入力データを外部から読み込むインタフェース。

データリーダは複数のリクエストスレッドから並行アクセスされ得るので、 各メソッドはスレッドセーフに実装されなければならない。

Author:
Iwauo Tajima <iwauo@tis.co.jp>

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    DataReader.NoMoreRecord
    これ以上読み取るデータが無いことを示す例外。

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close(ExecutionContext ctx)
    このリーダの利用を停止し、内部的に保持している各種リソースを解放する。
    boolean
    hasNext(ExecutionContext ctx)
    次に読み込むデータが存在するかどうかを返却する。
    TData
    read(ExecutionContext ctx)
    Handlerが処理する入力データを読み込んで返却する。

  • Method Details

    • read

      TData read(ExecutionContext ctx)
      Handlerが処理する入力データを読み込んで返却する。

      入力データがこれ以上存在しない状態、 すなわち、hasNext()の結果がfalseとなる場合はnullを返すこと。

      Parameters:
      ctx - 実行コンテキスト
      Returns:
      入力データオブジェクト。存在しない場合はnull

    • hasNext

      boolean hasNext(ExecutionContext ctx)
      次に読み込むデータが存在するかどうかを返却する。
      Parameters:
      ctx - 実行コンテキスト
      Returns:
      次に読み込むデータが存在する場合はtrue

    • close

      void close(ExecutionContext ctx)
      このリーダの利用を停止し、内部的に保持している各種リソースを解放する。
      Parameters:
      ctx - 実行コンテキスト