AbstractPagingItemReader (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.database.AbstractPagingItemReader<T>

実装されたすべてのインターフェース:
ItemReader<T>, ItemStream, ItemStreamReader<T>, org.springframework.beans.factory.InitializingBean
既知の直属サブクラス
HibernatePagingItemReader, JdbcPagingItemReader, JpaPagingItemReader
```
public abstract class AbstractPagingItemReader<T>
extends AbstractItemCountingItemStreamItemReader<T>
implements org.springframework.beans.factory.InitializingBean
```
データベースレコードをページング方式で読み取るときに拡張するための抽象 ItemStreamReader。
実装では、setPageSize(int) で指定されたサイズのページングされたリクエストを使用してクエリを実行する必要があります。AbstractItemCountingItemStreamItemReader.read() メソッドが呼び出されると、必要に応じて追加のページがリクエストされ、現在の位置に対応するオブジェクトが返されます。
導入:
2.0
作成者:
Thomas Risberg, Dave Syer

フィールドサマリー
フィールド
修飾子と型フィールドと説明
protected org.apache.commons.logging.Log logger
protected java.util.List<T> results

フィールド
修飾子と型	フィールドと説明
`protected org.apache.commons.logging.Log`	`logger`
`protected java.util.List<T>`	`results`

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

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 必須プロパティを確認してください。
`protected void`	`doClose()` `AbstractItemCountingItemStreamItemReader.doOpen()` で開いたリソースを閉じます。
`protected abstract void`	`doJumpToPage(int itemIndex)`
`protected void`	`doOpen()` 入力の読み取りを開始するために必要なリソースを開きます。
`protected T`	`doRead()` 入力から次の項目を読み取ります。
`protected abstract void`	`doReadPage()`
`int`	`getPage()` 現在のページ番号。
`int`	`getPageSize()` このリーダーに設定されているページサイズ。
`protected void`	`jumpToItem(int itemIndex)` 指定されたアイテムインデックスに移動します。
`void`	`setPageSize(int pageSize)` 一度に取得する行数。

クラス 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
```
  - results
```
protected volatile java.util.List<T> results
```
- コンストラクターの詳細
  - AbstractPagingItemReader
```
public AbstractPagingItemReader()
```
- メソッドの詳細
  - getPage
```
public int getPage()
```
    現在のページ番号。
    戻り値:
    現在のページ
  - getPageSize
```
public int getPageSize()
```
    このリーダーに設定されているページサイズ。
    戻り値:
    ページサイズ
  - setPageSize
```
public void setPageSize(int pageSize)
```
    一度に取得する行数。
    パラメーター:
    pageSize - ページごとにフェッチする行数
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    必須プロパティを確認してください。
    次で指定:
    インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet
    例外:
    java.lang.Exception
    関連事項:
    InitializingBean.afterPropertiesSet()
  - doRead
```
@Nullable
protected T doRead()
                      throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    入力から次の項目を読み取ります。
    次で指定:
    クラス AbstractItemCountingItemStreamItemReader<T> の doRead
    戻り値:
    データソースが使い果たされた場合、アイテムまたは null
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - doReadPage
```
protected abstract void doReadPage()
```
  - 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 - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - jumpToItem
```
protected void jumpToItem(int itemIndex)
                   throws java.lang.Exception
```
    クラスからコピーされた説明: AbstractItemCountingItemStreamItemReader
    指定されたアイテムインデックスに移動します。AbstractItemCountingItemStreamItemReader.doRead() を使用して入力を再読み取りするよりも効率的に特定のインデックスに移動する方法がある場合、サブクラスはこのメソッドをオーバーライドする必要があります。
    オーバーライド:
    クラス AbstractItemCountingItemStreamItemReader<T> の jumpToItem
    パラメーター:
    itemIndex - ジャンプするアイテムのインデックス（0 ベース）。
    例外:
    java.lang.Exception - サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
  - doJumpToPage
```
protected abstract void doJumpToPage(int itemIndex)
```

クラス AbstractPagingItemReader<T>

フィールドサマリー

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

メソッドのサマリー

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

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

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

フィールドの詳細

logger

results

コンストラクターの詳細

AbstractPagingItemReader

メソッドの詳細

getPage

getPageSize

setPageSize

afterPropertiesSet

doRead

doReadPage

doOpen

doClose

jumpToItem

doJumpToPage