クラス AbstractPaginatedDataItemReader<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.data.AbstractPaginatedDataItemReader<T>
- 型パラメーター:
T
- 読み取るアイテムの型
- 実装されたすべてのインターフェース:
ItemReader<T>
、ItemStream
、ItemStreamReader<T>
- 既知の直属サブクラス
MongoItemReader
,Neo4jItemReader
public abstract class AbstractPaginatedDataItemReader<T>
extends AbstractItemCountingItemStreamItemReader<T>
Spring Data のページ付けされた機能のページ付けされたセマンティクスに基づいた基本的な読み取りロジックを処理する基本クラス。また、これらの機能に基づいて再起動に必要なセマンティクスも処理します。
このリーダーはスレッドセーフではありません。
- 導入:
- 2.2
- 作成者:
- Michael Minella, Glenn Renfro, Mahmoud Ben Hassine
フィールドのサマリー
フィールドコンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明protected void
doClose()
AbstractItemCountingItemStreamItemReader.doOpen()
で開いたリソースを閉じます。protected void
doOpen()
入力の読み取りを開始するために必要なリソースを開きます。protected abstract IteratorSE<T>
ページを読み取る実際の作業のために、このItemStreamReader
が委譲するメソッド。protected T
doRead()
入力から次の項目を読み取ります。protected void
jumpToItem
(int itemLastIndex) 指定されたアイテムインデックスに移動します。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, getName, setExecutionContextName, setName
フィールドの詳細
page
protected volatile int pagepageSize
protected int pageSizeresults
コンストラクターの詳細
AbstractPaginatedDataItemReader
public AbstractPaginatedDataItemReader()
メソッドの詳細
setPageSize
public void setPageSize(int pageSize) 各ページで読み取るアイテムの数。- パラメーター:
pageSize
- アイテムの数。pageSize は 0 より大きくなければなりません。
doRead
クラスからコピーされた説明:AbstractItemCountingItemStreamItemReader
入力から次の項目を読み取ります。- 次で指定:
- クラス
AbstractItemCountingItemStreamItemReader<T>
のdoRead
- 戻り値:
- データソースが使い果たされた場合、アイテムまたは
null
- 例外:
ExceptionSE
- サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
doPageRead
このItemStreamReader
がページを読み取る実際の作業のために委譲するメソッド。このメソッドが呼び出されるたびに、結果のIterator
SE には、次のページ内で読み取られた項目が含まれている必要があります。
返されたときにIterator
SE が空または null の場合、このItemReader
は入力が使い果たされたと想定します。- 戻り値:
- ページ内のアイテムを含む
Iterator
SE。
doOpen
クラスからコピーされた説明:AbstractItemCountingItemStreamItemReader
入力の読み取りを開始するために必要なリソースを開きます。- 次で指定:
- クラス
AbstractItemCountingItemStreamItemReader<T>
のdoOpen
- 例外:
ExceptionSE
- サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
doClose
クラスからコピーされた説明:AbstractItemCountingItemStreamItemReader
AbstractItemCountingItemStreamItemReader.doOpen()
で開いたリソースを閉じます。- 次で指定:
- クラス
AbstractItemCountingItemStreamItemReader<T>
のdoClose
- 例外:
ExceptionSE
- サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
jumpToItem
クラスからコピーされた説明:AbstractItemCountingItemStreamItemReader
指定されたアイテムインデックスに移動します。AbstractItemCountingItemStreamItemReader.doRead()
を使用して入力を再読み取りするよりも効率的に特定のインデックスに移動する方法がある場合、サブクラスはこのメソッドをオーバーライドする必要があります。- オーバーライド:
- クラス
AbstractItemCountingItemStreamItemReader<T>
のjumpToItem
- パラメーター:
itemLastIndex
- ジャンプするアイテムのインデックス(0 ベース)。- 例外:
ExceptionSE
- サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします