net.sf.jabb.util.db

Class ResultSetUtility

java.lang.Object

net.sf.jabb.util.db.ResultSetUtility

public class ResultSetUtility
extends Object

An utility to convert ResultSet to something else, such like dynamically generated beans. When mapping column labels/names to property names, by default, non-ascii characters will be removed and only first letter of the words will be capitalized except for the first letter of the property names which will be in lower case. For example, THIS_IS_1ST_COLUMN_$$ will become thisIs1stColumn. Values of the properties are got from ResultSet.getObject() method.

Author:

james.hu

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<ResultSetMetaData,Class<?>>	beanClasses
protected Map<String,String>	columnToPropertyOverrides

Constructor Summary

Constructors

Constructor and Description
ResultSetUtility() Default constructor
ResultSetUtility(Map<String,String> columnToPropertyOverrides) Constructor allows overriding of column to property name mapping

Method Summary

Modifier and Type	Method and Description
protected Class<?>	buildBeanClass(ResultSetMetaData rsmd, Map<String,ColumnMetaData> columnToPropertyMappings)
String	columnLabelOrName(ResultSetMetaData rsmd, int col) Get the label or name of a column
protected String	columnNameToPropertyName(String columnName) Convert column name to property name, for example, THIS_IS_1ST_COLUMN_$$ will become thisIs1stColumn
protected String	columnToPropertyName(ResultSetMetaData rsmd, int col) Convert column name to property name for a column, for example, THIS_IS_1ST_COLUMN_$$ will become thisIs1stColumn
List<?>	convertAllToDynamicBeans(ResultSet rs) Convert all rows of the ResultSet to a list of beans of a dynamically generated class.
List<Map<String,Object>>	convertAllToMaps(ResultSet rs) Convert all rows of the ResultSet to a Map.
List<Map<String,Object>>	convertAllToMaps(ResultSet rs, Map<String,ColumnMetaData> alreadyDeterminedMappings) Convert all rows of the ResultSet to a Map.
Object	convertToDynamicBean(ResultSet rs) Convert current row of the ResultSet to a bean of a dynamically generated class.
Map<String,Object>	convertToMap(ResultSet rs) Convert current row of the ResultSet to a Map.
Map<String,Object>	convertToMap(ResultSet rs, Map<String,ColumnMetaData> alreadyDeterminedMappings)
Map<String,ColumnMetaData>	createColumnToPropertyMappings(ResultSetMetaData rsmd) To determine the final column to property mappings.
protected Class<?>	reuseOrBuildBeanClass(ResultSetMetaData rsmd, Map<String,ColumnMetaData> columnToPropertyMappings)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

columnToPropertyOverrides

protected Map<String,String> columnToPropertyOverrides

beanClasses

protected Map<ResultSetMetaData,Class<?>> beanClasses

Constructor Detail

ResultSetUtility

public ResultSetUtility(Map<String,String> columnToPropertyOverrides)

Constructor allows overriding of column to property name mapping

Parameters:

columnToPropertyOverrides - the keys are column names/labels, and the values are property names

ResultSetUtility

public ResultSetUtility()

Default constructor

Method Detail

convertToMap

public Map<String,Object> convertToMap(ResultSet rs)
                                throws SQLException

Convert current row of the ResultSet to a Map. The keys of the Map are property names transformed from column names.

Parameters:

rs -

Returns:

Throws:

SQLException

convertToMap

public Map<String,Object> convertToMap(ResultSet rs,
                                       Map<String,ColumnMetaData> alreadyDeterminedMappings)
                                throws SQLException

Throws:

SQLException

convertAllToMaps

public List<Map<String,Object>> convertAllToMaps(ResultSet rs)
                                          throws SQLException

Convert all rows of the ResultSet to a Map. The keys of the Map are property names transformed from column names.

Parameters:

rs -

Returns:

Throws:

SQLException

convertAllToMaps

public List<Map<String,Object>> convertAllToMaps(ResultSet rs,
                                                 Map<String,ColumnMetaData> alreadyDeterminedMappings)
                                          throws SQLException

Convert all rows of the ResultSet to a Map. The keys of the Map are property names transformed from column names.

Parameters:

rs -

alreadyDeterminedMappings -

Returns:

Throws:

SQLException

convertToDynamicBean

public Object convertToDynamicBean(ResultSet rs)
                            throws SQLException

Convert current row of the ResultSet to a bean of a dynamically generated class. It requires CGLIB.

Parameters:

rs - the ResultSet

Returns:

a bean of a dynamically generated class

Throws:

SQLException

convertAllToDynamicBeans

public List<?> convertAllToDynamicBeans(ResultSet rs)
                                 throws SQLException

Convert all rows of the ResultSet to a list of beans of a dynamically generated class. It requires CGLIB.

Parameters:

rs - the ResultSet

Returns:

a list of beans

Throws:

SQLException

reuseOrBuildBeanClass

protected Class<?> reuseOrBuildBeanClass(ResultSetMetaData rsmd,
                                         Map<String,ColumnMetaData> columnToPropertyMappings)
                                  throws SQLException

Parameters:

rsmd -

columnToPropertyMappings - It must have already been populated for all the columns

Returns:

Throws:

SQLException

buildBeanClass

protected Class<?> buildBeanClass(ResultSetMetaData rsmd,
                                  Map<String,ColumnMetaData> columnToPropertyMappings)
                           throws SQLException

Parameters:

rsmd -

columnToPropertyMappings - It must have already been populated for all the columns

Returns:

Throws:

SQLException

createColumnToPropertyMappings

public Map<String,ColumnMetaData> createColumnToPropertyMappings(ResultSetMetaData rsmd)
                                                          throws SQLException

To determine the final column to property mappings.

Parameters:

rsmd -

Returns:

the mapping that already applied overridden

Throws:

SQLException

columnNameToPropertyName

protected String columnNameToPropertyName(String columnName)

Convert column name to property name, for example, THIS_IS_1ST_COLUMN_$$ will become thisIs1stColumn

Parameters:

columnName - label or name of the column

Returns:

for example, THIS_IS_1ST_COLUMN_$$ will become thisIs1stColumn

columnToPropertyName

protected String columnToPropertyName(ResultSetMetaData rsmd,
                                      int col)
                               throws SQLException

Convert column name to property name for a column, for example, THIS_IS_1ST_COLUMN_$$ will become thisIs1stColumn

Parameters:

rsmd - the metadata

col - the column number

Returns:

for example, THIS_IS_1ST_COLUMN_$$ will become thisIs1stColumn

Throws:

SQLException

columnLabelOrName

public String columnLabelOrName(ResultSetMetaData rsmd,
                                int col)
                         throws SQLException

Get the label or name of a column

Parameters:

rsmd -

col -

Returns:

Throws:

SQLException