org.apache.commons.beanutils
Class ResultSetDynaClass

java.lang.Object
  extended by org.apache.commons.beanutils.JDBCDynaClass
      extended by org.apache.commons.beanutils.ResultSetDynaClass
All Implemented Interfaces:
java.io.Serializable, DynaClass

public class ResultSetDynaClass
extends JDBCDynaClass
implements DynaClass

Implementation of DynaClass for DynaBeans that wrap the java.sql.Row objects of a java.sql.ResultSet. The normal usage pattern is something like:

   ResultSet rs = ...;
   ResultSetDynaClass rsdc = new ResultSetDynaClass(rs);
   Iterator rows = rsdc.iterator();
   while (rows.hasNext())  {
     DynaBean row = (DynaBean) rows.next();
     ... process this row ...
   }
   rs.close();
 

Each column in the result set will be represented as a DynaBean property of the corresponding name (optionally forced to lower case for portability).

WARNING - Any DynaBean instance returned by this class, or from the Iterator returned by the iterator() method, is directly linked to the row that the underlying result set is currently positioned at. This has the following implications:

Any database data that you wish to utilize outside the context of the current row of an open result set must be copied. For example, you could use the following code to create standalone copies of the information in a result set:

   ArrayList results = new ArrayList(); // To hold copied list
   ResultSetDynaClass rsdc = ...;
   DynaProperty properties[] = rsdc.getDynaProperties();
   BasicDynaClass bdc =
     new BasicDynaClass("foo", BasicDynaBean.class,
                        rsdc.getDynaProperties());
   Iterator rows = rsdc.iterator();
   while (rows.hasNext()) {
     DynaBean oldRow = (DynaBean) rows.next();
     DynaBean newRow = bdc.newInstance();
     PropertyUtils.copyProperties(newRow, oldRow);
     results.add(newRow);
   }
 

Version:
$Revision: 1.15 $ $Date: 2004/02/28 13:18:33 $
Author:
Craig R. McClanahan
See Also:
Serialized Form

Field Summary
protected  java.sql.ResultSet resultSet
          The ResultSet we are wrapping.
 
Fields inherited from class org.apache.commons.beanutils.JDBCDynaClass
lowerCase, properties, propertiesMap
 
Constructor Summary
ResultSetDynaClass(java.sql.ResultSet resultSet)
          Construct a new ResultSetDynaClass for the specified ResultSet.
ResultSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase)
          Construct a new ResultSetDynaClass for the specified ResultSet.
 
Method Summary
(package private)  java.sql.ResultSet getResultSet()
          Return the result set we are wrapping.
 java.util.Iterator iterator()
          Return an Iterator of DynaBean instances for each row of the wrapped ResultSet, in "forward" order.
protected  java.lang.Class loadClass(java.lang.String className)
          Loads the class of the given name which by default uses the class loader used to load this library.
 
Methods inherited from class org.apache.commons.beanutils.JDBCDynaClass
createDynaProperty, getDynaProperties, getDynaProperty, getName, introspect, newInstance
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.commons.beanutils.DynaClass
getDynaProperties, getDynaProperty, getName, newInstance
 

Field Detail

resultSet

protected java.sql.ResultSet resultSet

The ResultSet we are wrapping.

Constructor Detail

ResultSetDynaClass

public ResultSetDynaClass(java.sql.ResultSet resultSet)
                   throws java.sql.SQLException

Construct a new ResultSetDynaClass for the specified ResultSet. The property names corresponding to column names in the result set will be lower cased.

Parameters:
resultSet - The result set to be wrapped
Throws:
java.lang.NullPointerException - if resultSet is null
java.sql.SQLException - if the metadata for this result set cannot be introspected

ResultSetDynaClass

public ResultSetDynaClass(java.sql.ResultSet resultSet,
                          boolean lowerCase)
                   throws java.sql.SQLException

Construct a new ResultSetDynaClass for the specified ResultSet. The property names corresponding to the column names in the result set will be lower cased or not, depending on the specified lowerCase value.

WARNING - If you specify false for lowerCase, the returned property names will exactly match the column names returned by your JDBC driver. Because different drivers might return column names in different cases, the property names seen by your application will vary depending on which JDBC driver you are using.

Parameters:
resultSet - The result set to be wrapped
lowerCase - Should property names be lower cased?
Throws:
java.lang.NullPointerException - if resultSet is null
java.sql.SQLException - if the metadata for this result set cannot be introspected
Method Detail

iterator

public java.util.Iterator iterator()

Return an Iterator of DynaBean instances for each row of the wrapped ResultSet, in "forward" order. Unless the underlying result set supports scrolling, this method should be called only once.


getResultSet

java.sql.ResultSet getResultSet()

Return the result set we are wrapping.


loadClass

protected java.lang.Class loadClass(java.lang.String className)
                             throws java.sql.SQLException

Loads the class of the given name which by default uses the class loader used to load this library. Dervations of this class could implement alternative class loading policies such as using custom ClassLoader or using the Threads's context class loader etc.

Overrides:
loadClass in class JDBCDynaClass
Throws:
java.sql.SQLException - if an exception was thrown trying to load the specified class


Copyright (c) 2001-2004 - Apache Software Foundation