org.springframework.jdbc.object

Class MappingSqlQuery<T>

  • Type Parameters:
    T - the result type
    All Implemented Interfaces:
    InitializingBean
    Direct Known Subclasses:
    SqlFunction


    public abstract class MappingSqlQuery<T>
    extends MappingSqlQueryWithParameters<T>
    Reusable query in which concrete subclasses must implement the abstract mapRow(ResultSet, int) method to convert each row of the JDBC ResultSet into an object.

    Simplifies MappingSqlQueryWithParameters API by dropping parameters and context. Most subclasses won't care about parameters. If you don't use contextual information, subclass this instead of MappingSqlQueryWithParameters.

    Author:
    Rod Johnson, Thomas Risberg, Jean-Pierre Pawlak
    See Also:
    MappingSqlQueryWithParameters
    • Constructor Detail

      • MappingSqlQuery

        public MappingSqlQuery()
        Constructor that allows use as a JavaBean.
      • MappingSqlQuery

        public MappingSqlQuery(javax.sql.DataSource ds,
                               java.lang.String sql)
        Convenient constructor with DataSource and SQL string.
        Parameters:
        ds - the DataSource to use to obtain connections
        sql - the SQL to run
    • Method Detail

      • mapRow

        @Nullable
        protected final T mapRow(java.sql.ResultSet rs,
                                           int rowNum,
                                           @Nullable
                                           java.lang.Object[] parameters,
                                           @Nullable
                                           java.util.Map<?,?> context)
                                    throws java.sql.SQLException
        This method is implemented to invoke the simpler mapRow template method, ignoring parameters.
        Specified by:
        mapRow in class MappingSqlQueryWithParameters<T>
        Parameters:
        rs - the ResultSet we're working through
        rowNum - row number (from 0) we're up to
        parameters - to the query (passed to the execute() method). Subclasses are rarely interested in these. It can be null if there are no parameters.
        context - passed to the execute() method. It can be null if no contextual information is need.
        Returns:
        an object of the result type
        Throws:
        java.sql.SQLException - if there's an error extracting data. Subclasses can simply not catch SQLExceptions, relying on the framework to clean up.
        See Also:
        mapRow(ResultSet, int)
      • mapRow

        @Nullable
        protected abstract T mapRow(java.sql.ResultSet rs,
                                              int rowNum)
                                       throws java.sql.SQLException
        Subclasses must implement this method to convert each row of the ResultSet into an object of the result type.

        Subclasses of this class, as opposed to direct subclasses of MappingSqlQueryWithParameters, don't need to concern themselves with the parameters to the execute method of the query object.

        Parameters:
        rs - the ResultSet we're working through
        rowNum - row number (from 0) we're up to
        Returns:
        an object of the result type
        Throws:
        java.sql.SQLException - if there's an error extracting data. Subclasses can simply not catch SQLExceptions, relying on the framework to clean up.