public class

BeanPropertyRowMapper

extends Object
implements RowMapper<T>
java.lang.Object
   ↳ org.springframework.jdbc.core.BeanPropertyRowMapper<T>
Known Direct Subclasses

Class Overview

RowMapper implementation that converts a row into a new instance of the specified mapped target class. The mapped target class must be a top-level class and it must have a default or no-arg constructor.

Column values are mapped based on matching the column name as obtained from result set metadata to public setters for the corresponding properties. The names are matched either directly or by transforming a name separating the parts with underscores to the same name using "camel" case.

Mapping is provided for fields in the target class for many common types, e.g.: String, boolean, Boolean, byte, Byte, short, Short, int, Integer, long, Long, float, Float, double, Double, BigDecimal, java.util.Date, etc.

To facilitate mapping between columns and fields that don't have matching names, try using column aliases in the SQL statement like "select fname as first_name from customer".

For 'null' values read from the databasem, we will attempt to call the setter, but in the case of Java primitives, this causes a TypeMismatchException. This class can be configured (using the primitivesDefaultedForNullValue property) to trap this exception and use the primitives default value. Be aware that if you use the values from the generated bean to update the database the primitive value will have been set to the primitive's default value instead of null.

Please note that this class is designed to provide convenience rather than high performance. For best performance consider using a custom RowMapper.

Summary

Fields
protected final Log logger Logger available to subclasses
Public Constructors
BeanPropertyRowMapper()
Create a new BeanPropertyRowMapper for bean-style configuration.
BeanPropertyRowMapper(Class<T> mappedClass)
Create a new BeanPropertyRowMapper, accepting unpopulated properties in the target bean.
BeanPropertyRowMapper(Class<T> mappedClass, boolean checkFullyPopulated)
Create a new BeanPropertyRowMapper.
Public Methods
final Class<T> getMappedClass()
Get the class that we are mapping to.
boolean isCheckFullyPopulated()
Return whether we're strictly validating that all bean properties have been mapped from corresponding database fields.
boolean isPrimitivesDefaultedForNullValue()
Return whether we're defaulting Java primitives in the case of mapping a null value from corresponding database fields.
T mapRow(ResultSet rs, int rowNumber)
Extract the values for all columns in the current row.
static <T> BeanPropertyRowMapper<T> newInstance(Class<T> mappedClass)
Static factory method to create a new BeanPropertyRowMapper (with the mapped class specified only once).
void setCheckFullyPopulated(boolean checkFullyPopulated)
Set whether we're strictly validating that all bean properties have been mapped from corresponding database fields.
void setMappedClass(Class<T> mappedClass)
Set the class that each row should be mapped to.
void setPrimitivesDefaultedForNullValue(boolean primitivesDefaultedForNullValue)
Set whether we're defaulting Java primitives in the case of mapping a null value from corresponding database fields.
Protected Methods
Object getColumnValue(ResultSet rs, int index, PropertyDescriptor pd)
Retrieve a JDBC object value for the specified column.
void initBeanWrapper(BeanWrapper bw)
Initialize the given BeanWrapper to be used for row mapping.
void initialize(Class<T> mappedClass)
Initialize the mapping metadata for the given class.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.jdbc.core.RowMapper

Fields

protected final Log logger

Logger available to subclasses

Public Constructors

public BeanPropertyRowMapper ()

Create a new BeanPropertyRowMapper for bean-style configuration.

See Also

public BeanPropertyRowMapper (Class<T> mappedClass)

Create a new BeanPropertyRowMapper, accepting unpopulated properties in the target bean.

Consider using the newInstance(Class) factory method instead, which allows for specifying the mapped type once only.

Parameters
mappedClass the class that each row should be mapped to

public BeanPropertyRowMapper (Class<T> mappedClass, boolean checkFullyPopulated)

Create a new BeanPropertyRowMapper.

Parameters
mappedClass the class that each row should be mapped to
checkFullyPopulated whether we're strictly validating that all bean properties have been mapped from corresponding database fields

Public Methods

public final Class<T> getMappedClass ()

Get the class that we are mapping to.

public boolean isCheckFullyPopulated ()

Return whether we're strictly validating that all bean properties have been mapped from corresponding database fields.

public boolean isPrimitivesDefaultedForNullValue ()

Return whether we're defaulting Java primitives in the case of mapping a null value from corresponding database fields.

public T mapRow (ResultSet rs, int rowNumber)

Extract the values for all columns in the current row.

Utilizes public setters and result set metadata.

Parameters
rs the ResultSet to map (pre-initialized for the current row)
rowNumber the number of the current row
Returns
  • the result object for the current row
Throws
SQLException
See Also
  • java.sql.ResultSetMetaData

public static BeanPropertyRowMapper<T> newInstance (Class<T> mappedClass)

Static factory method to create a new BeanPropertyRowMapper (with the mapped class specified only once).

Parameters
mappedClass the class that each row should be mapped to

public void setCheckFullyPopulated (boolean checkFullyPopulated)

Set whether we're strictly validating that all bean properties have been mapped from corresponding database fields.

Default is false, accepting unpopulated properties in the target bean.

public void setMappedClass (Class<T> mappedClass)

Set the class that each row should be mapped to.

public void setPrimitivesDefaultedForNullValue (boolean primitivesDefaultedForNullValue)

Set whether we're defaulting Java primitives in the case of mapping a null value from corresponding database fields.

Default is false, throwing an exception when nulls are mapped to Java primitives.

Protected Methods

protected Object getColumnValue (ResultSet rs, int index, PropertyDescriptor pd)

Retrieve a JDBC object value for the specified column.

The default implementation calls getResultSetValue(java.sql.ResultSet, int, Class). Subclasses may override this to check specific value types upfront, or to post-process values return from getResultSetValue.

Parameters
rs is the ResultSet holding the data
index is the column index
pd the bean property that each result object is expected to match (or null if none specified)
Returns
  • the Object value
Throws
SQLException in case of extraction failure
See Also

protected void initBeanWrapper (BeanWrapper bw)

Initialize the given BeanWrapper to be used for row mapping. To be called for each row.

The default implementation is empty. Can be overridden in subclasses.

Parameters
bw the BeanWrapper to initialize

protected void initialize (Class<T> mappedClass)

Initialize the mapping metadata for the given class.

Parameters
mappedClass the mapped class.