类 GeneratedKeyHolder
- java.lang.Object
- org.springframework.jdbc.support.GeneratedKeyHolder
- 所有已实现的接口:
KeyHolder
public class GeneratedKeyHolder extends Object implements KeyHolder
The standard implementation of theKeyHolderinterface, to be used for holding auto-generated keys (as potentially returned by JDBC insert statements).Create an instance of this class for each insert operation, and pass it to the corresponding
JdbcTemplateorSqlUpdatemethods.- 从以下版本开始:
- 1.1
- 作者:
- Thomas Risberg, Juergen Hoeller
构造器概要
构造器 构造器 说明 GeneratedKeyHolder()Create a new GeneratedKeyHolder with a default list.GeneratedKeyHolder(List<Map<String,Object>> keyList)Create a new GeneratedKeyHolder with a given list.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 NumbergetKey()Retrieve the first item from the first map, assuming that there is just one item and just one map, and that the item is a number.List<Map<String,Object>>getKeyList()Return a reference to the List that contains the keys.Map<String,Object>getKeys()Retrieve the first map of keys.
构造器详细资料
GeneratedKeyHolder
public GeneratedKeyHolder()
Create a new GeneratedKeyHolder with a default list.
GeneratedKeyHolder
public GeneratedKeyHolder(List<Map<String,Object>> keyList)
Create a new GeneratedKeyHolder with a given list.- 参数:
keyList- a list to hold maps of keys
方法详细资料
getKey
public Number getKey() throws InvalidDataAccessApiUsageException, DataRetrievalFailureException
从接口复制的说明:KeyHolderRetrieve the first item from the first map, assuming that there is just one item and just one map, and that the item is a number. This is the typical case: a single, numeric generated key.Keys are held in a List of Maps, where each item in the list represents the keys for each row. If there are multiple columns, then the Map will have multiple entries as well. If this method encounters multiple entries in either the map or the list meaning that multiple keys were returned, then an InvalidDataAccessApiUsageException is thrown.
- 指定者:
getKey在接口中KeyHolder- 返回:
- the generated key as a number
- 抛出:
InvalidDataAccessApiUsageException- if multiple keys are encounteredDataRetrievalFailureException
getKeys
public Map<String,Object> getKeys() throws InvalidDataAccessApiUsageException
从接口复制的说明:KeyHolderRetrieve the first map of keys.If there are multiple entries in the list (meaning that multiple rows had keys returned), then an InvalidDataAccessApiUsageException is thrown.
- 指定者:
getKeys在接口中KeyHolder- 返回:
- the Map of generated keys for a single row
- 抛出:
InvalidDataAccessApiUsageException- if keys for multiple rows are encountered
getKeyList
public List<Map<String,Object>> getKeyList()
从接口复制的说明:KeyHolderReturn a reference to the List that contains the keys.Can be used for extracting keys for multiple rows (an unusual case), and also for adding new maps of keys.
- 指定者:
getKeyList在接口中KeyHolder- 返回:
- the List for the generated keys, with each entry representing an individual row through a Map of column names and key values