パッケージ jakarta.batch.api.chunk

インターフェース ItemReader

すべての既知の実装クラス:
AbstractItemReader
public interface ItemReader
ItemReader は、チャンク処理のためにアイテムを読み取るバッチアーティファクトを定義します。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    SerializableSE
    checkpointInfo()
    checkpointInfo メソッドは、このリーダーの現在のチェックポイントデータを返します。
    void
    close()
    close メソッドは、ItemReader の使用の終了を示します。
    void
    open(SerializableSE checkpoint)
    open メソッドは、リーダーがアイテムを読む準備をします。
    ObjectSE
    readItem()
    readItem メソッドは、チャンク処理の次の項目を返します。

  • メソッドの詳細

    • open

      void open(SerializableSE checkpoint) throws ExceptionSE
      open メソッドは、リーダーがアイテムを読み取る準備をします。入力パラメーターは、特定のジョブインスタンスにおけるこのリーダーの最後のチェックポイントを表します。チェックポイントデータは、このリーダーによって定義され、checkpointInfo メソッドによって提供されます。チェックポイントデータは、リーダーが再起動時にアイテムの読み取りを再開するために必要なすべての情報を提供します。最初の開始時には、チェックポイント値 null が渡されます。
      パラメーター:
      checkpoint - 最後のチェックポイントを指定します
      例外:
      ExceptionSE - エラーが発生するとスローされます。

    • close

      void close() throws ExceptionSE
      close メソッドは、ItemReader の使用が終了したことを示します。リーダーは必要なクリーンアップを自由に行うことができます。
      例外:
      ExceptionSE - エラーが発生するとスローされます。

    • readItem

      ObjectSE readItem() throws ExceptionSE
      readItem メソッドは、チャンク処理の次の項目を返します。項目がもうないことを示すために null を返します。これは、現在のチャンクがコミットされ、ステップが終了することも意味します。
      戻り値:
      次のアイテムまたは null
      例外:
      ExceptionSE - エラーが発生するとスローされます。

    • checkpointInfo

      SerializableSE checkpointInfo() throws ExceptionSE
      checkpointInfo メソッドは、このリーダーの現在のチェックポイントデータを返します。チャンクチェックポイントがコミットされる前に呼び出されます。
      戻り値:
      チェックポイントデータ
      例外:
      ExceptionSE - エラーが発生するとスローされます。