パッケージ org.springframework.batch.item.database

クラス JpaCursorItemReader<T>

java.lang.ObjectSE
org.springframework.batch.item.ItemStreamSupport
org.springframework.batch.item.support.AbstractItemStreamItemReader<T>
org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader<T>
org.springframework.batch.item.database.JpaCursorItemReader<T>
型パラメーター:
T - 読むアイテムの種類
実装されたすべてのインターフェース:
ItemReader<T>、ItemStream、ItemStreamReader<T>、org.springframework.beans.factory.InitializingBean
public class JpaCursorItemReader<T> extends AbstractItemCountingItemStreamItemReader<T> implements org.springframework.beans.factory.InitializingBean
JPA Query.getResultStream() に基づく ItemStreamReader 実装。初期化時に JPQL クエリを実行し、AbstractItemCountingItemStreamItemReader.read() メソッドが呼び出されるときに結果セットを反復処理して、現在の行に対応するオブジェクトを返します。クエリは、setQueryString(String) を使用して直接設定することも、setQueryProvider(JpaQueryProvider) 経由でクエリプロバイダーを使用して設定することもできます。

実装はスレッドセーフではありません。

導入:
4.3
作成者:
Mahmoud Ben Hassine, Jinwoo Bae

  • コンストラクターの詳細

    • JpaCursorItemReader

      public JpaCursorItemReader()
      新しい JpaCursorItemReader を作成します。

  • メソッドの詳細

    • setEntityManagerFactory

      public void setEntityManagerFactory(jakarta.persistence.EntityManagerFactory entityManagerFactory)
      JPA エンティティマネージャーファクトリを設定します。
      パラメーター:
      entityManagerFactory - JPA エンティティマネージャーファクトリ

    • setQueryProvider

      public void setQueryProvider(JpaQueryProvider queryProvider)
      JPA クエリプロバイダーを設定します。
      パラメーター:
      queryProvider - JPA クエリプロバイダー

    • setQueryString

      public void setQueryString(StringSE queryString)
      JPQL クエリ文字列を設定します。
      パラメーター:
      queryString - JPQL クエリ文字列

    • setParameterValues

      public void setParameterValues(MapSE<StringSE,ObjectSE> parameterValues)
      クエリの実行に使用するパラメーター値を設定します。
      パラメーター:
      parameterValues - クエリ文字列で使用されるパラメーター名によってキー設定された値。

    • setHintValues

      public void setHintValues(MapSE<StringSE,ObjectSE> hintValues)
      JPA クエリのクエリヒント値を設定します。クエリヒントを使用して、JPA プロバイダーに指示を与えることができます。
      パラメーター:
      hintValues - 各キーがヒントの名前で、対応する値がヒントの値であるマップ。
      導入:
      5.2

    • afterPropertiesSet

      public void afterPropertiesSet() throws ExceptionSE
      次で指定:
      インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet 
      例外:
      ExceptionSE

    • doOpen

      protected void doOpen() throws ExceptionSE
      クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
      入力の読み取りを開始するために必要なリソースを開きます。
      次で指定:
      クラス AbstractItemCountingItemStreamItemReader<T> の doOpen 
      例外:
      ExceptionSE - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします

    • doRead

      protected T doRead()
      クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
      入力から次の項目を読み取ります。
      次で指定:
      クラス AbstractItemCountingItemStreamItemReader<T> の doRead 
      戻り値:
      データソースが使い果たされた場合、アイテムまたは null 

    • update

      public void update(ExecutionContext executionContext) throws ItemStreamException
      インターフェースからコピーされた説明: ItemStream
      オープン中に提供された実行コンテキストが保存されようとしていることを示します。状態が残っているが、コンテキストに入れられていない場合は、ここに追加する必要があります。
      次で指定:
      インターフェース ItemStream の update 
      オーバーライド:
      クラス AbstractItemCountingItemStreamItemReader<T> の update 
      パラメーター:
      executionContext - 更新される
      例外:
      ItemStreamException

    • doClose

      protected void doClose()
      クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
      AbstractItemCountingItemStreamItemReader.doOpen() で開いたリソースを閉じます。
      次で指定:
      クラス AbstractItemCountingItemStreamItemReader<T> の doClose