|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.dbutils.handlers.AbstractKeyedHandler<K,V>
org.apache.commons.dbutils.handlers.BeanMapHandler<K,V>
K
- the type of keys maintained by the returned mapV
- the type of the beanpublic class BeanMapHandler<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 BeanMapdHandler<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.
This class is thread safe.
ResultSetHandler
Constructor Summary | |
---|---|
BeanMapHandler(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,
RowProcessor convert)
Creates a new instance of BeanMapHandler. |
|
BeanMapHandler(Class<V> type,
String columnName)
Creates a new instance of BeanMapHandler. |
Method Summary | |
---|---|
protected K |
createKey(ResultSet rs)
This factory method is called by handle() to retrieve the
key value from the current ResultSet row. |
protected V |
createRow(ResultSet rs)
This factory method is called by handle() to store the
current ResultSet row in some object. |
Methods inherited from class org.apache.commons.dbutils.handlers.AbstractKeyedHandler |
---|
createMap, handle |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BeanMapHandler(Class<V> type)
type
- The Class that objects returned from createRow()
are created from.public BeanMapHandler(Class<V> type, RowProcessor convert)
type
- The Class that objects returned from createRow()
are created from.convert
- The RowProcessor
implementation to use when
converting rows into Beanspublic BeanMapHandler(Class<V> type, int columnIndex)
type
- The Class that objects returned from createRow()
are created from.columnIndex
- The values to use as keys in the Map are retrieved from the
column at this index.public BeanMapHandler(Class<V> type, String columnName)
type
- The Class that objects returned from createRow()
are created from.columnName
- The values to use as keys in the Map are retrieved from the
column with this name.Method Detail |
---|
protected K createKey(ResultSet rs) throws SQLException
handle()
to retrieve the
key value from the current ResultSet
row.
createKey
in class AbstractKeyedHandler<K,V>
rs
- ResultSet to create a key from
SQLException
- if a database access error occurs
ClassCastException
- if the class datatype does not match the column typeAbstractKeyedHandler.createKey(ResultSet)
protected V createRow(ResultSet rs) throws SQLException
AbstractKeyedHandler
handle()
to store the
current ResultSet
row in some object.
createRow
in class AbstractKeyedHandler<K,V>
rs
- ResultSet to create a row from
SQLException
- if a database access error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |