Interface RowCallbackHandler

All Known Subinterfaces:
All Known Implementing Classes:
MappingSqlQueryWithParameters.ResultReaderImpl, RowCountCallbackHandler, RowMapperResultReader, UpdatableSqlQuery.ResultReaderImpl

public interface RowCallbackHandler

Callback interface used by JdbcTemplate's query methods. Implementations of this interface perform the actual work of extracting results, but don't need to worry about exception handling. SQLExceptions will be caught and handled correctly by the JdbcTemplate class.

In contrast to a ResultSetExtractor, a RowCallbackHandler object is typically stateful: It keeps the result state within the object, to be available for later inspection. See RowCountCallbackHandler's javadoc for a usage example with JdbcTemplate.

The ResultReader subinterface allows to make a results list available in a uniform manner. JdbcTemplate's query methods will return the results list in that case, else returning null (-> result state is solely available from RowCallbackHandler object).

A convenient out-of-the-box implementation of RowCallbackHandler is the RowMapperResultReader adapter which delegates row mapping to a RowMapper. Note that a RowMapper object is typically stateless and thus reusable; just the RowMapperResultReader adapter is stateful.

Rod Johnson
See Also:
ResultSetExtractor, RowCountCallbackHandler, ResultReader, RowMapperResultReader, RowMapper

Method Summary
 void processRow(ResultSet rs)
          Implementations must implement this method to process each row of data in the ResultSet.

Method Detail


void processRow(ResultSet rs)
                throws SQLException
Implementations must implement this method to process each row of data in the ResultSet. This method should not call next() on the ResultSet, but extract the current values. Exactly what the implementation chooses to do is up to it; a trivial implementation might simply count rows, while another implementation might build an XML document.

rs - the ResultSet to process
SQLException - if a SQLException is encountered getting column values (that is, there's no need to catch SQLException)

Copyright (c) 2002-2005 The Spring Framework Project.