Package org.springframework.jdbc.core

Class BeanPropertyRowMapper<T>

  • All Implemented Interfaces:
    RowMapper<T>
    public class BeanPropertyRowMapper<T>
extends Object
implements RowMapper<T>
    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 meta-data 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 database, 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 implementation.

    Since:
    2.5
    Author:
    Thomas Risberg, Juergen Hoeller

    • Field Detail

      • logger

        protected final Log logger
        Logger available to subclasses

    • Constructor Detail

      • BeanPropertyRowMapper

        public BeanPropertyRowMapper​(Class<T> mappedClass)
        Create a new BeanPropertyRowMapper, accepting unpopulated properties in the target bean.

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

        Parameters:
        mappedClass - the class that each row should be mapped to

      • BeanPropertyRowMapper

        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

    • Method Detail

      • setMappedClass

        public void setMappedClass​(Class<T> mappedClass)
        Set the class that each row should be mapped to.

      • setCheckFullyPopulated

        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.

      • isCheckFullyPopulated

        public boolean isCheckFullyPopulated()
        Return whether we're strictly validating that all bean properties have been mapped from corresponding database fields.

      • setPrimitivesDefaultedForNullValue

        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.

      • isPrimitivesDefaultedForNullValue

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

      • initialize

        protected void initialize​(Class<T> mappedClass)
        Initialize the mapping meta-data for the given class.
        Parameters:
        mappedClass - the mapped class

      • underscoreName

        protected String underscoreName​(String name)
        Convert a name in camelCase to an underscored name in lower case. Any upper case letters are converted to lower case with a preceding underscore.
        Parameters:
        name - the original name
        Returns:
        the converted name
        Since:
        4.2
        See Also:
        lowerCaseName(java.lang.String)

      • lowerCaseName

        protected String lowerCaseName​(String name)
        Convert the given name to lower case. By default, conversions will happen within the US locale.
        Parameters:
        name - the original name
        Returns:
        the converted name
        Since:
        4.2

      • mapRow

        public T mapRow​(ResultSet rs,
                int rowNumber)
         throws SQLException
        Extract the values for all columns in the current row.

        Utilizes public setters and result set meta-data.

        Specified by:
        mapRow in interface RowMapper<T>
        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 (may be null)
        Throws:
        SQLException - if a SQLException is encountered getting column values (that is, there's no need to catch SQLException)
        See Also:
        ResultSetMetaData

      • newInstance

        public static <T> 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