org.ibatis.client

Class SqlExecutor

java.lang.Object

org.ibatis.client.SqlExecutor

All Implemented Interfaces:

com.ibatis.common.Statsable, com.ibatis.sqlmap.engine.execution.SqlExecutor

public class SqlExecutor
extends Object
implements com.ibatis.sqlmap.engine.execution.SqlExecutor, com.ibatis.common.Statsable

A debug SqlExecutor

Date: 2011-11-15,22:37:47 +0800

Version:

1.0

Author:

Song Sun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqlExecutor.SqlStat

Field Summary

Fields inherited from interface com.ibatis.sqlmap.engine.execution.SqlExecutor

NO_LIMIT, ONE, TWO, ZERO

Constructor Summary

Constructors

Constructor and Description
SqlExecutor()

Method Summary

Modifier and Type	Method and Description
int	addBatch(com.ibatis.sqlmap.engine.scope.StatementScope statementScope, Connection conn, String sql, Object[] parameters) Adds a statement to a batch
void	cleanup(com.ibatis.sqlmap.engine.scope.SessionScope sessionScope) Clean up any batches on the session
int	executeBatch(com.ibatis.sqlmap.engine.scope.SessionScope sessionScope) Execute a batch of statements
List<BatchResult>	executeBatchDetailed(com.ibatis.sqlmap.engine.scope.SessionScope sessionScope) Execute a batch of statements
<T> T	executeInsert(String id, com.ibatis.sqlmap.engine.scope.StatementScope statementScope, Connection conn, String sql, Object[] parameters, com.ibatis.sqlmap.engine.mapping.result.ResultMap keyResultMap) Execute an insert
void	executeQuery(String id, com.ibatis.sqlmap.engine.scope.StatementScope statementScope, Connection conn, String sql, Object[] parameters, int skip, int max, com.ibatis.sqlmap.engine.mapping.statement.RowHandlerCallback callback) Long form of the method to execute a query
void	executeQueryPage(String id, com.ibatis.sqlmap.engine.scope.StatementScope statementScope, Connection conn, String sql, Object[] parameters, int skip, int max, com.ibatis.sqlmap.engine.mapping.statement.RowHandlerCallback callback, PageHandler pageHandler) Long form of the method to execute a query
void	executeQueryProcedure(String id, com.ibatis.sqlmap.engine.scope.StatementScope statementScope, Connection conn, String sql, Object[] parameters, int skip, int max, com.ibatis.sqlmap.engine.mapping.statement.RowHandlerCallback callback) Execute a stored procedure
int	executeUpdate(String id, com.ibatis.sqlmap.engine.scope.StatementScope statementScope, Connection conn, String sql, Object[] parameters) Execute an update
int	executeUpdateProcedure(String id, com.ibatis.sqlmap.engine.scope.StatementScope statementScope, Connection conn, String sql, Object[] parameters) Execute a stored procedure that updates data
String	getStatus(String h)
void	init(com.ibatis.sqlmap.engine.config.SqlMapConfiguration config, Properties globalProps) Initializing SQL Executor by passing configuration and global properties.
boolean	isCheckSql()
boolean	isDebugSql()
boolean	isTraceSql()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SqlExecutor

public SqlExecutor()

Method Detail

executeUpdate

public int executeUpdate(String id,
                         com.ibatis.sqlmap.engine.scope.StatementScope statementScope,
                         Connection conn,
                         String sql,
                         Object[] parameters)
                  throws SQLException

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Execute an update

Specified by:

executeUpdate in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

statementScope - - the request scope

conn - - the database connection

sql - - the sql statement to execute

parameters - - the parameters for the sql statement

Returns:

- the number of records changed

Throws:

SQLException - - if the update fails

executeInsert

public <T> T executeInsert(String id,
                           com.ibatis.sqlmap.engine.scope.StatementScope statementScope,
                           Connection conn,
                           String sql,
                           Object[] parameters,
                           com.ibatis.sqlmap.engine.mapping.result.ResultMap keyResultMap)
                    throws SQLException

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Execute an insert

Specified by:

executeInsert in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

statementScope - - the request scope

sql - - the sql statement to execute

parameters - - the parameters for the sql statement

Returns:

- the generated key if has selectKey or the number of records changed.

Throws:

SQLException - - if the insert fails

addBatch

public int addBatch(com.ibatis.sqlmap.engine.scope.StatementScope statementScope,
                    Connection conn,
                    String sql,
                    Object[] parameters)
             throws SQLException

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Adds a statement to a batch

Specified by:

addBatch in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

Parameters:

statementScope - - the request scope

conn - - the database connection

sql - - the sql statement

parameters - - the parameters for the statement

Throws:

SQLException - - if the statement fails

executeBatch

public int executeBatch(com.ibatis.sqlmap.engine.scope.SessionScope sessionScope)
                 throws SQLException

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Execute a batch of statements

Specified by:

executeBatch in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

Parameters:

sessionScope - - the session scope

Returns:

- the number of rows impacted by the batch

Throws:

SQLException - - if a statement fails

executeBatchDetailed

public List<BatchResult> executeBatchDetailed(com.ibatis.sqlmap.engine.scope.SessionScope sessionScope)
                                       throws SQLException,
                                              com.ibatis.sqlmap.engine.execution.BatchException

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Execute a batch of statements

Specified by:

executeBatchDetailed in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

Parameters:

sessionScope - - the session scope

Returns:

- a List of BatchResult objects (may be null if no batch has been initiated). There will be one BatchResult object in the list for each sub-batch executed

Throws:

SQLException - if a database access error occurs, or the drive does not support batch statements

com.ibatis.sqlmap.engine.execution.BatchException - if the driver throws BatchUpdateException

executeQuery

public void executeQuery(String id,
                         com.ibatis.sqlmap.engine.scope.StatementScope statementScope,
                         Connection conn,
                         String sql,
                         Object[] parameters,
                         int skip,
                         int max,
                         com.ibatis.sqlmap.engine.mapping.statement.RowHandlerCallback callback)
                  throws SQLException

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Long form of the method to execute a query

Specified by:

executeQuery in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

statementScope - - the request scope

conn - - the database connection

sql - - the SQL statement to execute

parameters - - the parameters for the statement

skip - - the number of results to skip

max - - the maximum number of results to return

callback - - the row handler for the query

Throws:

SQLException - - if the query fails

executeQueryPage

public void executeQueryPage(String id,
                             com.ibatis.sqlmap.engine.scope.StatementScope statementScope,
                             Connection conn,
                             String sql,
                             Object[] parameters,
                             int skip,
                             int max,
                             com.ibatis.sqlmap.engine.mapping.statement.RowHandlerCallback callback,
                             PageHandler pageHandler)
                      throws SQLException

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Long form of the method to execute a query

Specified by:

executeQueryPage in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

statementScope - - the request scope

conn - - the database connection

sql - - the SQL statement to execute

parameters - - the parameters for the statement

skip - - the number of results to skip

max - - the maximum number of results to return

callback - - the row handler for the query

pageHandler - - the page handler for the query

Throws:

SQLException - - if the query fails

executeUpdateProcedure

public int executeUpdateProcedure(String id,
                                  com.ibatis.sqlmap.engine.scope.StatementScope statementScope,
                                  Connection conn,
                                  String sql,
                                  Object[] parameters)
                           throws SQLException

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Execute a stored procedure that updates data

Specified by:

executeUpdateProcedure in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

statementScope - - the request scope

conn - - the database connection

sql - - the SQL to call the procedure

parameters - - the parameters for the procedure

Returns:

- the rows impacted by the procedure

Throws:

SQLException - - if the procedure fails

executeQueryProcedure

public void executeQueryProcedure(String id,
                                  com.ibatis.sqlmap.engine.scope.StatementScope statementScope,
                                  Connection conn,
                                  String sql,
                                  Object[] parameters,
                                  int skip,
                                  int max,
                                  com.ibatis.sqlmap.engine.mapping.statement.RowHandlerCallback callback)
                           throws SQLException

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Execute a stored procedure

Specified by:

executeQueryProcedure in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

statementScope - - the request scope

conn - - the database connection

sql - - the sql to call the procedure

parameters - - the parameters for the procedure

skip - - the number of results to skip

max - - the maximum number of results to return

callback - - a row handler for processing the results

Throws:

SQLException - - if the procedure fails

cleanup

public void cleanup(com.ibatis.sqlmap.engine.scope.SessionScope sessionScope)

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Clean up any batches on the session

Specified by:

cleanup in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

Parameters:

sessionScope - - the session to clean up

init

public void init(com.ibatis.sqlmap.engine.config.SqlMapConfiguration config,
                 Properties globalProps)

Description copied from interface: com.ibatis.sqlmap.engine.execution.SqlExecutor

Initializing SQL Executor by passing configuration and global properties.

Specified by:

init in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

Parameters:

config - - the configuration class, which contains complete configuration info

isTraceSql

public boolean isTraceSql()

Specified by:

isTraceSql in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

isCheckSql

public boolean isCheckSql()

Specified by:

isCheckSql in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

isDebugSql

public boolean isDebugSql()

Specified by:

isDebugSql in interface com.ibatis.sqlmap.engine.execution.SqlExecutor

getStatus

public String getStatus(String h)

Specified by:

getStatus in interface com.ibatis.common.Statsable