SqlMapClientTemplate

Class Overview

Helper class that simplifies data access via the iBATIS com.ibatis.sqlmap.client.SqlMapClient API, converting checked SQLExceptions into unchecked DataAccessExceptions, following the org.springframework.dao exception hierarchy. Uses the same SQLExceptionTranslator mechanism as JdbcTemplate.

The main method of this class executes a callback that implements a data access action. Furthermore, this class provides numerous convenience methods that mirror com.ibatis.sqlmap.client.SqlMapExecutor's execution methods.

It is generally recommended to use the convenience methods on this template for plain query/insert/update/delete operations. However, for more complex operations like batch updates, a custom SqlMapClientCallback must be implemented, usually as anonymous inner class. For example:

 getSqlMapClientTemplate().execute(new SqlMapClientCallback() {
 	 public Object doInSqlMapClient(SqlMapExecutor executor) throws SQLException {
 		 executor.startBatch();
 		 executor.update("insertSomething", "myParamValue");
 		 executor.update("insertSomethingElse", "myOtherParamValue");
 		 executor.executeBatch();
 		 return null;
 	 }
 });

The template needs a SqlMapClient to work on, passed in via the "sqlMapClient" property. A Spring context typically uses a SqlMapClientFactoryBean to build the SqlMapClient. The template an additionally be configured with a DataSource for fetching Connections, although this is not necessary if a DataSource is specified for the SqlMapClient itself (typically through SqlMapClientFactoryBean's "dataSource" property).

Summary

[Expand] Inherited Fields
From class org.springframework.jdbc.support.JdbcAccessor protected final Log logger Logger available to subclasses

Public Constructors
	SqlMapClientTemplate() Create a new SqlMapClientTemplate.
	SqlMapClientTemplate(SqlMapClient sqlMapClient) Create a new SqlMapTemplate.
	SqlMapClientTemplate(DataSource dataSource, SqlMapClient sqlMapClient) Create a new SqlMapTemplate.

Public Methods
void	afterPropertiesSet() Eagerly initialize the exception translator, if demanded, creating a default one for the specified DataSource if none set.
int	delete(String statementName, Object parameterObject)
void	delete(String statementName, Object parameterObject, int requiredRowsAffected) Convenience method provided by Spring: execute a delete operation with an automatic check that the delete affected the given required number of rows.
int	delete(String statementName)
<T> T	execute(SqlMapClientCallback<T> action) Execute the given data access action on a SqlMapExecutor.
List	executeWithListResult(SqlMapClientCallback<List> action) This method is deprecated. as of Spring 3.0 - not really needed anymore with generic execute(SqlMapClientCallback) method
Map	executeWithMapResult(SqlMapClientCallback<Map> action) This method is deprecated. as of Spring 3.0 - not really needed anymore with generic execute(SqlMapClientCallback) method
DataSource	getDataSource() If no DataSource specified, use SqlMapClient's DataSource.
SqlMapClient	getSqlMapClient() Return the iBATIS Database Layer SqlMapClient that this template works with.
Object	insert(String statementName)
Object	insert(String statementName, Object parameterObject)
List	queryForList(String statementName, Object parameterObject)
List	queryForList(String statementName)
List	queryForList(String statementName, int skipResults, int maxResults)
List	queryForList(String statementName, Object parameterObject, int skipResults, int maxResults)
Map	queryForMap(String statementName, Object parameterObject, String keyProperty)
Map	queryForMap(String statementName, Object parameterObject, String keyProperty, String valueProperty)
Object	queryForObject(String statementName, Object parameterObject)
Object	queryForObject(String statementName, Object parameterObject, Object resultObject)
Object	queryForObject(String statementName)
void	queryWithRowHandler(String statementName, RowHandler rowHandler)
void	queryWithRowHandler(String statementName, Object parameterObject, RowHandler rowHandler)
void	setSqlMapClient(SqlMapClient sqlMapClient) Set the iBATIS Database Layer SqlMapClient that defines the mapped statements.
int	update(String statementName, Object parameterObject)
int	update(String statementName)
void	update(String statementName, Object parameterObject, int requiredRowsAffected) Convenience method provided by Spring: execute an update operation with an automatic check that the update affected the given required number of rows.

[Expand] Inherited Methods
From class org.springframework.jdbc.support.JdbcAccessor void afterPropertiesSet() Eagerly initialize the exception translator, if demanded, creating a default one for the specified DataSource if none set. DataSource getDataSource() Return the DataSource used by this template. synchronized SQLExceptionTranslator getExceptionTranslator() Return the exception translator for this instance. boolean isLazyInit() Return whether to lazily initialize the SQLExceptionTranslator for this accessor. void setDataSource(DataSource dataSource) Set the JDBC DataSource to obtain connections from. void setDatabaseProductName(String dbName) Specify the database product name for the DataSource that this accessor uses. void setExceptionTranslator(SQLExceptionTranslator exceptionTranslator) Set the exception translator for this instance. void setLazyInit(boolean lazyInit) Set whether to lazily initialize the SQLExceptionTranslator for this accessor, on first encounter of a SQLException.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.beans.factory.InitializingBean abstract void afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
From interface org.springframework.orm.ibatis.SqlMapClientOperations abstract int delete(String statementName, Object parameterObject) abstract int delete(String statementName) abstract void delete(String statementName, Object parameterObject, int requiredRowsAffected) Convenience method provided by Spring: execute a delete operation with an automatic check that the delete affected the given required number of rows. abstract Object insert(String statementName, Object parameterObject) abstract Object insert(String statementName) abstract List queryForList(String statementName, Object parameterObject) abstract List queryForList(String statementName) abstract List queryForList(String statementName, int skipResults, int maxResults) abstract List queryForList(String statementName, Object parameterObject, int skipResults, int maxResults) abstract Map queryForMap(String statementName, Object parameterObject, String keyProperty) abstract Map queryForMap(String statementName, Object parameterObject, String keyProperty, String valueProperty) abstract Object queryForObject(String statementName, Object parameterObject) abstract Object queryForObject(String statementName, Object parameterObject, Object resultObject) abstract Object queryForObject(String statementName) abstract void queryWithRowHandler(String statementName, RowHandler rowHandler) abstract void queryWithRowHandler(String statementName, Object parameterObject, RowHandler rowHandler) abstract void update(String statementName, Object parameterObject, int requiredRowsAffected) Convenience method provided by Spring: execute an update operation with an automatic check that the update affected the given required number of rows. abstract int update(String statementName, Object parameterObject) abstract int update(String statementName)