Class RowSetDynaClass
- All Implemented Interfaces:
Serializable,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 returned by 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.
- See Also:
-
Field Summary
FieldsModifier 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 Summary
ConstructorsConstructorDescriptionRowSetDynaClass(ResultSet resultSet) Construct a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, boolean lowerCase) Construct a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, boolean lowerCase, boolean useColumnLabel) Construct a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, boolean lowerCase, int limit) Construct a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, boolean lowerCase, int limit, boolean useColumnLabel) Construct a newRowSetDynaClassfor the specifiedResultSet.RowSetDynaClass(ResultSet resultSet, int limit) Construct a newRowSetDynaClassfor the specifiedResultSet. -
Method Summary
Modifier 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) Get the table column name for the specified property name.Return an array ofProperyDescriptorsfor the properties currently defined in this DynaClass.getDynaProperty(String name) Return a property descriptor for the specified property, if it exists; otherwise, returnnull.getName()Return the name of this DynaClass (analogous to thegetName()method ofjava.lang.Class), which allows the sameDynaClassimplementation class to support different dynamic classes, with different sets of properties.protected ObjectGet a column value from aResultSetfor the specified name.getRows()Return 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 thepropertiesandpropertiesMapinstance variables.protected Class<?> Loads and returns theClassof the given name.Instantiate and return a new DynaBean instance, associated with this DynaClass.voidsetUseColumnLabel(boolean useColumnLabel) Set whether the column label or name should be used for the property name.
-
Field Details
-
limit
Limits 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. -
rows
The list of
DynaBeans representing the contents of the originalResultSeton which thisRowSetDynaClasswas based. -
lowerCase
protected boolean lowerCaseFlag defining whether column names should be lower cased when converted to property names.
-
properties
The set of dynamic properties that are part of this
DynaClass. -
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 thepropertieslist.
-
-
Constructor Details
-
RowSetDynaClass
Construct 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- ifresultSetisnullSQLException- if the metadata for this result set cannot be introspected
-
RowSetDynaClass
Construct 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.limitis not less than 0, maxlimitnumber of rows will be copied into the resultset.- Parameters:
resultSet- The result set to be wrappedlowerCase- Should property names be lower cased?- Throws:
NullPointerException- ifresultSetisnullSQLException- if the metadata for this result set cannot be introspected
-
RowSetDynaClass
public RowSetDynaClass(ResultSet resultSet, boolean lowerCase, boolean useColumnLabel) throws SQLException Construct 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 wrappedlowerCase- Should property names be lower cased?useColumnLabel- true if the column label should be used, otherwise false- Throws:
NullPointerException- ifresultSetisnullSQLException- if the metadata for this result set cannot be introspected- Since:
- 1.8.3
-
RowSetDynaClass
Construct 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 wrappedlowerCase- Should property names be lower cased?limit- Maximum limit for theListofDynaBean- Throws:
NullPointerException- ifresultSetisnullSQLException- if the metadata for this result set cannot be introspected
-
RowSetDynaClass
public RowSetDynaClass(ResultSet resultSet, boolean lowerCase, int limit, boolean useColumnLabel) throws SQLException Construct 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 wrappedlowerCase- Should property names be lower cased?limit- Maximum limit for theListofDynaBeanuseColumnLabel- true if the column label should be used, otherwise false- Throws:
NullPointerException- ifresultSetisnullSQLException- if the metadata for this result set cannot be introspected- Since:
- 1.8.3
-
RowSetDynaClass
Construct a new
IfRowSetDynaClassfor the specifiedResultSet. The property names corresponding to column names in the result set will be lower cased.limitis not less than 0, maxlimitnumber of rows will be copied into the list.- Parameters:
resultSet- The result set to be wrappedlimit- The maximum for the size of the result.- Throws:
NullPointerException- ifresultSetisnullSQLException- if the metadata for this result set cannot be introspected
-
-
Method Details
-
copy
Copy 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- TheResultSetwhose data is to be copied- Throws:
SQLException- if an error is encountered copying the data
-
createDynaBean
Create and return a new
DynaBeaninstance to be used for representing a row in the underlying result set.- Returns:
- A new
DynaBeaninstance
-
getRows
Return 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
-
createDynaProperty
Factory method to create a new DynaProperty for the given index into the result set metadata.
- Parameters:
metadata- is the result set metadatai- is the column index in the metadata- Returns:
- the newly created DynaProperty instance
- Throws:
SQLException- If an error occurs accessing the SQL metadata
-
getColumnName
Get 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).
-
getDynaProperties
Return an array of
ProperyDescriptorsfor the properties currently defined in this DynaClass. If no properties are defined, a zero-length array will be returned.- Specified by:
getDynaPropertiesin interfaceDynaClass- Returns:
- the set of properties for this DynaClass
-
getDynaProperty
Return a property descriptor for the specified property, if it exists; otherwise, return
null.- Specified by:
getDynaPropertyin interfaceDynaClass- 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
-
getName
Return the name of this DynaClass (analogous to the
getName()method ofjava.lang.Class), which allows the sameDynaClassimplementation class to support different dynamic classes, with different sets of properties. -
getObject
Get a column value from aResultSetfor the specified name.- Parameters:
resultSet- The result setname- The property name- Returns:
- The value
- Throws:
SQLException- if an error occurs
-
introspect
Introspect the metadata associated with our result set, and populate the
propertiesandpropertiesMapinstance variables.- Parameters:
resultSet- TheresultSetwhose metadata is to be introspected- Throws:
SQLException- if an error is encountered processing the result set metadata
-
loadClass
Loads 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
-
newInstance
Instantiate and return a new DynaBean instance, associated with this DynaClass. NOTE - This operation is not supported, and throws an exception.
- Specified by:
newInstancein interfaceDynaClass- Returns:
- A new
DynaBeaninstance - Throws:
IllegalAccessException- if the Class or the appropriate constructor is not accessibleInstantiationException- if this Class represents an abstract class, an array class, a primitive type, or void; or if instantiation fails for some other reason
-
setUseColumnLabel
public void setUseColumnLabel(boolean useColumnLabel) Set 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
-