Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> commons >> [ beanutils overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.commons.beanutils
Class ResultSetDynaClass  

java.lang.Object
  org.apache.commons.beanutils.JDBCDynaClass
      org.apache.commons.beanutils.ResultSetDynaClass

All Implemented Interfaces:

DynaClass, java.io.Serializable

---

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:

• Once you retrieve a different DynaBean instance, you should no longer use any previous instance.
• Changing the position of the underlying result set will change the data that the DynaBean references.
• Once the underlying result set is closed, the DynaBean instance may no longer be used.

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 $

---

Field Summary
protected  boolean	lowerCase           Flag defining whether column names should be lower cased when converted to property names.
protected  DynaProperty[]	properties           The set of dynamic properties that are part of this DynaClass.
protected  java.util.Map	propertiesMap           The set of dynamic properties that are part of this DynaClass, keyed by the property name.
protected  java.sql.ResultSet	resultSet           The ResultSet we are wrapping.

 

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
protected  DynaProperty	createDynaProperty(java.sql.ResultSetMetaData metadata, int i)           Factory method to create a new DynaProperty for the given index into the result set metadata.
DynaProperty[]	getDynaProperties()           Return an array of ProperyDescriptors for the properties currently defined in this DynaClass.
DynaProperty	getDynaProperty(java.lang.String name)           Return a property descriptor for the specified property, if it exists; otherwise, return null.
java.lang.String	getName()           Return the name of this DynaClass (analogous to the getName() method of java.lang.ClassDynaClass implementation class to support different dynamic classes, with different sets of properties.
(package private)  java.sql.ResultSet	getResultSet()           Return the result set we are wrapping.
protected  void	introspect(java.sql.ResultSet resultSet)           Introspect the metadata associated with our result set, and populate the properties and propertiesMap instance variables.
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.
DynaBean	newInstance()           Instantiate and return a new DynaBean instance, associated with this DynaClass.

 

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.

---

lowerCase

protected boolean lowerCase

Flag defining whether column names should be lower cased when converted to property names.

---

properties

protected DynaProperty[] properties

The set of dynamic properties that are part of this DynaClass.

---

propertiesMap

protected java.util.Map propertiesMap

The set of dynamic properties that are part of this DynaClass, keyed by the property name. Individual descriptor instances will be the same instances as those in the properties list.

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.

---

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.

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

---

getName

public java.lang.String getName()

Return the name of this DynaClass (analogous to the getName() method of java.lang.ClassDynaClass implementation class to support different dynamic classes, with different sets of properties.

Specified by:

getName in interface DynaClass

---

getDynaProperty

public DynaProperty getDynaProperty(java.lang.String name)

Return a property descriptor for the specified property, if it exists; otherwise, return null.

Specified by:

getDynaProperty in interface DynaClass

---

getDynaProperties

public DynaProperty[] getDynaProperties()

Return an array of ProperyDescriptors for the properties currently defined in this DynaClass. If no properties are defined, a zero-length array will be returned.

Specified by:

getDynaProperties in interface DynaClass

---

newInstance

public DynaBean newInstance()
                     throws java.lang.IllegalAccessException,
                            java.lang.InstantiationException

Instantiate and return a new DynaBean instance, associated with this DynaClass. NOTE - This operation is not supported, and throws an exception.

Specified by:

newInstance in interface DynaClass

---

createDynaProperty

protected DynaProperty createDynaProperty(java.sql.ResultSetMetaData metadata,
                                          int i)
                                   throws java.sql.SQLException

Factory method to create a new DynaProperty for the given index into the result set metadata.

---

introspect

protected void introspect(java.sql.ResultSet resultSet)
                   throws java.sql.SQLException

Introspect the metadata associated with our result set, and populate the properties and propertiesMap instance variables.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> commons >> [ beanutils overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---