org.ibatis.spring

Interface SqlMapClientOperations

All Superinterfaces:

PropertyProvider

All Known Implementing Classes:

SqlMapClientTemplate

public interface SqlMapClientOperations
extends PropertyProvider

Interface that specifies a basic set of iBATIS SqlMapClient operations, implemented by SqlMapClientTemplate.

Method Summary

Modifier and Type	Method and Description
int	delete(String statementName)
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	deleteArgs(String id, Object... args) Do delete operation by var-args paramenters as #1# to #n#
<E,K> int	deleteEntity(Class<E> cls, K key) Update an entity object by its key.
<T> int	executeDelete(CriteriaDelete<T> deleteQuery) Delete entities by the CriteriaUpdate object.
<T> List<T>	executeQuery(CriteriaQuery<T> criteriaQuery) Query the object list by the CriteriaQuery object.
<T> List<T>	executeQuery(CriteriaQuery<T> criteriaQuery, int startPosition, int maxResult) Query the object list by the CriteriaQuery object.
<T> T	executeQueryObject(CriteriaQuery<T> criteriaQuery) Query the first object by the CriteriaQuery object.
<T> int	executeQueryPage(CriteriaQuery<T> criteriaQuery, List<T> page, int startPosition, int maxResult) Query the object list by the CriteriaQuery object and fill into page
<T> int	executeUpdate(CriteriaUpdate<T> updateQuery) Update entities by the CriteriaUpdate object.
<E,K> E	findEntity(Class<E> cls, K key) Find an entity object by its key.
CriteriaBuilder	getCriteriaBuilder() Return an instance of CriteriaBuilder for the creation of CriteriaQuery, CriteriaUpdateor CriteriaDelete objects.
<T> T	insert(String statementName)
<T> T	insert(String statementName, Object parameterObject)
<T> T	insertArgs(String id, Object... args) Do insert operation by var-args paramenters as #1# to #n#
<E> E	insertEntity(Class<E> cls, E entity) Insert an entity object.
<T> T	queryForFirst(String id) Do query and return first row as result object.
<T> T	queryForFirst(String id, Object parameterObject) Do query and return first row as result object.
<T> T	queryForFirstArgs(String id, Object... args) Do queryForFirst operation by var-args paramenters as #1# to #n#
<T> List<T>	queryForList(String statementName)
<T> List<T>	queryForList(String statementName, int skipResults, int maxResults)
<T> List<T>	queryForList(String statementName, Object parameterObject)
<T> List<T>	queryForList(String statementName, Object parameterObject, int skipResults, int maxResults)
<T> List<T>	queryForListArgs(int skip, int max, String id, Object... args) Do queryForList operation by var-args paramenters as #1# to #n#
<T> List<T>	queryForListArgs(String id, Object... args) Do queryForList operation by var-args paramenters as #1# to #n#
<K,V> Map<K,V>	queryForMap(String statementName, Object parameterObject, String keyProperty)
<K,V> Map<K,V>	queryForMap(String statementName, Object parameterObject, String keyProperty, Class<K> keyType, String valueProperty, Class<V> valueType)
<K,V> Map<K,V>	queryForMap(String statementName, Object parameterObject, String keyProperty, String valueProperty)
<K,V> Map<K,V>	queryForMapArgs(String id, String keyProp, Class<K> keyType, String valueProp, Class<V> valueType, Object... args) Do queryForMap operation by var-args paramenters as #1# to #n#
<K,V> Map<K,V>	queryForMapArgs(String id, String keyProp, Object... args) Do queryForMap operation by var-args paramenters as #1# to #n#
<K,V> Map<K,V>	queryForMapArgs(String id, String keyProp, String valueProp, Object... args) Do queryForMap operation by var-args paramenters as #1# to #n#
<T> T	queryForObject(String statementName)
<T> T	queryForObject(String statementName, Object parameterObject)
<T> T	queryForObject(String statementName, Object parameterObject, Object resultObject)
<T> T	queryForObjectArgs(String id, Object... args) Do queryForObject operation by var-args paramenters as #1# to #n#
<T> int	queryForPage(List<T> page, String id, int skip, int max) Executes a mapped SQL SELECT statement that returns data to populate a number of result objects within a certain range into the page argument and return the total number.
<T> int	queryForPage(List<T> page, String id, Object paramObject, int skip, int max) Executes a mapped SQL SELECT statement that returns data to populate a number of result objects within a certain range into the page argument and return the total number.
<T> int	queryForPageArgs(List<T> page, String id, int skip, int max, Object... args) Executes a mapped SQL SELECT statement that returns data to populate a number of result objects within a certain range into the page argument and return the total number.
ResultSet	queryForResultSet(String id) Do query and return a cached result set.
ResultSet	queryForResultSet(String id, Object parameterObject) Do query and return a cached result set.
ResultSet	queryForResultSetArgs(String id, Object... args) Do queryForResultSet operation by var-args paramenters as #1# to #n#
void	queryWithRowHandler(String statementName, Object parameterObject, RowHandler rowHandler)
void	queryWithRowHandler(String statementName, RowHandler rowHandler)
void	queryWithRowHandler(String statementName, RowHandler rowHandler, Object... args) Do queryWithRowHandler operation by var-args paramenters as #1# to #n#
int	update(String statementName)
int	update(String statementName, Object parameterObject)
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.
int	updateArgs(String id, Object... args) Do update operation by var-args paramenters as #1# to #n#
<E,K> int	updateEntity(Class<E> cls, E entity) Update an entity object.

Methods inherited from interface org.ibatis.client.PropertyProvider

getGlobalProperty

Method Detail

queryForObject

<T> T queryForObject(String statementName)
              throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForObject(String)

queryForObject

<T> T queryForObject(String statementName,
                     Object parameterObject)
              throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForObject(String, Object)

queryForObject

<T> T queryForObject(String statementName,
                     Object parameterObject,
                     Object resultObject)
              throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForObject(String, Object, Object)

queryForList

<T> List<T> queryForList(String statementName)
                  throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForList(String)

queryForList

<T> List<T> queryForList(String statementName,
                         Object parameterObject)
                  throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForList(String, Object)

queryForList

<T> List<T> queryForList(String statementName,
                         int skipResults,
                         int maxResults)
                  throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForList(String, int, int)

queryForList

<T> List<T> queryForList(String statementName,
                         Object parameterObject,
                         int skipResults,
                         int maxResults)
                  throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForList(String, Object, int, int)

queryWithRowHandler

void queryWithRowHandler(String statementName,
                         RowHandler rowHandler)
                  throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryWithRowHandler(String, RowHandler)

queryWithRowHandler

void queryWithRowHandler(String statementName,
                         Object parameterObject,
                         RowHandler rowHandler)
                  throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryWithRowHandler(String, Object, RowHandler)

queryWithRowHandler

void queryWithRowHandler(String statementName,
                         RowHandler rowHandler,
                         Object... args)
                  throws org.springframework.dao.DataAccessException

Do queryWithRowHandler operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

queryWithRowHandler(String, Object, RowHandler)

queryForMap

<K,V> Map<K,V> queryForMap(String statementName,
                           Object parameterObject,
                           String keyProperty)
                    throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForMap(String, Object, String)

queryForMap

<K,V> Map<K,V> queryForMap(String statementName,
                           Object parameterObject,
                           String keyProperty,
                           String valueProperty)
                    throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForMap(String, Object, String, String)

queryForMap

<K,V> Map<K,V> queryForMap(String statementName,
                           Object parameterObject,
                           String keyProperty,
                           Class<K> keyType,
                           String valueProperty,
                           Class<V> valueType)
                    throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.queryForMap(String, Object, String, Class, String, Class)

insert

<T> T insert(String statementName)
      throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.insert(String)

insert

<T> T insert(String statementName,
             Object parameterObject)
      throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.insert(String, Object)

update

int update(String statementName)
    throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.update(String)

update

int update(String statementName,
           Object parameterObject)
    throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.update(String, Object)

update

void update(String statementName,
            Object parameterObject,
            int requiredRowsAffected)
     throws org.springframework.dao.DataAccessException

Convenience method provided by Spring: execute an update operation with an automatic check that the update affected the given required number of rows.

Parameters:

statementName - the name of the mapped statement

parameterObject - the parameter object

requiredRowsAffected - the number of rows that the update is required to affect

Throws:

org.springframework.dao.DataAccessException - in case of errors

delete

int delete(String statementName)
    throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.delete(String)

delete

int delete(String statementName,
           Object parameterObject)
    throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException - in case of errors

See Also:

SqlMapExecutor.delete(String, Object)

delete

void delete(String statementName,
            Object parameterObject,
            int requiredRowsAffected)
     throws org.springframework.dao.DataAccessException

Convenience method provided by Spring: execute a delete operation with an automatic check that the delete affected the given required number of rows.

Parameters:

statementName - the name of the mapped statement

parameterObject - the parameter object

requiredRowsAffected - the number of rows that the delete is required to affect

Throws:

org.springframework.dao.DataAccessException - in case of errors

insertArgs

<T> T insertArgs(String id,
                 Object... args)
          throws org.springframework.dao.DataAccessException

Do insert operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

insert(String, Object)

updateArgs

int updateArgs(String id,
               Object... args)
        throws org.springframework.dao.DataAccessException

Do update operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

update(String, Object)

deleteArgs

int deleteArgs(String id,
               Object... args)
        throws org.springframework.dao.DataAccessException

Do delete operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

delete(String, Object)

queryForListArgs

<T> List<T> queryForListArgs(String id,
                             Object... args)
                      throws org.springframework.dao.DataAccessException

Do queryForList operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

queryForList(String, Object)

queryForListArgs

<T> List<T> queryForListArgs(int skip,
                             int max,
                             String id,
                             Object... args)
                      throws org.springframework.dao.DataAccessException

Do queryForList operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

queryForList(String, Object, int, int)

queryForMapArgs

<K,V> Map<K,V> queryForMapArgs(String id,
                               String keyProp,
                               Object... args)
                        throws org.springframework.dao.DataAccessException

Do queryForMap operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

queryForMap(String, Object, String)

queryForMapArgs

<K,V> Map<K,V> queryForMapArgs(String id,
                               String keyProp,
                               String valueProp,
                               Object... args)
                        throws org.springframework.dao.DataAccessException

Do queryForMap operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

queryForMap(String, Object, String, String)

queryForMapArgs

<K,V> Map<K,V> queryForMapArgs(String id,
                               String keyProp,
                               Class<K> keyType,
                               String valueProp,
                               Class<V> valueType,
                               Object... args)
                        throws org.springframework.dao.DataAccessException

Do queryForMap operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

queryForMap(String, Object, String, Class, String, Class)

queryForObjectArgs

<T> T queryForObjectArgs(String id,
                         Object... args)
                  throws org.springframework.dao.DataAccessException

Do queryForObject operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

queryForObject(String, Object)

queryForFirstArgs

<T> T queryForFirstArgs(String id,
                        Object... args)
                 throws org.springframework.dao.DataAccessException

Do queryForFirst operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

queryForFirst(String, Object)

queryForFirst

<T> T queryForFirst(String id)
             throws org.springframework.dao.DataAccessException

Do query and return first row as result object.

Throws:

org.springframework.dao.DataAccessException

See Also:

SqlMapExecutor.queryForList(String)

queryForFirst

<T> T queryForFirst(String id,
                    Object parameterObject)
             throws org.springframework.dao.DataAccessException

Do query and return first row as result object.

Parameters:

parameterObject - the parameter for query

Throws:

org.springframework.dao.DataAccessException

See Also:

SqlMapExecutor.queryForList(String, Object)

queryForPage

<T> int queryForPage(List<T> page,
                     String id,
                     Object paramObject,
                     int skip,
                     int max)
              throws org.springframework.dao.DataAccessException

Executes a mapped SQL SELECT statement that returns data to populate a number of result objects within a certain range into the page argument and return the total number.

Parameters:

page - page container, input/output parameter

id - The name of the statement to execute.

parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.).

skip - The number of results to ignore.

max - The maximum number of results to return.

Returns:

total number

Throws:

java.sql.DataAccessException - If an error occurs.

org.springframework.dao.DataAccessException

queryForPage

<T> int queryForPage(List<T> page,
                     String id,
                     int skip,
                     int max)
              throws org.springframework.dao.DataAccessException

Executes a mapped SQL SELECT statement that returns data to populate a number of result objects within a certain range into the page argument and return the total number.

Parameters:

page - page container, input/output parameter

id - The name of the statement to execute.

skip - The number of results to ignore.

max - The maximum number of results to return.

Returns:

total number

Throws:

java.sql.DataAccessException - If an error occurs.

org.springframework.dao.DataAccessException

queryForPageArgs

<T> int queryForPageArgs(List<T> page,
                         String id,
                         int skip,
                         int max,
                         Object... args)
                  throws org.springframework.dao.DataAccessException

Executes a mapped SQL SELECT statement that returns data to populate a number of result objects within a certain range into the page argument and return the total number.

Parameters:

page - page container, input/output parameter

id - The name of the statement to execute.

skip - The number of results to ignore.

max - The maximum number of results to return.

args - The parameter objects #1# to #n#

Returns:

total number

Throws:

java.sql.DataAccessException - If an error occurs.

org.springframework.dao.DataAccessException

queryForResultSetArgs

ResultSet queryForResultSetArgs(String id,
                                Object... args)
                         throws org.springframework.dao.DataAccessException

Do queryForResultSet operation by var-args paramenters as #1# to #n#

Throws:

org.springframework.dao.DataAccessException

See Also:

queryForResultSet(String, Object)

queryForResultSet

ResultSet queryForResultSet(String id)
                     throws org.springframework.dao.DataAccessException

Do query and return a cached result set.

Throws:

org.springframework.dao.DataAccessException

See Also:

RowSet

queryForResultSet

ResultSet queryForResultSet(String id,
                            Object parameterObject)
                     throws org.springframework.dao.DataAccessException

Do query and return a cached result set.

Parameters:

parameterObject - the parameter for query

Throws:

org.springframework.dao.DataAccessException

See Also:

RowSet

insertEntity

<E> E insertEntity(Class<E> cls,
                   E entity)
            throws org.springframework.dao.DataAccessException

Insert an entity object.

Throws:

org.springframework.dao.DataAccessException

See Also:

EntityManager.insertEntity(Class, Object)

updateEntity

<E,K> int updateEntity(Class<E> cls,
                       E entity)
                throws org.springframework.dao.DataAccessException

Update an entity object.

Throws:

org.springframework.dao.DataAccessException

See Also:

EntityManager.updateEntity(Class, Object)

deleteEntity

<E,K> int deleteEntity(Class<E> cls,
                       K key)
                throws org.springframework.dao.DataAccessException

Update an entity object by its key.

Throws:

org.springframework.dao.DataAccessException

See Also:

EntityManager.deleteEntity(Class, Object)

findEntity

<E,K> E findEntity(Class<E> cls,
                   K key)
            throws org.springframework.dao.DataAccessException

Find an entity object by its key.

Throws:

org.springframework.dao.DataAccessException

See Also:

EntityManager.findEntity(Class, Object)

executeQueryObject

<T> T executeQueryObject(CriteriaQuery<T> criteriaQuery)
                  throws org.springframework.dao.DataAccessException

Query the first object by the CriteriaQuery object.

Parameters:

criteriaQuery - the CriteriaQuery object.

Returns:

the first result object or null.

Throws:

org.springframework.dao.DataAccessException

executeQuery

<T> List<T> executeQuery(CriteriaQuery<T> criteriaQuery)
                  throws org.springframework.dao.DataAccessException

Query the object list by the CriteriaQuery object.

Parameters:

criteriaQuery - the CriteriaQuery object.

Returns:

the object list or empty list.

Throws:

org.springframework.dao.DataAccessException

executeQuery

<T> List<T> executeQuery(CriteriaQuery<T> criteriaQuery,
                         int startPosition,
                         int maxResult)
                  throws org.springframework.dao.DataAccessException

Query the object list by the CriteriaQuery object.

Parameters:

criteriaQuery - the CriteriaQuery object.

startPosition - position of the first result, numbered from 0

maxResult - maximum number of results to retrieve

Returns:

the object list or empty list.

Throws:

org.springframework.dao.DataAccessException

executeQueryPage

<T> int executeQueryPage(CriteriaQuery<T> criteriaQuery,
                         List<T> page,
                         int startPosition,
                         int maxResult)
                  throws org.springframework.dao.DataAccessException

Query the object list by the CriteriaQuery object and fill into page

Parameters:

criteriaQuery - the CriteriaQuery object.

page - the page container

startPosition - position of the first result, numbered from 0

maxResult - maximum number of results to retrieve

Returns:

the total rows

Throws:

org.springframework.dao.DataAccessException

executeUpdate

<T> int executeUpdate(CriteriaUpdate<T> updateQuery)
               throws org.springframework.dao.DataAccessException

Update entities by the CriteriaUpdate object.

Parameters:

updateQuery - the CriteriaUpdate object.

Returns:

the count of rows updated.

Throws:

org.springframework.dao.DataAccessException

executeDelete

<T> int executeDelete(CriteriaDelete<T> deleteQuery)
               throws org.springframework.dao.DataAccessException

Delete entities by the CriteriaUpdate object.

Parameters:

deleteQuery - the CriteriaDelete object.

Returns:

the count of rows deleted.

Throws:

org.springframework.dao.DataAccessException

getCriteriaBuilder

CriteriaBuilder getCriteriaBuilder()
                            throws org.springframework.dao.DataAccessException

Return an instance of CriteriaBuilder for the creation of CriteriaQuery, CriteriaUpdateor CriteriaDelete objects.

Returns:

CriteriaBuilder instance

Throws:

org.springframework.dao.DataAccessException