Class RowSetDynaClass
- java.lang.Object
-
- org.apache.commons.beanutils.JDBCDynaClass
-
- org.apache.commons.beanutils.RowSetDynaClass
-
- All Implemented Interfaces:
java.io.Serializable
,DynaClass
public class RowSetDynaClass extends JDBCDynaClass implements DynaClass, java.io.Serializable
Implementation of
DynaClass
that creates an in-memory collection ofDynaBean
s representing the results of an SQL query. Once theDynaClass
instance has been created, the JDBCResultSet
andStatement
on which it is based can be closed, and the underlyingConnection
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 oneDynaBean
in theList
returned bygetRows()
for each row in the originalResultSet
.In general, instances of
RowSetDynaClass
can be serialized and deserialized, which will automatically include the list ofDynaBean
s representing the data content. The only exception to this rule would be when the underlying property values that were copied from theResultSet
originally cannot themselves be serialized. Therefore, aRowSetDynaClass
makes a very convenient mechanism for transporting data sets to remote Java-based application components.- Version:
- $Id: RowSetDynaClass.java 1540186 2013-11-08 21:08:30Z oheger $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected int
limit
Limits the size of the returned list.protected java.util.List<DynaBean>
rows
The list ofDynaBean
s representing the contents of the originalResultSet
on which thisRowSetDynaClass
was based.-
Fields inherited from class org.apache.commons.beanutils.JDBCDynaClass
lowerCase, properties, propertiesMap
-
-
Constructor Summary
Constructors Constructor Description RowSetDynaClass(java.sql.ResultSet resultSet)
Construct a newRowSetDynaClass
for the specifiedResultSet
.RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase)
Construct a newRowSetDynaClass
for the specifiedResultSet
.RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase, boolean useColumnLabel)
Construct a newRowSetDynaClass
for the specifiedResultSet
.RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase, int limit)
Construct a newRowSetDynaClass
for the specifiedResultSet
.RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase, int limit, boolean useColumnLabel)
Construct a newRowSetDynaClass
for the specifiedResultSet
.RowSetDynaClass(java.sql.ResultSet resultSet, int limit)
Construct a newRowSetDynaClass
for the specifiedResultSet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
copy(java.sql.ResultSet resultSet)
protected DynaBean
createDynaBean()
Create and return a newDynaBean
instance to be used for representing a row in the underlying result set.java.util.List<DynaBean>
getRows()
Return aList
containing theDynaBean
s that represent the contents of eachRow
from theResultSet
that was the basis of thisRowSetDynaClass
instance.-
Methods inherited from class org.apache.commons.beanutils.JDBCDynaClass
createDynaProperty, getColumnName, getDynaProperties, getDynaProperty, getName, getObject, introspect, loadClass, newInstance, setUseColumnLabel
-
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
-
limit
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.
-
rows
protected java.util.List<DynaBean> rows
The list of
DynaBean
s representing the contents of the originalResultSet
on which thisRowSetDynaClass
was based.
-
-
Constructor Detail
-
RowSetDynaClass
public RowSetDynaClass(java.sql.ResultSet resultSet) throws java.sql.SQLException
Construct a new
RowSetDynaClass
for 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:
java.lang.NullPointerException
- ifresultSet
isnull
java.sql.SQLException
- if the metadata for this result set cannot be introspected
-
RowSetDynaClass
public RowSetDynaClass(java.sql.ResultSet resultSet, int limit) throws java.sql.SQLException
Construct a new
IfRowSetDynaClass
for the specifiedResultSet
. The property names corresponding to column names in the result set will be lower cased.limit
is not less than 0, maxlimit
number 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:
java.lang.NullPointerException
- ifresultSet
isnull
java.sql.SQLException
- if the metadata for this result set cannot be introspected
-
RowSetDynaClass
public RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase) throws java.sql.SQLException
Construct a new
IfRowSetDynaClass
for the specifiedResultSet
. The property names corresponding to the column names in the result set will be lower cased or not, depending on the specifiedlowerCase
value.limit
is not less than 0, maxlimit
number of rows will be copied into the resultset.- Parameters:
resultSet
- The result set to be wrappedlowerCase
- Should property names be lower cased?- Throws:
java.lang.NullPointerException
- ifresultSet
isnull
java.sql.SQLException
- if the metadata for this result set cannot be introspected
-
RowSetDynaClass
public RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase, int limit) throws java.sql.SQLException
Construct a new
RowSetDynaClass
for the specifiedResultSet
. The property names corresponding to the column names in the result set will be lower cased or not, depending on the specifiedlowerCase
value.WARNING - If you specify
false
forlowerCase
, 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 theList
ofDynaBean
- Throws:
java.lang.NullPointerException
- ifresultSet
isnull
java.sql.SQLException
- if the metadata for this result set cannot be introspected
-
RowSetDynaClass
public RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase, boolean useColumnLabel) throws java.sql.SQLException
Construct a new
RowSetDynaClass
for the specifiedResultSet
. The property names corresponding to the column names in the result set will be lower cased or not, depending on the specifiedlowerCase
value.WARNING - If you specify
false
forlowerCase
, 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:
java.lang.NullPointerException
- ifresultSet
isnull
java.sql.SQLException
- if the metadata for this result set cannot be introspected- Since:
- 1.8.3
-
RowSetDynaClass
public RowSetDynaClass(java.sql.ResultSet resultSet, boolean lowerCase, int limit, boolean useColumnLabel) throws java.sql.SQLException
Construct a new
RowSetDynaClass
for the specifiedResultSet
. The property names corresponding to the column names in the result set will be lower cased or not, depending on the specifiedlowerCase
value.WARNING - If you specify
false
forlowerCase
, 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 theList
ofDynaBean
useColumnLabel
- true if the column label should be used, otherwise false- Throws:
java.lang.NullPointerException
- ifresultSet
isnull
java.sql.SQLException
- if the metadata for this result set cannot be introspected- Since:
- 1.8.3
-
-
Method Detail
-
getRows
public java.util.List<DynaBean> getRows()
Return a
List
containing theDynaBean
s that represent the contents of eachRow
from theResultSet
that was the basis of thisRowSetDynaClass
instance. TheseDynaBean
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 theseDynaBean
s. However, it is the application's responsibility to persist any such changes back to the database, if it so desires.- Returns:
- A
List
ofDynaBean
instances
-
copy
protected void copy(java.sql.ResultSet resultSet) throws java.sql.SQLException
Copy the column values for each row in the specified
ResultSet
into a newly createdDynaBean
, and add this bean to the list ofDynaBean
s that will later by returned by a call togetRows()
.- Parameters:
resultSet
- TheResultSet
whose data is to be copied- Throws:
java.sql.SQLException
- if an error is encountered copying the data
-
-