org.springframework.jdbc.object
Class MappingSqlQuery

java.lang.Object
  org.springframework.jdbc.object.RdbmsOperation
      org.springframework.jdbc.object.SqlOperation
          org.springframework.jdbc.object.SqlQuery
              org.springframework.jdbc.object.MappingSqlQueryWithParameters
                  org.springframework.jdbc.object.MappingSqlQuery

All Implemented Interfaces:

InitializingBean

Direct Known Subclasses:

SqlFunction

public abstract class MappingSqlQuery

extends MappingSqlQueryWithParameters

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

Nested Class Summary

Nested classes inherited from class org.springframework.jdbc.object.MappingSqlQueryWithParameters

MappingSqlQueryWithParameters.ResultReaderImpl

Field Summary

Fields inherited from class org.springframework.jdbc.object.RdbmsOperation

logger

Constructor Summary

MappingSqlQuery()
Constructor to allow use as a JavaBean.

MappingSqlQuery(javax.sql.DataSource ds, java.lang.String sql)
Convenient constructor with DataSource and SQL string.

Method Summary

protected abstract java.lang.Object	mapRow(java.sql.ResultSet rs, int rowNum) Subclasses must implement this method to convert each row of the ResultSet into an object of the result type.
protected java.lang.Object	mapRow(java.sql.ResultSet rs, int rowNum, java.lang.Object[] parameters, java.util.Map context) This method is implemented to invoke the protected abstract mapRow() method, ignoring parameters.

Methods inherited from class org.springframework.jdbc.object.MappingSqlQueryWithParameters

newResultReader

Methods inherited from class org.springframework.jdbc.object.SqlQuery

execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, findObject, findObject, findObject, findObject, findObject, findObject, findObject, findObject, findObject, findObject, getRowsExpected, onCompileInternal, setRowsExpected

Methods inherited from class org.springframework.jdbc.object.SqlOperation

compileInternal, getResultSetType, isUpdatableResults, newPreparedStatementCreator, setResultSetType, setUpdatableResults

Methods inherited from class org.springframework.jdbc.object.RdbmsOperation

afterPropertiesSet, compile, declareParameter, getDeclaredParameters, getJdbcTemplate, getSql, isCompiled, setDataSource, setJdbcTemplate, setSql, setTypes, validateParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingSqlQuery

public MappingSqlQuery()

Constructor to allow use as a JavaBean.

MappingSqlQuery

public MappingSqlQuery(javax.sql.DataSource ds,
                       java.lang.String sql)

Convenient constructor with DataSource and SQL string.

Parameters:

ds - DataSource to use to obtain connections

sql - SQL to run

Method Detail

mapRow

protected final java.lang.Object mapRow(java.sql.ResultSet rs,
                                        int rowNum,
                                        java.lang.Object[] parameters,
                                        java.util.Map context)
                                 throws java.sql.SQLException

This method is implemented to invoke the protected abstract mapRow() method, ignoring parameters.

Specified by:

mapRow in class MappingSqlQueryWithParameters

Parameters:

rs - 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:

MappingSqlQueryWithParameters.mapRow(ResultSet, int, Object[], Map)

mapRow

protected abstract java.lang.Object 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 - 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 fail to catch SQLExceptions.