Class RowSetDynaClass
- All Implemented Interfaces:
- DynaClass
 Implements DynaClass to create an in-memory collection of DynaBeans representing the results of an SQL query. Once the DynaClass
 instance has been created, the JDBC ResultSet and Statement on which it is based can be closed, and the underlying Connection can be
 returned to its connection pool (if you are using one).
 
The normal usage pattern is something like:
   Connection conn = ...;  // Acquire connection from pool
   Statement stmt = conn.createStatement();
   ResultSet rs = stmt.executeQuery("SELECT ...");
   RowSetDynaClass rsdc = new RowSetDynaClass(rs);
   rs.close();
   stmt.close();
   ...;                    // Return connection to pool
   List rows = rsdc.getRows();
   ...;                   // Process the rows as desired
 
 
 Each column in the result set will be represented as a DynaBean property of the corresponding name (optionally forced to lower case for portability).
 There will be one DynaBean in the List</code> returned by <code>getRows() for each row in the original ResultSet.
 
 In general, instances of RowSetDynaClass can be serialized and deserialized, which will automatically include the list of DynaBeans
 representing the data content. The only exception to this rule would be when the underlying property values that were copied from the ResultSet
 originally cannot themselves be serialized. Therefore, a RowSetDynaClass makes a very convenient mechanism for transporting data sets to remote
 Java-based application components.
 
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected intLimits the size of the returned list.protected booleanFlag defining whether column names should be lower cased when converted to property names.protected DynaProperty[]The set of dynamic properties that are part of thisDynaClass.protected Map<String, DynaProperty> The set of dynamic properties that are part of thisDynaClass, keyed by the property name.The list ofDynaBeans representing the contents of the originalResultSeton which thisRowSetDynaClasswas based.
- 
Constructor SummaryConstructorsConstructorDescriptionRowSetDynaClass(ResultSet resultSet) Constructs a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, boolean lowerCase) Constructs a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, boolean lowerCase, boolean useColumnLabel) Constructs a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, boolean lowerCase, int limit) Constructs a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, boolean lowerCase, int limit, boolean useColumnLabel) Constructs a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, int limit) Constructs a newRowSetDynaClassfor the specifiedResultSet.
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidprotected DynaBeanCreate and return a newDynaBeaninstance to be used for representing a row in the underlying result set.protected DynaPropertycreateDynaProperty(ResultSetMetaData metadata, int i) Factory method to create a new DynaProperty for the given index into the result set metadata.protected StringgetColumnName(String name) Gets the table column name for the specified property name.Gets an array ofPropertyDescriptorfor the properties currently defined in this DynaClass.getDynaProperty(String name) Gets a property descriptor for the specified property, if it exists; otherwise, returnnull.getName()Gets the name of this DynaClass (analogous to thegetName()</code> method of <code>java.lang.Class, which allows the sameDynaClassimplementation class to support different dynamic classes, with different sets of properties.protected ObjectGets a column value from aResultSetfor the specified name.getRows()Gets aListcontaining theDynaBeans that represent the contents of eachRowfrom theResultSetthat was the basis of thisRowSetDynaClassinstance.protected voidintrospect(ResultSet resultSet) Introspect the metadata associated with our result set, and populate theproperties</code> and <code>propertiesMapinstance variables.protected Class<?> Loads and returns theClassof the given name.Instantiate and return a new DynaBean instance, associated with this DynaClass.voidsetUseColumnLabel(boolean useColumnLabel) Sets whether the column label or name should be used for the property name.
- 
Field Details- 
limitLimits the size of the returned list. The call to getRows()will return at most limit number of rows. If less than or equal to 0, does not limit the size of the result.
- 
rowsThe list of DynaBeans representing the contents of the originalResultSeton which thisRowSetDynaClasswas based.
- 
lowerCaseprotected boolean lowerCaseFlag defining whether column names should be lower cased when converted to property names. 
- 
propertiesThe set of dynamic properties that are part of this DynaClass.
- 
propertiesMapThe 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 thepropertieslist.
 
- 
- 
Constructor Details- 
RowSetDynaClassConstructs a new RowSetDynaClassfor the specifiedResultSet. The property names corresponding to column names in the result set will be lower cased.- Parameters:
- resultSet- The result set to be wrapped
- Throws:
- NullPointerException- if- resultSetis- null
- SQLException- if the metadata for this result set cannot be introspected
 
- 
RowSetDynaClassConstructs a new IfRowSetDynaClassfor the specifiedResultSet. The property names corresponding to the column names in the result set will be lower cased or not, depending on the specifiedlowerCasevalue.limit</code> is not less than 0, max <code>limitnumber of rows will be copied into the resultset.- Parameters:
- resultSet- The result set to be wrapped
- lowerCase- Should property names be lower cased?
- Throws:
- NullPointerException- if- resultSetis- null
- SQLException- if the metadata for this result set cannot be introspected
 
- 
RowSetDynaClasspublic RowSetDynaClass(ResultSet resultSet, boolean lowerCase, boolean useColumnLabel) throws SQLException Constructs a new RowSetDynaClassfor the specifiedResultSet. The property names corresponding to the column names in the result set will be lower cased or not, depending on the specifiedlowerCasevalue.WARNING - If you specify falseforlowerCase, 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?
- useColumnLabel- true if the column label should be used, otherwise false
- Throws:
- NullPointerException- if- resultSetis- null
- SQLException- if the metadata for this result set cannot be introspected
- Since:
- 1.8.3
 
- 
RowSetDynaClassConstructs a new RowSetDynaClassfor the specifiedResultSet. The property names corresponding to the column names in the result set will be lower cased or not, depending on the specifiedlowerCasevalue.WARNING - If you specify falseforlowerCase, 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?
- limit- Maximum limit for the- Listof- DynaBean
- Throws:
- NullPointerException- if- resultSetis- null
- SQLException- if the metadata for this result set cannot be introspected
 
- 
RowSetDynaClasspublic RowSetDynaClass(ResultSet resultSet, boolean lowerCase, int limit, boolean useColumnLabel) throws SQLException Constructs a new RowSetDynaClassfor the specifiedResultSet. The property names corresponding to the column names in the result set will be lower cased or not, depending on the specifiedlowerCasevalue.WARNING - If you specify falseforlowerCase, 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?
- limit- Maximum limit for the- Listof- DynaBean
- useColumnLabel- true if the column label should be used, otherwise false
- Throws:
- NullPointerException- if- resultSetis- null
- SQLException- if the metadata for this result set cannot be introspected
- Since:
- 1.8.3
 
- 
RowSetDynaClassConstructs a new IfRowSetDynaClassfor the specifiedResultSet. The property names corresponding to column names in the result set will be lower cased.limit</code> is not less than 0, max <code>limitnumber of rows will be copied into the list.- Parameters:
- resultSet- The result set to be wrapped
- limit- The maximum for the size of the result.
- Throws:
- NullPointerException- if- resultSetis- null
- SQLException- if the metadata for this result set cannot be introspected
 
 
- 
- 
Method Details- 
copyCopy the column values for each row in the specified ResultSetinto a newly createdDynaBean, and add this bean to the list ofDynaBeans that will later by returned by a call togetRows().- Parameters:
- resultSet- The- ResultSetwhose data is to be copied
- Throws:
- SQLException- if an error is encountered copying the data
 
- 
createDynaBeanCreate and return a new DynaBeaninstance to be used for representing a row in the underlying result set.- Returns:
- A new DynaBeaninstance
 
- 
getRowsGets a Listcontaining theDynaBeans that represent the contents of eachRowfrom theResultSetthat was the basis of thisRowSetDynaClassinstance. TheseDynaBeans are disconnected from the database itself, so there is no problem with modifying the contents of the list, or the values of the properties of theseDynaBeans. However, it is the application's responsibility to persist any such changes back to the database, if it so desires.- Returns:
- A ListofDynaBeaninstances
 
- 
createDynaPropertyFactory method to create a new DynaProperty for the given index into the result set metadata. - Parameters:
- metadata- is the result set metadata
- i- is the column index in the metadata
- Returns:
- the newly created DynaProperty instance
- Throws:
- SQLException- If an error occurs accessing the SQL metadata
 
- 
getColumnNameGets the table column name for the specified property name.- Parameters:
- name- The property name
- Returns:
- The column name (which can be different if the lowerCase option is used).
 
- 
getDynaPropertiesGets an array of PropertyDescriptorfor the properties currently defined in this DynaClass. If no properties are defined, a zero-length array will be returned.- Specified by:
- getDynaPropertiesin interface- DynaClass
- Returns:
- the set of properties for this DynaClass
 
- 
getDynaPropertyGets a property descriptor for the specified property, if it exists; otherwise, return null.- Specified by:
- getDynaPropertyin interface- DynaClass
- Parameters:
- name- Name of the dynamic property for which a descriptor is requested
- Returns:
- The descriptor for the specified property
- Throws:
- IllegalArgumentException- if no property name is specified
 
- 
getNameGets the name of this DynaClass (analogous to the getName()</code> method of <code>java.lang.Class, which allows the sameDynaClassimplementation class to support different dynamic classes, with different sets of properties.
- 
getObjectGets a column value from aResultSetfor the specified name.- Parameters:
- resultSet- The result set
- name- The property name
- Returns:
- The value
- Throws:
- SQLException- if an error occurs
 
- 
introspectIntrospect the metadata associated with our result set, and populate the properties</code> and <code>propertiesMapinstance variables.- Parameters:
- resultSet- The- resultSetwhose metadata is to be introspected
- Throws:
- SQLException- if an error is encountered processing the result set metadata
 
- 
loadClassLoads and returns the Classof the given name. By default, a load from the thread context class loader is attempted. If there is no such class loader, the class loader used to load this class will be utilized.- Parameters:
- className- The name of the class to load
- Returns:
- The loaded class
- Throws:
- SQLException- if an exception was thrown trying to load the specified class
 
- 
newInstanceInstantiate and return a new DynaBean instance, associated with this DynaClass. NOTE - This operation is not supported, and throws an exception. - Specified by:
- newInstancein interface- DynaClass
- Returns:
- A new DynaBeaninstance
- Throws:
- IllegalAccessException- if the Class or the appropriate constructor is not accessible
- InstantiationException- if this Class represents an abstract class, an array class, a primitive type, or void; or if instantiation fails for some other reason
 
- 
setUseColumnLabelpublic void setUseColumnLabel(boolean useColumnLabel) Sets whether the column label or name should be used for the property name.- Parameters:
- useColumnLabel- true if the column label should be used, otherwise false
 
 
-