SqlMapSessionImpl (mybatis 2.3.5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibatis.sqlmap.engine.impl
Class SqlMapSessionImpl

java.lang.Object
  com.ibatis.sqlmap.engine.impl.SqlMapSessionImpl

All Implemented Interfaces:: SqlMapExecutor, SqlMapSession, SqlMapTransactionManager

public class SqlMapSessionImpl
extends Object
implements SqlMapSession
extends Object
implements SqlMapSession

Implementation of SqlMapSession

Field Summary
`protected boolean`	`closed`
`protected SqlMapExecutorDelegate`	`delegate`
`protected SessionScope`	`sessionScope`

Constructor Summary
`SqlMapSessionImpl(SqlMapClientImpl client)` Constructor

Method Summary
`void`	`close()` Closes the session
`void`	`commitTransaction()` Commits the currently started transaction.
`int`	`delete(String id)` Executes a mapped SQL DELETE statement.
`int`	`delete(String id, Object param)` Executes a mapped SQL DELETE statement.
`void`	`endTransaction()` Ends a transaction and rolls back if necessary.
`int`	`executeBatch()` Executes (flushes) all statements currently batched.
`List`	`executeBatchDetailed()` Executes (flushes) all statements currently batched.
`Connection`	`getCurrentConnection()` Returns the current connection in use.
`DataSource`	`getDataSource()` Returns the DataSource instance currently being used by the SqlMapSession.
`SqlMapExecutorDelegate`	`getDelegate()` Get the delegate
`MappedStatement`	`getMappedStatement(String id)` Gets a mapped statement by ID
`SqlExecutor`	`getSqlExecutor()` Get the SQL executor
`Connection`	`getUserConnection()` Deprecated.
`Object`	`insert(String id)` Executes a mapped SQL INSERT statement.
`Object`	`insert(String id, Object param)` Executes a mapped SQL INSERT statement.
`boolean`	`isClosed()` Getter to tell if the session is still open
`boolean`	`isEnhancementEnabled()` Get the status of CGLib enhancements
`boolean`	`isLazyLoadingEnabled()` Get the status of lazy loading
`void`	`open()` Start the session
`List`	`queryForList(String id)` Executes a mapped SQL SELECT statement that returns data to populate a number of result objects.
`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.
`List`	`queryForList(String id, Object paramObject)` Executes a mapped SQL SELECT statement that returns data to populate a number of result objects.
`List`	`queryForList(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.
`Map`	`queryForMap(String id, Object paramObject, 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.
`Map`	`queryForMap(String id, Object paramObject, 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.
`Object`	`queryForObject(String id)` Executes a mapped SQL SELECT statement that returns data to populate a single object instance.
`Object`	`queryForObject(String id, Object paramObject)` Executes a mapped SQL SELECT statement that returns data to populate a single object instance.
`Object`	`queryForObject(String id, Object paramObject, Object resultObject)` Executes a mapped SQL SELECT statement that returns data to populate the supplied result object.
`PaginatedList`	`queryForPaginatedList(String id, int pageSize)` Deprecated. All paginated list features have been deprecated
`PaginatedList`	`queryForPaginatedList(String id, Object paramObject, int pageSize)` Deprecated. All paginated list features have been deprecated
`void`	`queryWithRowHandler(String id, Object paramObject, 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.
`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.
`void`	`setUserConnection(Connection connection)` Allows the developer to easily use an externally supplied connection when executing statements.
`void`	`startBatch()` Starts a batch in which update statements will be cached before being sent to the database all at once.
`void`	`startTransaction()` Demarcates the beginning of a transaction scope.
`void`	`startTransaction(int transactionIsolation)` Demarcates the beginning of a transaction scope using the specified transaction isolation.
`int`	`update(String id)` Executes a mapped SQL UPDATE statement.
`int`	`update(String id, Object param)` Executes a mapped SQL UPDATE statement.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

delegate

protected SqlMapExecutorDelegate delegate

sessionScope

protected SessionScope sessionScope

closed

protected boolean closed

Constructor Detail

SqlMapSessionImpl

public SqlMapSessionImpl(SqlMapClientImpl client)

Constructor

Parameters:: client - - the client that will use the session

Method Detail

open

public void open()

Start the session

isClosed

public boolean isClosed()

Getter to tell if the session is still open

Returns:: - the status of the session

close

public void close()

Description copied from interface: SqlMapSession

Closes the session

Specified by:: close in interface SqlMapSession

insert

public Object insert(String id,
                     Object param)
              throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: insert in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; param - The parameter object (e.g. JavaBean, Map, XML etc.).
Returns:: The primary key of the newly inserted row. This might be automatically generated by the RDBMS, or selected from a sequence table or other source.
Throws:: SQLException - If an error occurs.

insert

public Object insert(String id)
              throws SQLException

Description copied from interface: SqlMapExecutor

This overload assumes no parameter is needed.

Specified by:: insert in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.
Returns:: The primary key of the newly inserted row. This might be automatically generated by the RDBMS, or selected from a sequence table or other source.
Throws:: SQLException - If an error occurs.

update

public int update(String id,
                  Object param)
           throws SQLException

Description copied from interface: SqlMapExecutor

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).

Specified by:: update in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; param - The parameter object (e.g. JavaBean, Map, XML etc.).
Returns:: The number of rows effected.
Throws:: SQLException - If an error occurs.

update

public int update(String id)
           throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: update in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.
Returns:: The number of rows effected.
Throws:: SQLException - If an error occurs.

delete

public int delete(String id,
                  Object param)
           throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: delete in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; param - The parameter object (e.g. JavaBean, Map, XML etc.).
Returns:: The number of rows effected.
Throws:: SQLException - If an error occurs.

delete

public int delete(String id)
           throws SQLException

Description copied from interface: SqlMapExecutor

Executes a mapped SQL DELETE statement. Delete returns the number of rows effected.

This overload assumes no parameter is needed.

Specified by:: delete in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.
Returns:: The number of rows effected.
Throws:: SQLException - If an error occurs.

queryForObject

public Object queryForObject(String id,
                             Object paramObject)
                      throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryForObject in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; paramObject - The parameter object (e.g. JavaBean, Map, XML etc.).
Returns:: The single result object populated with the result set data, or null if no result was found
Throws:: SQLException - If more than one result was found, or if any other error occurs.

queryForObject

public Object queryForObject(String id)
                      throws SQLException

Description copied from interface: SqlMapExecutor

Executes a mapped SQL SELECT statement that returns data to populate a single object instance.

This overload assumes no parameter is needed.

Specified by:: queryForObject in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.
Returns:: The single result object populated with the result set data, or null if no result was found
Throws:: SQLException - If more than one result was found, or if any other error occurs.

queryForObject

public Object queryForObject(String id,
                             Object paramObject,
                             Object resultObject)
                      throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryForObject in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; paramObject - The parameter object (e.g. JavaBean, Map, XML etc.).; resultObject - The result object instance that should be populated with result data.
Returns:: The single result object as supplied by the resultObject parameter, populated with the result set data, or null if no result was found
Throws:: SQLException - If more than one result was found, or if any other error occurs.

queryForList

public List queryForList(String id,
                         Object paramObject)
                  throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryForList in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; paramObject - The parameter object (e.g. JavaBean, Map, XML etc.).
Returns:: A List of result objects.
Throws:: SQLException - If an error occurs.

queryForList

public List queryForList(String id)
                  throws SQLException

Description copied from interface: SqlMapExecutor

Executes a mapped SQL SELECT statement that returns data to populate a number of result objects.

This overload assumes no parameter is needed.

Specified by:: queryForList in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.
Returns:: A List of result objects.
Throws:: SQLException - If an error occurs.

queryForList

public List queryForList(String id,
                         Object paramObject,
                         int skip,
                         int max)
                  throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryForList in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; paramObject - 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:: A List of result objects.
Throws:: SQLException - If an error occurs.

queryForList

public List queryForList(String id,
                         int skip,
                         int max)
                  throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryForList in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; skip - The number of results to ignore.; max - The maximum number of results to return.
Returns:: A List of result objects.
Throws:: SQLException - If an error occurs.

queryForPaginatedList

public PaginatedList queryForPaginatedList(String id,
                                           Object paramObject,
                                           int pageSize)
                                    throws SQLException

Deprecated. All paginated list features have been deprecated

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryForPaginatedList in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; paramObject - The parameter object (e.g. JavaBean, Map, XML etc.).; pageSize - The maximum number of result objects each page can hold.
Returns:: A PaginatedList of result objects.
Throws:: SQLException - If an error occurs.

queryForPaginatedList

public PaginatedList queryForPaginatedList(String id,
                                           int pageSize)
                                    throws SQLException

Deprecated. All paginated list features have been deprecated

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryForPaginatedList in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; pageSize - The maximum number of result objects each page can hold.
Returns:: A PaginatedList of result objects.
Throws:: SQLException - If an error occurs.

queryForMap

public Map queryForMap(String id,
                       Object paramObject,
                       String keyProp)
                throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryForMap in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; paramObject - The parameter object (e.g. JavaBean, Map, XML etc.).; keyProp - The property to be used as the key in the Map.
Returns:: A Map keyed by keyProp with values being the result object instance.
Throws:: SQLException - If an error occurs.

queryForMap

public Map queryForMap(String id,
                       Object paramObject,
                       String keyProp,
                       String valueProp)
                throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryForMap in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; paramObject - The parameter object (e.g. JavaBean, Map, XML etc.).; keyProp - The property to be used as the key in the Map.; valueProp - The property to be used as the value in the Map.
Returns:: A Map keyed by keyProp with values of valueProp.
Throws:: SQLException - If an error occurs.

queryWithRowHandler

public void queryWithRowHandler(String id,
                                Object paramObject,
                                RowHandler rowHandler)
                         throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryWithRowHandler in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; paramObject - The parameter object (e.g. JavaBean, Map, XML etc.).; rowHandler - A RowHandler instance
Throws:: SQLException - If an error occurs.

queryWithRowHandler

public void queryWithRowHandler(String id,
                                RowHandler rowHandler)
                         throws SQLException

Description copied from interface: SqlMapExecutor

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.

Specified by:: queryWithRowHandler in interface SqlMapExecutor

Parameters:: id - The name of the statement to execute.; rowHandler - A RowHandler instance
Throws:: SQLException - If an error occurs.

startTransaction

public void startTransaction()
                      throws SQLException

Description copied from interface: SqlMapTransactionManager

Demarcates the beginning of a transaction scope. Transactions must be properly committed or rolled back to be effective. Use the following pattern when working with transactions:

 try {
   sqlMap.startTransaction();
   // do work
   sqlMap.commitTransaction();
 } finally {
   sqlMap.endTransaction();
 }

Always call endTransaction() once startTransaction() has been called.

Specified by:: startTransaction in interface SqlMapTransactionManager

Throws:: SQLException - If an error occurs while starting the transaction, or the transaction could not be started.

startTransaction

public void startTransaction(int transactionIsolation)
                      throws SQLException

Description copied from interface: SqlMapTransactionManager

Demarcates the beginning of a transaction scope using the specified transaction isolation. Transactions must be properly committed or rolled back to be effective. Use the following pattern when working with transactions:

 try {
   sqlMap.startTransaction(Connection.TRANSACTION_REPEATABLE_READ);
   // do work
   sqlMap.commitTransaction();
 } finally {
   sqlMap.endTransaction();
 }

Always call endTransaction() once startTransaction() has been called.

Specified by:: startTransaction in interface SqlMapTransactionManager

Throws:: SQLException - If an error occurs while starting the transaction, or the transaction could not be started.

commitTransaction

public void commitTransaction()
                       throws SQLException

Description copied from interface: SqlMapTransactionManager

Commits the currently started transaction.

Specified by:: commitTransaction in interface SqlMapTransactionManager

Throws:: SQLException - If an error occurs while committing the transaction, or the transaction could not be committed.

endTransaction

public void endTransaction()
                    throws SQLException

Description copied from interface: SqlMapTransactionManager

Ends a transaction and rolls back if necessary. If the transaction has been started, but not committed, it will be rolled back upon calling endTransaction().

Specified by:: endTransaction in interface SqlMapTransactionManager

Throws:: SQLException - If an error occurs during rollback or the transaction could not be ended.

startBatch

public void startBatch()
                throws SQLException

Description copied from interface: SqlMapExecutor

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).

Specified by:: startBatch in interface SqlMapExecutor

Throws:: SQLException - If the batch could not be started.

executeBatch

public int executeBatch()
                 throws SQLException

Description copied from interface: SqlMapExecutor

Executes (flushes) all statements currently batched.

Specified by:: executeBatch in interface SqlMapExecutor

Returns:: the number of rows updated in the batch
Throws:: SQLException - If the batch could not be executed or if any of the statements fails.

executeBatchDetailed

public List executeBatchDetailed()
                          throws SQLException,
                                 BatchException

Description copied from interface: SqlMapExecutor

Executes (flushes) all statements currently batched.

Specified by:: executeBatchDetailed in interface SqlMapExecutor

Returns:: a List of BatchResult objects. There will be one element in the list for each sub-batch executed. A sub-batch is created by adding a statement to the batch that does not equal the prior statement.
Throws:: SQLException - if a database access error occurs, or the drive does not support batch statements; BatchException - if the driver throws BatchUpdateException
See Also:: BatchException

setUserConnection

public void setUserConnection(Connection connection)
                       throws SQLException

Description copied from interface: SqlMapTransactionManager

Allows the developer to easily use an externally supplied connection when executing statements.

Important: Using a user supplied connection basically sidesteps the transaction manager, so you are responsible for appropriately. Here's a (very) simple example (throws SQLException):

 try {
   Connection connection = dataSource.getConnection();
   sqlMap.setUserConnection(connection);
   // do work
   connection.commit();
 } catch (SQLException e) {
     try {
       if (connection != null) commit.rollback();
     } catch (SQLException ignored) {
       // generally ignored
     }
     throw e;  // rethrow the exception
 } finally {
   try {
     if (connection != null) connection.close();
   } catch (SQLException ignored) {
     // generally ignored
   }
 }

Specified by:: setUserConnection in interface SqlMapTransactionManager

Throws:: SQLException

getUserConnection

public Connection getUserConnection()
                             throws SQLException

Deprecated.

TODO Deprecated

Specified by:: getUserConnection in interface SqlMapTransactionManager

Returns:: Current connection
Throws:: SQLException

getCurrentConnection

public Connection getCurrentConnection()
                                throws SQLException

Description copied from interface: SqlMapTransactionManager

Returns the current connection in use. If no connection exists null will be returned. There may be no connection if no transaction has been started, and if no user provided connection has been set.

Specified by:: getCurrentConnection in interface SqlMapTransactionManager

Returns:: The current connection or null.
Throws:: SQLException

getDataSource

public DataSource getDataSource()

Description copied from interface: SqlMapTransactionManager

Returns the DataSource instance currently being used by the SqlMapSession.

Specified by:: getDataSource in interface SqlMapTransactionManager

Returns:: The DataSource instance currently being used by the SqlMapSession.

getMappedStatement

public MappedStatement getMappedStatement(String id)

Gets a mapped statement by ID

Parameters:: id - - the ID
Returns:: - the mapped statement

isLazyLoadingEnabled

public boolean isLazyLoadingEnabled()

Get the status of lazy loading

Returns:: - the status

isEnhancementEnabled

public boolean isEnhancementEnabled()

Get the status of CGLib enhancements

Returns:: - the status

getSqlExecutor

public SqlExecutor getSqlExecutor()

Get the SQL executor

Returns:: - the executor

getDelegate

public SqlMapExecutorDelegate getDelegate()

Get the delegate

Returns:: - the delegate

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibatis.sqlmap.engine.impl Class SqlMapSessionImpl

delegate

sessionScope

closed

SqlMapSessionImpl

open

isClosed

close

insert

insert

update

update

delete

delete

queryForObject

queryForObject

queryForObject

queryForList

queryForList

queryForList

queryForList

queryForPaginatedList

queryForPaginatedList

queryForMap

queryForMap

queryWithRowHandler

queryWithRowHandler

startTransaction

startTransaction

commitTransaction

endTransaction

startBatch

executeBatch

executeBatchDetailed

setUserConnection

getUserConnection

getCurrentConnection

getDataSource

getMappedStatement

isLazyLoadingEnabled

isEnhancementEnabled

getSqlExecutor

getDelegate

com.ibatis.sqlmap.engine.impl
Class SqlMapSessionImpl