クラス MongoCursorItemReader<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.MongoCursorItemReader<T>
- 実装されているすべてのインターフェース:
ItemReader<T>、ItemStream、ItemStreamReader<T>、org.springframework.beans.factory.InitializingBean
public class MongoCursorItemReader<T>
extends AbstractItemCountingItemStreamItemReader<T>
implements org.springframework.beans.factory.InitializingBean
MongoDB 用のカーソルベースの
ItemReader 実装。- 導入:
- 5.1
- 作成者:
- LEE Juchan, Mahmoud Ben Hassine
コンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明void必須プロパティをチェックしますprotected voiddoClose()AbstractItemCountingItemStreamItemReader.doOpen()で開いたリソースを閉じます。protected voiddoOpen()入力の読み取りを開始するために必要なリソースを開きます。protected TdoRead()入力から次の項目を読み取ります。voidsetBatchSize(int batchSize) 結果を反復処理するときに使用するバッチのサイズ。voidsetCollection(StringSE collection) voidMongoDB によって一致するドキュメントから返されるフィールドを定義する JSON。void使用するインデックスを MongoDB に指示する JSON 文字列。voidsetLimit(int limit) クエリ制限。voidsetMaxTime(DurationSE maxTime) クエリの最大実行時間voidsetParameterValues(ListSE<ObjectSE> parameterValues) クエリの各パラメーターに代入されるListSE の値。voidJSON 形式の MongoDB クエリ。voidsetQuery(org.springframework.data.mongodb.core.query.Query query) 使用する Mongo クエリ。void入力を並べ替えるプロパティ名 /Sort.Direction値のMapSE。voidsetTargetType(ClassSE<? extends T> targetType) 各AbstractItemCountingItemStreamItemReader.read()呼び出しに対して返されるオブジェクトの targetType。voidsetTemplate(org.springframework.data.mongodb.core.MongoOperations template) MongoDB インスタンスに対して操作を実行するために使用されます。クラス org.springframework.batch.item.support.AbstractItemCountingItemStreamItemReader から継承されたメソッド
close, getCurrentItemCount, isSaveState, jumpToItem, open, read, setCurrentItemCount, setMaxItemCount, setSaveState, updateクラス org.springframework.batch.item.ItemStreamSupport から継承されたメソッド
getExecutionContextKey, getName, setExecutionContextName, setName
コンストラクターの詳細
MongoCursorItemReader
public MongoCursorItemReader()新しいMongoCursorItemReaderを作成します。
メソッドの詳細
setTemplate
public void setTemplate(org.springframework.data.mongodb.core.MongoOperations template) MongoDB インスタンスに対して操作を実行するために使用されます。ドキュメントのオブジェクトへのマッピングも処理します。- パラメーター:
template- 使用する MongoOperations インスタンス- 関連事項:
MongoOperations
setTargetType
各AbstractItemCountingItemStreamItemReader.read()呼び出しに対して返されるオブジェクトの targetType。- パラメーター:
targetType- 返すオブジェクトの targetType
setCollection
- パラメーター:
collection- 照会する Mongo コレクション。
setQuery
public void setQuery(org.springframework.data.mongodb.core.query.Query query) 使用する Mongo クエリ。- パラメーター:
query- 使用する Mongo クエリ。
setQuery
JSON 形式の MongoDB クエリ。提供されたクエリのパラメーター化は、?<index> プレースホルダーを介して許可されます。<index> は、置換する parameterValue のインデックスを示します。- パラメーター:
queryString- JSON 形式の Mongo クエリ
setParameterValues
クエリの各パラメーターに代入されるListSE の値。- パラメーター:
parameterValues- 個の値
setFields
MongoDB によって一致するドキュメントから返されるフィールドを定義する JSON。- パラメーター:
fields- ソートするフィールドを識別する JSON 文字列。
setSort
入力を並べ替えるプロパティ名 /Sort.Direction値のMapSE。- パラメーター:
sorts- プロパティのマップとそれぞれを並べ替える方向。
setHint
使用するインデックスを MongoDB に指示する JSON 文字列。- パラメーター:
hint- 使用するインデックスを示す文字列。
setBatchSize
public void setBatchSize(int batchSize) 結果を反復処理するときに使用するバッチのサイズ。- パラメーター:
batchSize- size カーソルに適用するバッチサイズ- 関連事項:
Query.cursorBatchSize(int)
setLimit
public void setLimit(int limit) クエリ制限。- パラメーター:
limit- 限界- 関連事項:
Query.limit(int)
setMaxTime
クエリの最大実行時間- パラメーター:
maxTime- 最大時間- 関連事項:
Query.maxTime(Duration)
afterPropertiesSet
public void afterPropertiesSet()必須プロパティをチェックします- 次で指定:
- インターフェース
org.springframework.beans.factory.InitializingBeanのafterPropertiesSet - 関連事項:
InitializingBean.afterPropertiesSet()
doOpen
クラスからコピーされた説明:AbstractItemCountingItemStreamItemReader入力の読み取りを開始するために必要なリソースを開きます。- 次で指定:
- クラス
AbstractItemCountingItemStreamItemReader<T>のdoOpen - 例外:
ExceptionSE- サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
doRead
クラスからコピーされた説明:AbstractItemCountingItemStreamItemReader入力から次の項目を読み取ります。- 次で指定:
- クラス
AbstractItemCountingItemStreamItemReader<T>のdoRead - 戻り値:
- データソースが使い果たされた場合、アイテムまたは
null - 例外:
ExceptionSE- サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします
doClose
クラスからコピーされた説明:AbstractItemCountingItemStreamItemReaderAbstractItemCountingItemStreamItemReader.doOpen()で開いたリソースを閉じます。- 次で指定:
- クラス
AbstractItemCountingItemStreamItemReader<T>のdoClose - 例外:
ExceptionSE- サブクラスがフレームワークによる解釈のためにチェック済み例外をスローできるようにします