public abstract class

UpdatableSqlQuery

extends SqlQuery<T>
java.lang.Object
   ↳ org.springframework.jdbc.object.RdbmsOperation
     ↳ org.springframework.jdbc.object.SqlOperation
       ↳ org.springframework.jdbc.object.SqlQuery<T>
         ↳ org.springframework.jdbc.object.UpdatableSqlQuery<T>

Class Overview

Reusable RDBMS query in which concrete subclasses must implement the abstract updateRow(ResultSet, int, context) method to update each row of the JDBC ResultSet and optionally map contents into an object.

Subclasses can be constructed providing SQL, parameter types and a DataSource. SQL will often vary between subclasses.

See Also

Summary

Nested Classes
class UpdatableSqlQuery.RowMapperImpl Implementation of RowMapper that calls the enclosing class's updateRow() method for each row. 
[Expand]
Inherited Fields
From class org.springframework.jdbc.object.RdbmsOperation
Public Constructors
UpdatableSqlQuery()
Constructor to allow use as a JavaBean
UpdatableSqlQuery(DataSource ds, String sql)
Convenient constructor with DataSource and SQL string.
Protected Methods
RowMapper<T> newRowMapper(Object[] parameters, Map context)
Implementation of the superclass template method.
abstract T updateRow(ResultSet rs, int rowNum, Map context)
Subclasses must implement this method to update each row of the ResultSet and optionally create object of the result type.
[Expand]
Inherited Methods
From class org.springframework.jdbc.object.SqlQuery
From class org.springframework.jdbc.object.SqlOperation
From class org.springframework.jdbc.object.RdbmsOperation
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean

Public Constructors

public UpdatableSqlQuery ()

Constructor to allow use as a JavaBean

public UpdatableSqlQuery (DataSource ds, String sql)

Convenient constructor with DataSource and SQL string.

Parameters
ds DataSource to use to get connections
sql SQL to run

Protected Methods

protected RowMapper<T> newRowMapper (Object[] parameters, Map context)

Implementation of the superclass template method. This invokes the subclass's implementation of the updateRow() method.

Parameters
parameters the parameters to the execute() method, in case subclass is interested; may be null if there were no parameters.
context contextual information passed to the mapRow callback method. The JDBC operation itself doesn't rely on this parameter, but it can be useful for creating the objects of the result list.

protected abstract T updateRow (ResultSet rs, int rowNum, Map context)

Subclasses must implement this method to update each row of the ResultSet and optionally create object of the result type.

Parameters
rs ResultSet we're working through
rowNum row number (from 0) we're up to
context passed to the execute() method. It can be null if no contextual information is need. If you need to pass in data for each row, you can pass in a HashMap with the primary key of the row being the key for the HashMap. That way it is easy to locate the updates for each row
Returns
  • an object of the result type
Throws
SQLException if there's an error updateing data. Subclasses can simply not catch SQLExceptions, relying on the framework to clean up.