| java.lang.Object
 com.sourcetap.sfa.util.GenericValueListDynaClass
| GenericValueListDynaClass | | public class GenericValueListDynaClass implements DynaClass,Serializable(Code) | | 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.
author:
Craig R. McClanahan |
| fieldTypeMap | | protected static Map fieldTypeMap(Code) | | |
| limit | | protected int limit(Code) | | 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.
|
| lowerCase | | protected boolean lowerCase(Code) | | Flag defining whether column names should be lower cased when
converted to property names.
|
| properties | | protected DynaProperty properties(Code) | | The set of dynamic properties that are part of this
DynaClass .
|
| propertiesMap | | protected Map propertiesMap(Code) | | 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.
|
| rows | | protected List rows(Code) | | The list of
DynaBean s representing the contents of
the original ResultSet on which this
RowSetDynaClass was based.
|
| GenericValueListDynaClass | | public GenericValueListDynaClass(List genericValueList, List fieldsToSelect) throws GenericEntityException(Code) | | Construct a new
RowSetDynaClass for the specified
ResultSet. The property names corresponding
to column names in the result set will be not be lower cased.
Parameters:
resultSet - The result set to be wrapped
exception:
NullPointerException - if resultSetis null
exception:
GenericEntityException - if the metadata for this result setcannot be introspected |
| GenericValueListDynaClass | | public GenericValueListDynaClass(List genericValueList, List fieldsToSelect, int limit) throws GenericEntityException(Code) | | Construct a new
RowSetDynaClass for the specified
ResultSet. The property names corresponding
to column names in the result set will not be lower cased.
If limit is not less than 0, max limit
number of rows will be copied into the list.
Parameters:
resultSet - The result set to be wrapped
Parameters:
limit - The maximum for the size of the result.
exception:
NullPointerException - if resultSetis null
exception:
GenericEntityException - if the metadata for this result setcannot be introspected |
| GenericValueListDynaClass | | public GenericValueListDynaClass(List genericValueList, List fieldsToSelect, boolean lowerCase) throws GenericEntityException(Code) | | 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.
If limit is not less than 0, max limit
number of rows will be copied into the resultset.
Parameters:
resultSet - The result set to be wrapped
Parameters:
lowerCase - Should property names be lower cased?
exception:
NullPointerException - if resultSetis null
exception:
GenericEntityException - if the metadata for this result setcannot be introspected |
| GenericValueListDynaClass | | public GenericValueListDynaClass(List genericValueList, List fieldsToSelect, boolean lowerCase, int limit) throws GenericEntityException(Code) | | 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.
Parameters:
resultSet - The result set to be wrapped
Parameters:
lowerCase - Should property names be lower cased?
exception:
NullPointerException - if resultSetis null
exception:
GenericEntityException - if the metadata for this result setcannot be introspected |
| copy | | protected void copy(List genericValueList) throws GenericEntityException(Code) | | 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().
Parameters:
resultSet - The ResultSet whose data is to becopied
exception:
GenericEntityException - if an error is encountered copying the data |
| createDynaBean | | protected DynaBean createDynaBean()(Code) | | Create and return a new
DynaBean instance to be used for
representing a row in the underlying result set.
|
| createDynaProperty | | protected DynaProperty createDynaProperty(GenericDelegator delegator, ModelEntity modelEntity, String fieldName) throws GenericEntityException(Code) | | Factory method to create a new DynaProperty for the given index
into the result set metadata.
Parameters:
metadata - is the result set metadata
Parameters:
i - is the column index in the metadata the newly created DynaProperty instance |
| getDynaProperties | | public DynaProperty[] getDynaProperties()(Code) | | 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.
|
| getDynaProperty | | public DynaProperty getDynaProperty(String name)(Code) | | Return a property descriptor for the specified property, if it
exists; otherwise, return null.
Parameters:
name - Name of the dynamic property for which a descriptoris requested
exception:
IllegalArgumentException - if no property name is specified |
| getName | | public String getName()(Code) | | Return the name of this DynaClass (analogous to the
getName() method of java.lang.ClassDynaClass implementation class to support
different dynamic classes, with different sets of properties.
|
| getRows | | public List getRows()(Code) | | 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.
|
| introspect | | protected void introspect(List genericValueList) throws GenericEntityException(Code) | | Introspect the metadata associated with our result set, and populate
the properties and propertiesMap instance
variables.
Parameters:
resultSet - The resultSet whose metadata is tobe introspected
exception:
GenericEntityException - if an error is encountered processing theresult set metadata |
| loadClass | | protected Class loadClass(String className) throws GenericEntityException(Code) | | 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.
exception:
GenericEntityException - if an exception was thrown trying to loadthe specified class |
| newInstance | | public DynaBean newInstance() throws IllegalAccessException, InstantiationException(Code) | | Instantiate and return a new DynaBean instance, associated
with this DynaClass. NOTE - This operation is not
supported, and throws an exception.
exception:
IllegalAccessException - if the Class or the appropriateconstructor is not accessible
exception:
InstantiationException - if this Class represents an abstractclass, an array class, a primitive type, or void; or if instantiationfails for some other reason |
|
|