Class BeanMapHandler<K,V>
java.lang.Object
org.apache.commons.dbutils.handlers.AbstractKeyedHandler<K,V>
org.apache.commons.dbutils.handlers.BeanMapHandler<K,V>
- Type Parameters:
K
- the type of keys maintained by the returned mapV
- the type of the bean
- All Implemented Interfaces:
ResultSetHandler<Map<K,
V>>
ResultSetHandler
implementation that returns a Map of Beans.
ResultSet
rows are converted into Beans which are then stored in
a Map under the given key.
If you had a Person table with a primary key column called ID, you could retrieve rows from the table like this:
ResultSetHandler<Map<Long, Person>> h = new BeanMapHandler<Long, Person>(Person.class, "id"); Map<Long, Person> found = queryRunner.query("select id, name, age from person", h); Person jane = found.get(1L); // jane's id is 1 String janesName = jane.getName(); Integer janesAge = jane.getAge();Note that the "id" passed to BeanMapHandler can be in any case. The data type returned for id is dependent upon how your JDBC driver converts SQL column types from the Person table into Java types. The "name" and "age" columns are converted according to their property descriptors by DbUtils. </p>
This class is thread safe. </p>
- Since:
- 1.5
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionBeanMapHandler
(Class<V> type) Creates a new instance of BeanMapHandler.BeanMapHandler
(Class<V> type, int columnIndex) Creates a new instance of BeanMapHandler.BeanMapHandler
(Class<V> type, String columnName) Creates a new instance of BeanMapHandler.BeanMapHandler
(Class<V> type, RowProcessor convert) Creates a new instance of BeanMapHandler. -
Method Summary
Methods inherited from class org.apache.commons.dbutils.handlers.AbstractKeyedHandler
createMap, handle
-
Constructor Details
-
BeanMapHandler
Creates a new instance of BeanMapHandler. The value of the first column of each row will be a key in the Map.- Parameters:
type
- The Class that objects returned fromcreateRow()
are created from.
-
BeanMapHandler
Creates a new instance of BeanMapHandler.- Parameters:
type
- The Class that objects returned fromcreateRow()
are created from.columnIndex
- The values to use as keys in the Map are retrieved from the column at this index.
-
BeanMapHandler
Creates a new instance of BeanMapHandler. The value of the first column of each row will be a key in the Map.- Parameters:
type
- The Class that objects returned fromcreateRow()
are created from.convert
- TheRowProcessor
implementation to use when converting rows into Beans
-
BeanMapHandler
Creates a new instance of BeanMapHandler.- Parameters:
type
- The Class that objects returned fromcreateRow()
are created from.columnName
- The values to use as keys in the Map are retrieved from the column with this name.
-
-
Method Details
-
createKey
This factory method is called byhandle()
to retrieve the key value from the currentResultSet
row.- Specified by:
createKey
in classAbstractKeyedHandler<K,
V> - Parameters:
resultSet
- ResultSet to create a key from- Returns:
- K from the configured key column name/index
- Throws:
SQLException
- if a database access error occursClassCastException
- if the class datatype does not match the column type- See Also:
-
createRow
Description copied from class:AbstractKeyedHandler
This factory method is called byhandle()
to store the currentResultSet
row in some object.- Specified by:
createRow
in classAbstractKeyedHandler<K,
V> - Parameters:
resultSet
- ResultSet to create a row from- Returns:
- V object created from the current row
- Throws:
SQLException
- if a database access error occurs
-