RepositoryItemReader (Spring Batch API)

java.lang.Object
- org.springframework.batch.item.ItemStreamSupport
- - org.springframework.batch.item.support.AbstractItemStreamItemReader<T>
  - - org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader<T>
    - - org.springframework.batch.item.data.RepositoryItemReader<T>

実装されたすべてのインターフェース:
ItemReader<T>, ItemStream, ItemStreamReader<T>, org.springframework.beans.factory.InitializingBean
```
public class RepositoryItemReader<T>
extends AbstractItemCountingItemStreamItemReader<T>
implements org.springframework.beans.factory.InitializingBean
```
PagingAndSortingRepository を使用してレコードを読み取る ItemReader。
リーダーのパフォーマンスはリポジトリの実装に依存しますが、かなり大きなページサイズを設定し、それをコミット間隔と一致させると、パフォーマンスが向上します。
リーダーは、PagingAndSortingRepository、Sort、0 より大きい pageSize で構成する必要があります。
この実装は AbstractItemCountingItemStreamItemReader.open(ExecutionContext) の呼び出し間でスレッドセーフですが、マルチスレッドクライアントで使用する場合は saveState=false を使用することを忘れないでください（再起動は利用できません）。
これはページングアイテムリーダーであり、ページ自体の読み取り中にスローされる例外（doPageRead() 内のオブジェクトなどへのマッピング結果）は、このリーダーには例外があるかどうかを知る方法がないためスキップできないことに注意することが重要ですスキップされたため、スキップ制限を超えるまで同じページを読み続けます。
NOTE: RepositoryItemReader は、Java オブジェクト、つまり非プリミティブのみを読み取ります。
導入:
2.2
作成者:
Michael Minella, Antoine Kapps

フィールドサマリー
フィールド
修飾子と型フィールドと説明
protected org.apache.commons.logging.Log logger

フィールド
修飾子と型	フィールドと説明
`protected org.apache.commons.logging.Log`	`logger`

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
RepositoryItemReader()

コンストラクター
コンストラクターと説明
`RepositoryItemReader()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()`
`protected void`	`doClose()` `AbstractItemCountingItemStreamItemReader.doOpen()` で開いたリソースを閉じます。
`protected void`	`doOpen()` 入力の読み取りを開始するために必要なリソースを開きます。
`protected java.util.List<T>`	`doPageRead()` リポジトリを介してページの実際の読み取りを実行します。
`protected T`	`doRead()` 入力から次の項目を読み取ります。
`protected void`	`jumpToItem(int itemLastIndex)` 指定されたアイテムインデックスに移動します。
`void`	`setArguments(java.util.List<?> arguments)` データ提供メソッドに渡される引数。
`void`	`setMethodName(java.lang.String methodName)` 呼び出すリポジトリ上のメソッドを指定します。
`void`	`setPageSize(int pageSize)`
`void`	`setRepository(org.springframework.data.repository.PagingAndSortingRepository<?,?> repository)` 入力の読み取りに使用される `PagingAndSortingRepository` 実装。
`void`	`setSort(java.util.Map<java.lang.String,org.springframework.data.domain.Sort.Direction> sorts)` ページ化されたクエリ間で順序が維持されるように、結果の順序を提供します

クラス org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader から継承されたメソッド
close, getCurrentItemCount, isSaveState, open, read, setCurrentItemCount, setMaxItemCount, setSaveState, update

クラス org.springframework.batch.item.ItemStreamSupport から継承されたメソッド
getExecutionContextKey, setExecutionContextName, setName

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - logger
```
protected org.apache.commons.logging.Log logger
```
- コンストラクターの詳細
  - RepositoryItemReader
```
public RepositoryItemReader()
```
- メソッドの詳細
  - setArguments
```
public void setArguments(java.util.List<?> arguments)
```
    データ提供メソッドに渡される引数。
    パラメーター:
    arguments - リポジトリに渡されるメソッド引数のリスト
  - setSort
```
public void setSort(java.util.Map<java.lang.String,org.springframework.data.domain.Sort.Direction> sorts)
```
    ページ化されたクエリ間で順序が維持されるように、結果の順序を提供します
    パラメーター:
    sorts - ソートするフィールドと方向
  - setPageSize
```
public void setPageSize(int pageSize)
```
    パラメーター:
    pageSize - ページごとに取得するアイテムの数。
  - setRepository
```
public void setRepository(org.springframework.data.repository.PagingAndSortingRepository<?,?> repository)
```
    入力の読み取りに使用される PagingAndSortingRepository 実装。
    パラメーター:
    repository - 入力を読み込むための基礎となるリポジトリ。
  - setMethodName
```
public void setMethodName(java.lang.String methodName)
```
    呼び出すリポジトリ上のメソッドを指定します。このメソッドは、Pageable を最後の引数としてとる必要があります。
    パラメーター:
    methodName - 呼び出すメソッドの名前
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    次で指定:
    インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet
    例外:
    java.lang.Exception
  - doRead
```
@Nullable
protected T doRead()
                      throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    入力から次の項目を読み取ります。
    次で指定:
    クラス AbstractItemCountingItemStreamItemReader<T> の doRead
    戻り値:
    データソースが使い果たされた場合、アイテムまたは null
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - jumpToItem
```
protected void jumpToItem(int itemLastIndex)
                   throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    指定されたアイテムインデックスに移動します。AbstractItemCountingItemStreamItemReader.doRead() を使用して入力を再読み取りするよりも効率的に特定のインデックスに移動する方法がある場合、サブクラスはこのメソッドをオーバーライドする必要があります。
    オーバーライド:
    クラス AbstractItemCountingItemStreamItemReader<T> の jumpToItem
    パラメーター:
    itemLastIndex - ジャンプするアイテムのインデックス（0 ベース）。
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - doPageRead
```
protected java.util.List<T> doPageRead()
                                throws java.lang.Exception
```
    リポジトリを介してページの実際の読み取りを実行します。必要に応じてオーバーライドできます。
    戻り値:
    ページを構成するアイテムのリスト
    例外:
    java.lang.Exception - 基になるメソッドがスローするもの、またはメソッドの呼び出しに関連するものに基づく
  - doOpen
```
protected void doOpen()
               throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    入力の読み取りを開始するために必要なリソースを開きます。
    次で指定:
    クラス AbstractItemCountingItemStreamItemReader<T> の doOpen
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    AbstractItemCountingItemStreamItemReader.doOpen() で開いたリソースを閉じます。
    次で指定:
    クラス AbstractItemCountingItemStreamItemReader<T> の doClose
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします

クラス RepositoryItemReader<T>

フィールドサマリー

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

メソッドのサマリー

クラス org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader から継承されたメソッド

クラス org.springframework.batch.item.ItemStreamSupport から継承されたメソッド

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

フィールドの詳細

logger

コンストラクターの詳細

RepositoryItemReader

メソッドの詳細

setArguments

setSort

setPageSize

setRepository

setMethodName

afterPropertiesSet

doRead

jumpToItem

doPageRead

doOpen

doClose