java.lang.Object | |
↳ | org.apache.commons.beanutils.RowSetDynaClass |
Implementation of DynaClass
that creates an in-memory collection
of DynaBean
s 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
DynaBean
s 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.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
limit | Limits the size of the returned list. |
||||||||||
lowerCase | Flag defining whether column names should be lower cased when converted to property names. |
||||||||||
properties | The set of dynamic properties that are part of this
|
||||||||||
propertiesMap | The set of dynamic properties that are part of this
|
||||||||||
rows | The list of |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct a new | |||||||||||
Construct a new | |||||||||||
Construct a new | |||||||||||
Construct a new | |||||||||||
Construct a new | |||||||||||
Construct a new |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return an array of | |||||||||||
Return a property descriptor for the specified property, if it
exists; otherwise, return | |||||||||||
Return the name of this DynaClass (analogous to the
| |||||||||||
Return a | |||||||||||
Instantiate and return a new DynaBean instance, associated with this DynaClass. | |||||||||||
Set whether the column label or name should be used for the property name.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create and return a new | |||||||||||
Factory method to create a new DynaProperty for the given index into the result set metadata. | |||||||||||
Get the table column name for the specified property name.
| |||||||||||
Get a column value from a
ResultSet for the specified name. | |||||||||||
Introspect the metadata associated with our result set, and populate
the | |||||||||||
Loads and returns the |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.apache.commons.beanutils.DynaClass
|
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.
Flag defining whether column names should be lower cased when converted to property names.
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.
The list of DynaBean
s representing the contents of
the original ResultSet
on which this
RowSetDynaClass
was based.
Construct a new RowSetDynaClass
for the specified
ResultSet
. The property names corresponding
to column names in the result set will be lower cased.
resultSet | The result set to be wrapped |
---|
NullPointerException | if resultSet
is null |
---|---|
SQLException | if the metadata for this result set cannot be introspected |
Construct a new RowSetDynaClass
for the specified
ResultSet
. The property names corresponding
to column names in the result set will be lower cased.
limit
is not less than 0, max limit
number of rows will be copied into the list. resultSet | The result set to be wrapped |
---|---|
limit | The maximum for the size of the result. |
NullPointerException | if resultSet
is null |
---|---|
SQLException | if the metadata for this result set cannot be introspected |
Construct a new RowSetDynaClass
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.
limit
is not less than 0, max limit
number of rows will be copied into the resultset. resultSet | The result set to be wrapped |
---|---|
lowerCase | Should property names be lower cased? |
NullPointerException | if resultSet
is null |
---|---|
SQLException | if the metadata for this result set cannot be introspected |
Construct a new RowSetDynaClass
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.
resultSet | The result set to be wrapped |
---|---|
lowerCase | Should property names be lower cased? |
limit | Maximum limit for the List of DynaBean |
NullPointerException | if resultSet
is null |
---|---|
SQLException | if the metadata for this result set cannot be introspected |
Construct a new RowSetDynaClass
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.
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 |
NullPointerException | if resultSet
is null |
---|---|
SQLException | if the metadata for this result set cannot be introspected |
Construct a new RowSetDynaClass
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.
resultSet | The result set to be wrapped |
---|---|
lowerCase | Should property names be lower cased? |
limit | Maximum limit for the List of DynaBean |
useColumnLabel | true if the column label should be used, otherwise false |
NullPointerException | if resultSet
is null |
---|---|
SQLException | if the metadata for this result set cannot be introspected |
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.
Return a property descriptor for the specified property, if it
exists; otherwise, return null
.
name | Name of the dynamic property for which a descriptor is requested |
---|
IllegalArgumentException | if no property name is specified |
---|
Return the name of this DynaClass (analogous to the
getName()
method of java.lang.Class
DynaClass implementation class to support
different dynamic classes, with different sets of properties.
Return a List
containing the DynaBean
s that
represent the contents of each Row
from the
ResultSet
that was the basis of this
RowSetDynaClass
instance. These DynaBean
s 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 these DynaBean
s. However, it is the application's
responsibility to persist any such changes back to the database,
if it so desires.
List
of DynaBean
instances
Instantiate and return a new DynaBean instance, associated with this DynaClass. NOTE - This operation is not supported, and throws an exception.
DynaBean
instanceIllegalAccessException | 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 |
Set whether the column label or name should be used for the property name.
useColumnLabel | true if the column label should be used, otherwise false |
---|
Copy the column values for each row in the specified
ResultSet
into a newly created DynaBean
, and add
this bean to the list of DynaBean
s that will later by
returned by a call to getRows()
.
resultSet | The ResultSet whose data is to be
copied |
---|
SQLException | if an error is encountered copying the data |
---|
Create and return a new DynaBean
instance to be used for
representing a row in the underlying result set.
DynaBean
instance
Factory method to create a new DynaProperty for the given index into the result set metadata.
metadata | is the result set metadata |
---|---|
i | is the column index in the metadata |
SQLException | If an error occurs accessing the SQL metadata |
---|
Get the table column name for the specified property name.
name | The property name |
---|
Get a column value from a ResultSet
for the specified name.
resultSet | The result set |
---|---|
name | The property name |
SQLException | if an error occurs |
---|
Introspect the metadata associated with our result set, and populate
the properties
and propertiesMap
instance
variables.
resultSet | The resultSet whose metadata is to
be introspected |
---|
SQLException | if an error is encountered processing the result set metadata |
---|
Loads and returns the Class
of 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.
className | The name of the class to load |
---|
SQLException | if an exception was thrown trying to load the specified class |
---|