Java Doc for KeyedHandler.java in  » Database-JDBC-Connection-Pool » Database-Utilities » org » apache » commons » dbutils » handlers » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Database JDBC Connection Pool » Database Utilities » org.apache.commons.dbutils.handlers 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.commons.dbutils.handlers.KeyedHandler

KeyedHandler
public class KeyedHandler implements ResultSetHandler(Code)

ResultSetHandler implementation that returns a Map of Maps. ResultSet rows are converted into Maps which are then stored in a Map under the given key. Although this implementation uses Maps to store row contents, subclasses are encouraged to override the createRow() method to convert the rows into any kind of object.

If you had a Person table with a primary key column called ID, you could retrieve rows from the table like this:

 ResultSetHandler h = new KeyedHandler("id");
 Map found = (Map) queryRunner.query("select id, name, age from person", h);
 Map jane = (Map) found.get(new Long(1)); // jane's id is 1
 String janesName = (String) jane.get("name");
 Integer janesAge = (Integer) jane.get("age");
 
Note that the "id" passed to KeyedHandler and "name" and "age" passed to the returned Map's get() method can be in any case. The data types returned for name and age are dependent upon how your JDBC driver converts SQL column types from the Person table into Java types.

To avoid these type issues you could subclass KeyedHandler and override createRow() to store rows in Java bean instances (ie. a Person class).

This class is thread safe.


See Also:   org.apache.commons.dbutils.ResultSetHandler
since:
   DbUtils 1.1


Field Summary
protected  intcolumnIndex
     The column index to retrieve key values from.
protected  StringcolumnName
     The column name to retrieve key values from.
protected  RowProcessorconvert
     The RowProcessor implementation to use when converting rows into Objects.

Constructor Summary
public  KeyedHandler()
     Creates a new instance of KeyedHandler.
public  KeyedHandler(RowProcessor convert)
     Creates a new instance of KeyedHandler.
public  KeyedHandler(int columnIndex)
     Creates a new instance of KeyedHandler.
public  KeyedHandler(String columnName)
     Creates a new instance of KeyedHandler.

Method Summary
protected  ObjectcreateKey(ResultSet rs)
     This factory method is called by handle() to retrieve the key value from the current ResultSet row.
protected  MapcreateMap()
     This factory method is called by handle() to create the Map to store records in.
protected  ObjectcreateRow(ResultSet rs)
     This factory method is called by handle() to store the current ResultSet row in some object.
public  Objecthandle(ResultSet rs)
     Convert each row's columns into a Map and store then in a Map under ResultSet.getObject(key) key. A Map of Maps, never null.

Field Detail
columnIndex
protected int columnIndex(Code)
The column index to retrieve key values from. Defaults to 1.



columnName
protected String columnName(Code)
The column name to retrieve key values from. Either columnName or columnIndex will be used but never both.



convert
protected RowProcessor convert(Code)
The RowProcessor implementation to use when converting rows into Objects.




Constructor Detail
KeyedHandler
public KeyedHandler()(Code)
Creates a new instance of KeyedHandler. The value of the first column of each row will be a key in the Map.



KeyedHandler
public KeyedHandler(RowProcessor convert)(Code)
Creates a new instance of KeyedHandler. The value of the first column of each row will be a key in the Map.
Parameters:
  convert - The RowProcessor implementationto use when converting rows into Maps



KeyedHandler
public KeyedHandler(int columnIndex)(Code)
Creates a new instance of KeyedHandler.
Parameters:
  columnIndex - The values to use as keys in the Map are retrieved from the column at this index.



KeyedHandler
public KeyedHandler(String columnName)(Code)
Creates a new instance of KeyedHandler.
Parameters:
  columnName - The values to use as keys in the Map are retrieved from the column with this name.




Method Detail
createKey
protected Object createKey(ResultSet rs) throws SQLException(Code)
This factory method is called by handle() to retrieve the key value from the current ResultSet row. This implementation returns ResultSet.getObject() for the configured key column name or index.
Parameters:
  rs - ResultSet to create a key from Object from the configured key column name/index
throws:
  SQLException - if a database access error occurs



createMap
protected Map createMap()(Code)
This factory method is called by handle() to create the Map to store records in. This implementation returns a HashMap instance. Map to store records in



createRow
protected Object createRow(ResultSet rs) throws SQLException(Code)
This factory method is called by handle() to store the current ResultSet row in some object. This implementation returns a Map with case insensitive column names as keys. Calls to map.get("COL") and map.get("col") return the same value.
Parameters:
  rs - ResultSet to create a row from Object typed Map containing column names to values
throws:
  SQLException - if a database access error occurs



handle
public Object handle(ResultSet rs) throws SQLException(Code)
Convert each row's columns into a Map and store then in a Map under ResultSet.getObject(key) key. A Map of Maps, never null.
throws:
  SQLException - if a database access error occurs
See Also:   org.apache.commons.dbutils.ResultSetHandler.handle(java.sql.ResultSet)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.