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

クラス MongoItemWriter<T>

java.lang.ObjectSE
org.springframework.batch.item.data.MongoItemWriter<T>
実装されているすべてのインターフェース:
ItemWriter<T>, org.springframework.beans.factory.InitializingBean
public class MongoItemWriter<T> extends ObjectSE implements ItemWriter<T>, org.springframework.beans.factory.InitializingBean

Spring Data の MongoOperations の実装を使用して MongoDB ストアに書き込む ItemWriter 実装。MongoDB はトランザクションストアではないため、書き込まれたデータを最後の瞬間に保持し、それでもジョブステータス契約を尊重するように最善を尽くします。書き込み中にエラーが発生した場合、ロールバックは試行されません。

このライターは、すべてのプロパティが設定されるとスレッドセーフになるため（通常のシングルトン動作）、複数の同時トランザクションで使用できます。

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

  • ネストされたクラスの要約

    ネストされたクラス
    修飾子と型
    クラス
    説明
    static enum
    MongoItemWriter.Mode
    アイテムライターの動作モード。

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

    コンストラクター
    コンストラクター
    説明
    MongoItemWriter()

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    afterPropertiesSet()
    protected void
    doWrite(Chunk<? extends T> chunk)
    テンプレートを介してストアへの実際の書き込みを実行します。
    StringSE
    getCollection()
    Mongo コレクション名を取得します。
    MongoItemWriter.Mode
    getMode()
    アイテムライターの動作中の MongoItemWriter.Mode を取得します。
    ListSE<StringSE>
    getPrimaryKeys()
    書き込まれるドキュメントに関連付けられた主キーのリストを取得します。
    protected org.springframework.data.mongodb.core.MongoOperations
    getTemplate()
    書き込むアイテムを保存するために使用する MongoOperations を入手します。
    void
    setCollection(StringSE collection)
    書き込む Mongo コレクションの名前を設定します。
    void
    setDelete(boolean delete)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    代わりに setMode(Mode) を使用してください。
    void
    setMode(MongoItemWriter.Mode mode)
    本ライタが適用する動作中の MongoItemWriter.Mode を設定します。
    void
    setPrimaryKeys(ListSE<StringSE> primaryKeys)
    書き込むドキュメントに関連付ける主キーを設定します。
    void
    setTemplate(org.springframework.data.mongodb.core.MongoOperations template)
    書き込むアイテムを保存するために使用する MongoOperations を設定します。
    void
    write(Chunk<? extends T> chunk)
    トランザクションがアクティブな場合、コミットの直前に書き込まれるアイテムをバッファリングします。

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

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

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

    • MongoItemWriter

      public MongoItemWriter()

  • メソッドの詳細

    • setDelete

      @DeprecatedSE(since="5.1", forRemoval=true) public void setDelete(boolean delete)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      代わりに setMode(Mode) を使用してください。v5.3 以降で削除予定。
      ライターに渡される項目をデータストアに保存するか、データストアから削除するかを示します。false (デフォルト) に設定すると、項目は MongoItemWriter.Mode.UPSERT を使用して保存または更新されます。true に設定すると、項目は削除されます。
      パラメーター:
      delete - 除去インジケーター

    • setMode

      public void setMode(MongoItemWriter.Mode mode)
      本ライタが適用する動作中の MongoItemWriter.Mode を設定します。デフォルトは MongoItemWriter.Mode.UPSERT です。
      パラメーター:
      mode - 使用するモード。
      導入:
      5.1

    • getMode

      public MongoItemWriter.Mode getMode()
      アイテムライターの動作中の MongoItemWriter.Mode を取得します。
      戻り値:
      動作モード
      導入:
      5.1

    • setTemplate

      public void setTemplate(org.springframework.data.mongodb.core.MongoOperations template)
      書き込むアイテムを保存するために使用する MongoOperations を設定します。
      パラメーター:
      template - 使用するテンプレートの実装。

    • getTemplate

      protected org.springframework.data.mongodb.core.MongoOperations getTemplate()
      書き込むアイテムを保存するために使用する MongoOperations を入手します。これは、必要に応じてサブクラスから呼び出すことができます。
      戻り値:
      テンプレート使用するテンプレート実装。

    • setCollection

      public void setCollection(StringSE collection)
      書き込む Mongo コレクションの名前を設定します。
      パラメーター:
      collection - コレクションの名前。

    • getCollection

      public StringSE getCollection()
      Mongo コレクション名を取得します。
      戻り値:
      コレクション名
      導入:
      5.1

    • setPrimaryKeys

      public void setPrimaryKeys(ListSE<StringSE> primaryKeys)
      書き込むドキュメントに関連付ける主キーを設定します。これらのフィールドは単一のオブジェクトを一意に識別する必要があります。
      パラメーター:
      primaryKeys - 使用する主キー。
      導入:
      5.2.3

    • getPrimaryKeys

      public ListSE<StringSE> getPrimaryKeys()
      書き込まれるドキュメントに関連付けられた主キーのリストを取得します。
      戻り値:
      主キーのリスト
      導入:
      5.2.3

    • write

      public void write(Chunk<? extends T> chunk) throws ExceptionSE
      トランザクションがアクティブな場合、コミットの直前に書き込まれるアイテムをバッファリングします。それ以外の場合は、提供されたテンプレートを使用してアイテムを記述します。
      次で指定:
      インターフェース ItemWriter<T> の write 
      パラメーター:
      chunk - 書きこまれる項目。null であってはなりません。
      例外:
      ExceptionSE - エラーがある場合。フレームワークは例外をキャッチし、必要に応じて変換または再スローします。
      関連事項:

    • doWrite

      protected void doWrite(Chunk<? extends T> chunk)
      テンプレートを介してストアへの実際の書き込みを実行します。これは、必要に応じてサブクラスによってオーバーライドできます。
      パラメーター:
      chunk - 永続化されるアイテムのチャンク。

    • afterPropertiesSet

      public void afterPropertiesSet() throws ExceptionSE
      次で指定:
      インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet 
      例外:
      ExceptionSE