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

クラス MongoItemReader<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>
org.springframework.batch.item.data.MongoItemReader<T>
実装されたすべてのインターフェース:
ItemReader<T>、ItemStream、ItemStreamReader<T>、org.springframework.beans.factory.InitializingBean
既知の直属サブクラス
MongoPagingItemReader
@DeprecatedSE(since="5.1", forRemoval=true) public class MongoItemReader<T> extends AbstractPaginatedDataItemReader<T> implements org.springframework.beans.factory.InitializingBean
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
代わりに MongoPagingItemReader を使用してください。v5.3 以降で削除予定。

ページング手法を使用して MongoDB からドキュメントを読み取る再起動可能な ItemReader。

JSON 文字列クエリ setQuery(String) を設定すると、リクエストされたドキュメントを取得するために JSON が実行されます。

Query オブジェクト setQuery(Query) を設定すると、リクエストされたドキュメントを取得するために Query が実行されます。

クエリは、AbstractPaginatedDataItemReader.setPageSize(int) で指定されたページリクエストを使用して実行されます。AbstractItemCountingItemStreamItemReader.read() メソッドが呼び出されると、データを提供するために必要に応じて追加のページがリクエストされます。

提供される JSON 文字列クエリは、?<index> プレースホルダーを介したパラメーター置換をサポートします。<index> は、置換する parameterValue のインデックスを示します。

実装は AbstractItemCountingItemStreamItemReader.open(ExecutionContext) の呼び出し間でスレッドセーフですが、マルチスレッドクライアントで使用する場合は saveState=false を使用することを忘れないでください（再起動は利用できません）。

作成者:
Michael Minella, Takaaki Iida, Mahmoud Ben Hassine, Parikshit Dutta

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    protected StringSE
    collection
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected StringSE
    fields
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected StringSE
    hint
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected ListSE<ObjectSE>
    parameterValues
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected org.springframework.data.mongodb.core.query.Query
    query
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected StringSE
    queryString
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected org.springframework.data.domain.Sort
    sort
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected org.springframework.data.mongodb.core.MongoOperations
    template
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected ClassSE<? extends T>
    type
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    クラス org.springframework.batch.item.data.AbstractPaginatedDataItemReader から継承されたフィールド

    page, pageSize, results

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    MongoItemReader()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    afterPropertiesSet()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    必須プロパティをチェックします
    protected org.springframework.data.domain.Sort
    convertToSort(MapSE<StringSE,org.springframework.data.domain.Sort.Direction> sorts)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    protected IteratorSE<T>
    doPageRead()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    ページを読み取る実際の作業のために、この ItemStreamReader が委譲するメソッド。
    protected StringSE
    replacePlaceholders(StringSE input, ListSE<ObjectSE> values)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    void
    setCollection(StringSE collection)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    void
    setFields(StringSE fields)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    MongoDB によって一致するドキュメントから返されるフィールドを定義する JSON。
    void
    setHint(StringSE hint)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    使用するインデックスを MongoDB に指示する JSON 文字列。
    void
    setParameterValues(ListSE<ObjectSE> parameterValues)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    クエリの各パラメーターに代入される ListSE の値。
    void
    setQuery(StringSE queryString)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    JSON 形式の MongoDB クエリ。
    void
    setQuery(org.springframework.data.mongodb.core.query.Query query)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    使用する Mongo クエリ。
    void
    setSort(MapSE<StringSE,org.springframework.data.domain.Sort.Direction> sorts)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    入力を並べ替えるプロパティ名 /Sort.Direction 値の MapSE。
    void
    setTargetType(ClassSE<? extends T> type)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    各 AbstractItemCountingItemStreamItemReader.read() 呼び出しで返されるオブジェクトの型。
    void
    setTemplate(org.springframework.data.mongodb.core.MongoOperations template)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    MongoDB インスタンスに対して操作を実行するために使用されます。

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

    doClose, doOpen, doRead, jumpToItem, setPageSize

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

    close, getCurrentItemCount, isSaveState, open, read, setCurrentItemCount, setMaxItemCount, setSaveState, update

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

    getExecutionContextKey, getName, setExecutionContextName, setName

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

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • フィールドの詳細

    • template

      protected org.springframework.data.mongodb.core.MongoOperations template
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • query

      protected org.springframework.data.mongodb.core.query.Query query
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • queryString

      protected StringSE queryString
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • type

      protected ClassSE<? extends T> type
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • sort

      protected org.springframework.data.domain.Sort sort
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • hint

      protected StringSE hint
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • fields

      protected StringSE fields
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • collection

      protected StringSE collection
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • parameterValues

      protected ListSE<ObjectSE> parameterValues
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

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

    • MongoItemReader

      public MongoItemReader()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • メソッドの詳細

    • setQuery

      public void setQuery(org.springframework.data.mongodb.core.query.Query query)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      使用する Mongo クエリ。
      パラメーター:
      query - 使用する Mongo クエリ。

    • setTemplate

      public void setTemplate(org.springframework.data.mongodb.core.MongoOperations template)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      MongoDB インスタンスに対して操作を実行するために使用されます。ドキュメントのオブジェクトへのマッピングも処理します。
      パラメーター:
      template - 使用する MongoOperations インスタンス
      関連事項:
      • MongoOperations

    • setQuery

      public void setQuery(StringSE queryString)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      JSON 形式の MongoDB クエリ。提供されたクエリのパラメーター化は、?<index> プレースホルダーを介して許可されます。<index> は、置換する parameterValue のインデックスを示します。
      パラメーター:
      queryString - JSON 形式の Mongo クエリ

    • setTargetType

      public void setTargetType(ClassSE<? extends T> type)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      各 AbstractItemCountingItemStreamItemReader.read() 呼び出しで返されるオブジェクトの型。
      パラメーター:
      type - 返すオブジェクトの型

    • setParameterValues

      public void setParameterValues(ListSE<ObjectSE> parameterValues)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      クエリの各パラメーターに代入される ListSE の値。
      パラメーター:
      parameterValues - 個の値

    • setFields

      public void setFields(StringSE fields)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      MongoDB によって一致するドキュメントから返されるフィールドを定義する JSON。
      パラメーター:
      fields - ソートするフィールドを識別する JSON 文字列。

    • setSort

      public void setSort(MapSE<StringSE,org.springframework.data.domain.Sort.Direction> sorts)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      入力を並べ替えるプロパティ名 /Sort.Direction 値の MapSE。
      パラメーター:
      sorts - プロパティのマップとそれぞれを並べ替える方向。

    • setCollection

      public void setCollection(StringSE collection)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      パラメーター:
      collection - 照会する Mongo コレクション。

    • setHint

      public void setHint(StringSE hint)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      使用するインデックスを MongoDB に指示する JSON 文字列。
      パラメーター:
      hint - 使用するインデックスを示す文字列。

    • doPageRead

      protected IteratorSE<T> doPageRead()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      クラスからコピーされた説明: AbstractPaginatedDataItemReader
      この ItemStreamReader がページを読み取る実際の作業のために委譲するメソッド。このメソッドが呼び出されるたびに、結果の IteratorSE には、次のページ内で読み取られた項目が含まれている必要があります。

      返されたときに IteratorSE が空または null の場合、この ItemReader は入力が使い果たされたと想定します。
      次で指定:
      クラス AbstractPaginatedDataItemReader<T> の doPageRead 
      戻り値:
      ページ内のアイテムを含む IteratorSE。

    • afterPropertiesSet

      public void afterPropertiesSet() throws ExceptionSE
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      必須プロパティをチェックします
      次で指定:
      インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet 
      例外:
      ExceptionSE
      関連事項:
      • InitializingBean.afterPropertiesSet()

    • replacePlaceholders

      protected StringSE replacePlaceholders(StringSE input, ListSE<ObjectSE> values)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • convertToSort

      protected org.springframework.data.domain.Sort convertToSort(MapSE<StringSE,org.springframework.data.domain.Sort.Direction> sorts)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。