| com.ibatis.sqlmap.client.SqlMapExecutor
| SqlMapExecutor | | public interface SqlMapExecutor (Code) | | This interface declares all methods involved with executing statements
and batches for an SQL Map.
See Also: SqlMapSession
See Also: SqlMapClient |
| Method Summary | |
| int | delete(String id, Object parameterObject)
Executes a mapped SQL DELETE statement.
Delete returns the number of rows effected.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the DELETE statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. | | int | delete(String id)
Executes a mapped SQL DELETE statement.
Delete returns the number of rows effected.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute. | | int | executeBatch()
Executes (flushes) all statements currently batched. | | List | executeBatchDetailed()
Executes (flushes) all statements currently batched.
a List of BatchResult objects. | | Object | insert(String id, Object parameterObject)
Executes a mapped SQL INSERT statement.
Insert is a bit different from other update methods, as it
provides facilities for returning the primary key of the
newly inserted row (rather than the effected rows). | | Object | insert(String id)
Executes a mapped SQL INSERT statement.
Insert is a bit different from other update methods, as it
provides facilities for returning the primary key of the
newly inserted row (rather than the effected rows). | | List | queryForList(String id, Object parameterObject)
Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. | | List | queryForList(String id)
Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute. | | List | queryForList(String id, Object parameterObject, int skip, int max)
Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects within a certain range.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. | | List | queryForList(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.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute.
Parameters:
skip - The number of results to ignore.
Parameters:
max - The maximum number of results to return. | | Map | queryForMap(String id, Object parameterObject, String keyProp)
Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects that will be keyed into a Map.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. | | Map | queryForMap(String id, Object parameterObject, String keyProp, String valueProp)
Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects from which one property will be keyed into a Map.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. | | Object | queryForObject(String id, Object parameterObject)
Executes a mapped SQL SELECT statement that returns data to populate
a single object instance.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. | | Object | queryForObject(String id)
Executes a mapped SQL SELECT statement that returns data to populate
a single object instance.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute. | | Object | queryForObject(String id, Object parameterObject, Object resultObject)
Executes a mapped SQL SELECT statement that returns data to populate
the supplied result object.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. | | PaginatedList | queryForPaginatedList(String id, Object parameterObject, int pageSize)
Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects a page at a time.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. | | PaginatedList | queryForPaginatedList(String id, int pageSize)
Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects a page at a time.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute.
Parameters:
pageSize - The maximum number of result objects each page can hold. | | void | queryWithRowHandler(String id, Object parameterObject, RowHandler rowHandler)
Executes a mapped SQL SELECT statement that returns a number of
result objects that will be handled one at a time by a
RowHandler.
This is generally a good approach to take when dealing with large sets
of records (i.e. | | void | queryWithRowHandler(String id, RowHandler rowHandler)
Executes a mapped SQL SELECT statement that returns a number of
result objects that will be handled one at a time by a
RowHandler.
This is generally a good approach to take when dealing with large sets
of records (i.e. | | void | startBatch()
Starts a batch in which update statements will be cached before being sent to
the database all at once. | | int | update(String id, Object parameterObject)
Executes a mapped SQL UPDATE statement.
Update can also be used for any other update statement type,
such as inserts and deletes. | | int | update(String id)
Executes a mapped SQL UPDATE statement.
Update can also be used for any other update statement type,
such as inserts and deletes. |
| delete | | int delete(String id, Object parameterObject) throws SQLException(Code) | | Executes a mapped SQL DELETE statement.
Delete returns the number of rows effected.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the DELETE statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.). The number of rows effected.
throws:
java.sql.SQLException - If an error occurs. |
| delete | | int delete(String id) throws SQLException(Code) | | Executes a mapped SQL DELETE statement.
Delete returns the number of rows effected.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute. The number of rows effected.
throws:
java.sql.SQLException - If an error occurs. |
| executeBatch | | int executeBatch() throws SQLException(Code) | | Executes (flushes) all statements currently batched.
the number of rows updated in the batch
throws:
java.sql.SQLException - If the batch could not be executed or if any of the statementsfails. |
| executeBatchDetailed | | List executeBatchDetailed() throws SQLException, BatchException(Code) | | Executes (flushes) all statements currently batched.
a List of BatchResult objects. There will be one element in thelist for each sub-batch executed. A sub-batch is created by adding a statementto the batch that does not equal the prior statement.
throws:
SQLException - if a database access error occurs, or the drivedoes not support batch statements
throws:
BatchException - if the driver throws BatchUpdateException
See Also: com.ibatis.sqlmap.engine.execution.BatchException |
| insert | | Object insert(String id, Object parameterObject) throws SQLException(Code) | | Executes a mapped SQL INSERT statement.
Insert is a bit different from other update methods, as it
provides facilities for returning the primary key of the
newly inserted row (rather than the effected rows). This
functionality is of course optional.
The parameter object is generally used to supply the input
data for the INSERT values.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.). The primary key of the newly inserted row. This might be automaticallygenerated by the RDBMS, or selected from a sequence table or other source.
throws:
java.sql.SQLException - If an error occurs. |
| insert | | Object insert(String id) throws SQLException(Code) | | Executes a mapped SQL INSERT statement.
Insert is a bit different from other update methods, as it
provides facilities for returning the primary key of the
newly inserted row (rather than the effected rows). This
functionality is of course optional.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute. The primary key of the newly inserted row. This might be automaticallygenerated by the RDBMS, or selected from a sequence table or other source.
throws:
java.sql.SQLException - If an error occurs. |
| queryForList | | List queryForList(String id, Object parameterObject) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.). A List of result objects.
throws:
java.sql.SQLException - If an error occurs. |
| queryForList | | List queryForList(String id) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute. A List of result objects.
throws:
java.sql.SQLException - If an error occurs. |
| queryForList | | List queryForList(String id, Object parameterObject, int skip, int max) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects within a certain range.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.).
Parameters:
skip - The number of results to ignore.
Parameters:
max - The maximum number of results to return. A List of result objects.
throws:
java.sql.SQLException - If an error occurs. |
| queryForList | | List queryForList(String id, int skip, int max) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects within a certain range.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute.
Parameters:
skip - The number of results to ignore.
Parameters:
max - The maximum number of results to return. A List of result objects.
throws:
java.sql.SQLException - If an error occurs. |
| queryForMap | | Map queryForMap(String id, Object parameterObject, String keyProp) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects that will be keyed into a Map.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.).
Parameters:
keyProp - The property to be used as the key in the Map. A Map keyed by keyProp with values being the result object instance.
throws:
java.sql.SQLException - If an error occurs. |
| queryForMap | | Map queryForMap(String id, Object parameterObject, String keyProp, String valueProp) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects from which one property will be keyed into a Map.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.).
Parameters:
keyProp - The property to be used as the key in the Map.
Parameters:
valueProp - The property to be used as the value in the Map. A Map keyed by keyProp with values of valueProp.
throws:
java.sql.SQLException - If an error occurs. |
| queryForObject | | Object queryForObject(String id, Object parameterObject) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a single object instance.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.). The single result object populated with the result set data,or null if no result was found
throws:
java.sql.SQLException - If more than one result was found, or if any other error occurs. |
| queryForObject | | Object queryForObject(String id) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a single object instance.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute. The single result object populated with the result set data,or null if no result was found
throws:
java.sql.SQLException - If more than one result was found, or if any other error occurs. |
| queryForObject | | Object queryForObject(String id, Object parameterObject, Object resultObject) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
the supplied result object.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.).
Parameters:
resultObject - The result object instance that should be populated with result data. The single result object as supplied by the resultObject parameter, populated with the result set data,or null if no result was found
throws:
java.sql.SQLException - If more than one result was found, or if any other error occurs. |
| queryForPaginatedList | | PaginatedList queryForPaginatedList(String id, Object parameterObject, int pageSize) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects a page at a time.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.).
Parameters:
pageSize - The maximum number of result objects each page can hold. A PaginatedList of result objects.
throws:
java.sql.SQLException - If an error occurs. |
| queryForPaginatedList | | PaginatedList queryForPaginatedList(String id, int pageSize) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns data to populate
a number of result objects a page at a time.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute.
Parameters:
pageSize - The maximum number of result objects each page can hold. A PaginatedList of result objects.
throws:
java.sql.SQLException - If an error occurs. |
| queryWithRowHandler | | void queryWithRowHandler(String id, Object parameterObject, RowHandler rowHandler) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns a number of
result objects that will be handled one at a time by a
RowHandler.
This is generally a good approach to take when dealing with large sets
of records (i.e. hundreds, thousands...) that need to be processed without
eating up all of the system resources.
The parameter object is generally used to supply the input
data for the WHERE clause parameter(s) of the SELECT statement.
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.).
Parameters:
rowHandler - A RowHandler instance
throws:
java.sql.SQLException - If an error occurs. |
| queryWithRowHandler | | void queryWithRowHandler(String id, RowHandler rowHandler) throws SQLException(Code) | | Executes a mapped SQL SELECT statement that returns a number of
result objects that will be handled one at a time by a
RowHandler.
This is generally a good approach to take when dealing with large sets
of records (i.e. hundreds, thousands...) that need to be processed without
eating up all of the system resources.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute.
Parameters:
rowHandler - A RowHandler instance
throws:
java.sql.SQLException - If an error occurs. |
| startBatch | | void startBatch() throws SQLException(Code) | | Starts a batch in which update statements will be cached before being sent to
the database all at once. This can improve overall performance of updates update
when dealing with numerous updates (e.g. inserting 1:M related data).
throws:
java.sql.SQLException - If the batch could not be started. |
| update | | int update(String id, Object parameterObject) throws SQLException(Code) | | Executes a mapped SQL UPDATE statement.
Update can also be used for any other update statement type,
such as inserts and deletes. Update returns the number of
rows effected.
The parameter object is generally used to supply the input
data for the UPDATE values as well as the WHERE clause parameter(s).
Parameters:
id - The name of the statement to execute.
Parameters:
parameterObject - The parameter object (e.g. JavaBean, Map, XML etc.). The number of rows effected.
throws:
java.sql.SQLException - If an error occurs. |
| update | | int update(String id) throws SQLException(Code) | | Executes a mapped SQL UPDATE statement.
Update can also be used for any other update statement type,
such as inserts and deletes. Update returns the number of
rows effected.
This overload assumes no parameter is needed.
Parameters:
id - The name of the statement to execute. The number of rows effected.
throws:
java.sql.SQLException - If an error occurs. |
|
|