パッケージ org.springframework.jdbc.support

クラス GeneratedKeyHolder

java.lang.ObjectSE
org.springframework.jdbc.support.GeneratedKeyHolder
実装されたすべてのインターフェース:
KeyHolder
public class GeneratedKeyHolder extends ObjectSE implements KeyHolder
自動生成キー（JDBC 挿入ステートメントによって返される可能性がある）を保持するために使用される KeyHolder インターフェースの標準実装。

挿入操作ごとにこのクラスのインスタンスを作成し、対応する JdbcTemplate または SqlUpdate メソッドに渡します。

導入:
1.1
作成者:
Thomas Risberg, Juergen Hoeller, Slawomir Dymitrow

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

    コンストラクター
    コンストラクター
    説明
    GeneratedKeyHolder()
    デフォルトのリストで新しい GeneratedKeyHolder を作成します。
    GeneratedKeyHolder(ListSE<MapSE<StringSE,ObjectSE>> keyList)
    指定されたリストで新しい GeneratedKeyHolder を作成します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    NumberSE
    getKey()
    1 つのアイテムと 1 つのマップのみがあり、アイテムが数字であると仮定して、最初のマップから最初のアイテムを取得します。
    <T> T
    getKeyAs(ClassSE<T> keyType)
    アイテムが 1 つとマップが 1 つだけであり、アイテムが指定された型のインスタンスであると想定して、最初のマップから最初のアイテムを取得します。
    ListSE<MapSE<StringSE,ObjectSE>>
    getKeyList()
    キーを含むリストへの参照を返します。
    MapSE<StringSE,ObjectSE>
    getKeys()
    キーの最初のマップを取得します。

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

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

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

    • GeneratedKeyHolder

      public GeneratedKeyHolder()
      デフォルトのリストで新しい GeneratedKeyHolder を作成します。

    • GeneratedKeyHolder

      public GeneratedKeyHolder(ListSE<MapSE<StringSE,ObjectSE>> keyList)
      指定されたリストで新しい GeneratedKeyHolder を作成します。
      パラメーター:
      keyList - キーのマップを保持するリスト

  • メソッドの詳細

    • getKey

      @Nullable public NumberSE getKey() throws InvalidDataAccessApiUsageException, DataRetrievalFailureException
      インターフェースからコピーされた説明: KeyHolder
      最初のマップから最初のアイテムを取得します。1 つのアイテムと 1 つのマップしかなく、アイテムは数値であると仮定します。これは典型的なケースです: 単一の数値生成キー。

      キーはマップのリストに保持され、リストの各項目は各行のキーを表します。複数の列がある場合、マップにも複数のエントリがあります。このメソッドがマップまたはリストで複数のエントリを検出すると、複数のキーが返されたことを意味し、InvalidDataAccessApiUsageException がスローされます。

      次で指定:
      インターフェース KeyHolder の getKey 
      戻り値:
      数値として生成されたキー
      例外:
      InvalidDataAccessApiUsageException - 複数のキーが検出された場合
      DataRetrievalFailureException
      関連事項:

    • getKeyAs

      @Nullable public <T> T getKeyAs(ClassSE<T> keyType) throws InvalidDataAccessApiUsageException, DataRetrievalFailureException
      インターフェースからコピーされた説明: KeyHolder
      アイテムが 1 つとマップが 1 つだけであり、アイテムが指定された型のインスタンスであると想定して、最初のマップから最初のアイテムを取得します。これは一般的なケースです。指定された型の単一の生成されたキーです。

      キーはマップのリストに保持され、リストの各項目は各行のキーを表します。複数の列がある場合、マップにも複数のエントリがあります。このメソッドがマップまたはリストで複数のエントリを検出すると、複数のキーが返されたことを意味し、InvalidDataAccessApiUsageException がスローされます。

      次で指定:
      インターフェース KeyHolder の getKeyAs 
      パラメーター:
      keyType - 自動生成されたキーの型
      戻り値:
      指定された型のインスタンスとして生成されたキー
      例外:
      InvalidDataAccessApiUsageException - 複数のキーが検出された場合
      DataRetrievalFailureException
      関連事項:

    • getKeys

      @Nullable public MapSE<StringSE,ObjectSE> getKeys() throws InvalidDataAccessApiUsageException
      インターフェースからコピーされた説明: KeyHolder
      キーの最初のマップを取得します。

      リストに複数のエントリがある場合（複数の行にキーが返されたことを意味します）、InvalidDataAccessApiUsageException がスローされます。

      次で指定:
      インターフェース KeyHolder の getKeys 
      戻り値:
      単一行の生成されたキーのマップ
      例外:
      InvalidDataAccessApiUsageException - 複数行のキーが見つかった場合

    • getKeyList

      public ListSE<MapSE<StringSE,ObjectSE>> getKeyList()
      インターフェースからコピーされた説明: KeyHolder
      キーを含むリストへの参照を返します。

      複数の行のキーの抽出（まれなケース）、およびキーの新しいマップの追加に使用できます。

      次で指定:
      インターフェース KeyHolder の getKeyList 
      戻り値:
      生成されたキーのリスト。各エントリは、列名とキー値のマップを通じて個々の行を表します