public class RowSetDynaClass extends JDBCDynaClass implements DynaClass, java.io.Serializable
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.
Modifier and Type | Field and Description |
---|---|
protected int |
limit
Limits the size of the returned list.
|
protected java.util.List<DynaBean> |
rows
The list of
DynaBean s representing the contents of
the original ResultSet on which this
RowSetDynaClass was based. |
lowerCase, properties, propertiesMap
Constructor and Description |
---|
RowSetDynaClass(java.sql.ResultSet resultSet)
Construct a new
RowSetDynaClass for the specified
ResultSet . |
RowSetDynaClass(java.sql.ResultSet resultSet,
boolean lowerCase)
Construct a new
RowSetDynaClass for the specified
ResultSet . |
RowSetDynaClass(java.sql.ResultSet resultSet,
boolean lowerCase,
boolean useColumnLabel)
Construct a new
RowSetDynaClass for the specified
ResultSet . |
RowSetDynaClass(java.sql.ResultSet resultSet,
boolean lowerCase,
int limit)
Construct a new
RowSetDynaClass for the specified
ResultSet . |
RowSetDynaClass(java.sql.ResultSet resultSet,
boolean lowerCase,
int limit,
boolean useColumnLabel)
Construct a new
RowSetDynaClass for the specified
ResultSet . |
RowSetDynaClass(java.sql.ResultSet resultSet,
int limit)
Construct a new
RowSetDynaClass for the specified
ResultSet . |
Modifier and Type | Method and Description |
---|---|
protected void |
copy(java.sql.ResultSet resultSet)
|
protected DynaBean |
createDynaBean()
Create and return a new
DynaBean instance to be used for
representing a row in the underlying result set. |
java.util.List<DynaBean> |
getRows()
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. |
createDynaProperty, getColumnName, getDynaProperties, getDynaProperty, getName, getObject, introspect, loadClass, newInstance, setUseColumnLabel
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDynaProperties, getDynaProperty, getName, newInstance
protected int 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.
protected java.util.List<DynaBean> rows
The list of DynaBean
s representing the contents of
the original ResultSet
on which this
RowSetDynaClass
was based.
public RowSetDynaClass(java.sql.ResultSet resultSet) throws java.sql.SQLException
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 wrappedjava.lang.NullPointerException
- if resultSet
is null
java.sql.SQLException
- if the metadata for this result set
cannot be introspectedpublic RowSetDynaClass(java.sql.ResultSet resultSet, int limit) throws java.sql.SQLException
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 wrappedlimit
- The maximum for the size of the result.java.lang.NullPointerException
- if resultSet
is null
java.sql.SQLException
- if the metadata for this result set
cannot be introspectedpublic RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase) throws java.sql.SQLException
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 wrappedlowerCase
- Should property names be lower cased?java.lang.NullPointerException
- if resultSet
is null
java.sql.SQLException
- if the metadata for this result set
cannot be introspectedpublic RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase, int limit) throws java.sql.SQLException
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 wrappedlowerCase
- Should property names be lower cased?limit
- Maximum limit for the List
of DynaBean
java.lang.NullPointerException
- if resultSet
is null
java.sql.SQLException
- if the metadata for this result set
cannot be introspectedpublic RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase, boolean useColumnLabel) throws java.sql.SQLException
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 wrappedlowerCase
- Should property names be lower cased?useColumnLabel
- true if the column label should be used, otherwise falsejava.lang.NullPointerException
- if resultSet
is null
java.sql.SQLException
- if the metadata for this result set
cannot be introspectedpublic RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase, int limit, boolean useColumnLabel) throws java.sql.SQLException
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 wrappedlowerCase
- Should property names be lower cased?limit
- Maximum limit for the List
of DynaBean
useColumnLabel
- true if the column label should be used, otherwise falsejava.lang.NullPointerException
- if resultSet
is null
java.sql.SQLException
- if the metadata for this result set
cannot be introspectedpublic java.util.List<DynaBean> getRows()
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
instancesprotected void copy(java.sql.ResultSet resultSet) throws java.sql.SQLException
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
copiedjava.sql.SQLException
- if an error is encountered copying the dataCopyright (c) 2000-2008 - Apache Software Foundation