org.apache.ibatis.session
Class SqlSessionManager

java.lang.Object
  extended by org.apache.ibatis.session.SqlSessionManager
All Implemented Interfaces:
SqlSession, SqlSessionFactory

public class SqlSessionManager
extends Object
implements SqlSessionFactory, SqlSession


Method Summary
 void clearCache()
          Clears local session cache
 void close()
          Closes the session
 void commit()
          Flushes batch statements and commits database connection.
 void commit(boolean force)
          Flushes batch statements and commits database connection.
 int delete(String statement)
          Execute a delete statement.
 int delete(String statement, Object parameter)
          Execute a delete statement.
 List<BatchResult> flushStatements()
          Flushes batch statements.
 Configuration getConfiguration()
          Retrieves current configuration
 Connection getConnection()
          Retrieves inner database connection
<T> T
getMapper(Class<T> type)
          Retrieves a mapper.
 int insert(String statement)
          Execute an insert statement.
 int insert(String statement, Object parameter)
          Execute an insert statement with the given parameter object.
 boolean isManagedSessionStarted()
           
static SqlSessionManager newInstance(InputStream inputStream)
           
static SqlSessionManager newInstance(InputStream inputStream, Properties properties)
           
static SqlSessionManager newInstance(InputStream inputStream, String environment)
           
static SqlSessionManager newInstance(Reader reader)
           
static SqlSessionManager newInstance(Reader reader, Properties properties)
           
static SqlSessionManager newInstance(Reader reader, String environment)
           
static SqlSessionManager newInstance(SqlSessionFactory sqlSessionFactory)
           
 SqlSession openSession()
           
 SqlSession openSession(boolean autoCommit)
           
 SqlSession openSession(Connection connection)
           
 SqlSession openSession(ExecutorType execType)
           
 SqlSession openSession(ExecutorType execType, boolean autoCommit)
           
 SqlSession openSession(ExecutorType execType, Connection connection)
           
 SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level)
           
 SqlSession openSession(TransactionIsolationLevel level)
           
 void rollback()
          Discards pending batch statements and rolls database connection back.
 void rollback(boolean force)
          Discards pending batch statements and rolls database connection back.
 void select(String statement, Object parameter, ResultHandler handler)
          Retrieve a single row mapped from the statement key and parameter using a ResultHandler.
 void select(String statement, Object parameter, RowBounds rowBounds, ResultHandler handler)
          Retrieve a single row mapped from the statement key and parameter using a ResultHandler and RowBounds
 void select(String statement, ResultHandler handler)
          Retrieve a single row mapped from the statement using a ResultHandler.
<E> List<E>
selectList(String statement)
          Retrieve a list of mapped objects from the statement key and parameter.
<E> List<E>
selectList(String statement, Object parameter)
          Retrieve a list of mapped objects from the statement key and parameter.
<E> List<E>
selectList(String statement, Object parameter, RowBounds rowBounds)
          Retrieve a list of mapped objects from the statement key and parameter, within the specified row bounds.
<K,V> Map<K,V>
selectMap(String statement, Object parameter, String mapKey)
          The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.
<K,V> Map<K,V>
selectMap(String statement, Object parameter, String mapKey, RowBounds rowBounds)
          The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.
<K,V> Map<K,V>
selectMap(String statement, String mapKey)
          The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.
<T> T
selectOne(String statement)
          Retrieve a single row mapped from the statement key
<T> T
selectOne(String statement, Object parameter)
          Retrieve a single row mapped from the statement key and parameter.
 void startManagedSession()
           
 void startManagedSession(boolean autoCommit)
           
 void startManagedSession(Connection connection)
           
 void startManagedSession(ExecutorType execType)
           
 void startManagedSession(ExecutorType execType, boolean autoCommit)
           
 void startManagedSession(ExecutorType execType, Connection connection)
           
 void startManagedSession(ExecutorType execType, TransactionIsolationLevel level)
           
 void startManagedSession(TransactionIsolationLevel level)
           
 int update(String statement)
          Execute an update statement.
 int update(String statement, Object parameter)
          Execute an update statement.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

newInstance

public static SqlSessionManager newInstance(Reader reader)

newInstance

public static SqlSessionManager newInstance(Reader reader,
                                            String environment)

newInstance

public static SqlSessionManager newInstance(Reader reader,
                                            Properties properties)

newInstance

public static SqlSessionManager newInstance(InputStream inputStream)

newInstance

public static SqlSessionManager newInstance(InputStream inputStream,
                                            String environment)

newInstance

public static SqlSessionManager newInstance(InputStream inputStream,
                                            Properties properties)

newInstance

public static SqlSessionManager newInstance(SqlSessionFactory sqlSessionFactory)

startManagedSession

public void startManagedSession()

startManagedSession

public void startManagedSession(boolean autoCommit)

startManagedSession

public void startManagedSession(Connection connection)

startManagedSession

public void startManagedSession(TransactionIsolationLevel level)

startManagedSession

public void startManagedSession(ExecutorType execType)

startManagedSession

public void startManagedSession(ExecutorType execType,
                                boolean autoCommit)

startManagedSession

public void startManagedSession(ExecutorType execType,
                                TransactionIsolationLevel level)

startManagedSession

public void startManagedSession(ExecutorType execType,
                                Connection connection)

isManagedSessionStarted

public boolean isManagedSessionStarted()

openSession

public SqlSession openSession()
Specified by:
openSession in interface SqlSessionFactory

openSession

public SqlSession openSession(boolean autoCommit)
Specified by:
openSession in interface SqlSessionFactory

openSession

public SqlSession openSession(Connection connection)
Specified by:
openSession in interface SqlSessionFactory

openSession

public SqlSession openSession(TransactionIsolationLevel level)
Specified by:
openSession in interface SqlSessionFactory

openSession

public SqlSession openSession(ExecutorType execType)
Specified by:
openSession in interface SqlSessionFactory

openSession

public SqlSession openSession(ExecutorType execType,
                              boolean autoCommit)
Specified by:
openSession in interface SqlSessionFactory

openSession

public SqlSession openSession(ExecutorType execType,
                              TransactionIsolationLevel level)
Specified by:
openSession in interface SqlSessionFactory

openSession

public SqlSession openSession(ExecutorType execType,
                              Connection connection)
Specified by:
openSession in interface SqlSessionFactory

getConfiguration

public Configuration getConfiguration()
Description copied from interface: SqlSession
Retrieves current configuration

Specified by:
getConfiguration in interface SqlSession
Specified by:
getConfiguration in interface SqlSessionFactory
Returns:
Configuration

selectOne

public <T> T selectOne(String statement)
Description copied from interface: SqlSession
Retrieve a single row mapped from the statement key

Specified by:
selectOne in interface SqlSession
Type Parameters:
T - the returned object type
Returns:
Mapped object

selectOne

public <T> T selectOne(String statement,
                       Object parameter)
Description copied from interface: SqlSession
Retrieve a single row mapped from the statement key and parameter.

Specified by:
selectOne in interface SqlSession
Type Parameters:
T - the returned object type
Parameters:
statement - Unique identifier matching the statement to use.
parameter - A parameter object to pass to the statement.
Returns:
Mapped object

selectMap

public <K,V> Map<K,V> selectMap(String statement,
                                String mapKey)
Description copied from interface: SqlSession
The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects. Eg. Return a of Map[Integer,Author] for selectMap("selectAuthors","id")

Specified by:
selectMap in interface SqlSession
Type Parameters:
K - the returned Map keys type
V - the returned Map values type
Parameters:
statement - Unique identifier matching the statement to use.
mapKey - The property to use as key for each value in the list.
Returns:
Map containing key pair data.

selectMap

public <K,V> Map<K,V> selectMap(String statement,
                                Object parameter,
                                String mapKey)
Description copied from interface: SqlSession
The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.

Specified by:
selectMap in interface SqlSession
Type Parameters:
K - the returned Map keys type
V - the returned Map values type
Parameters:
statement - Unique identifier matching the statement to use.
parameter - A parameter object to pass to the statement.
mapKey - The property to use as key for each value in the list.
Returns:
Map containing key pair data.

selectMap

public <K,V> Map<K,V> selectMap(String statement,
                                Object parameter,
                                String mapKey,
                                RowBounds rowBounds)
Description copied from interface: SqlSession
The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects.

Specified by:
selectMap in interface SqlSession
Type Parameters:
K - the returned Map keys type
V - the returned Map values type
Parameters:
statement - Unique identifier matching the statement to use.
parameter - A parameter object to pass to the statement.
mapKey - The property to use as key for each value in the list.
rowBounds - Bounds to limit object retrieval
Returns:
Map containing key pair data.

selectList

public <E> List<E> selectList(String statement)
Description copied from interface: SqlSession
Retrieve a list of mapped objects from the statement key and parameter.

Specified by:
selectList in interface SqlSession
Type Parameters:
E - the returned list element type
Parameters:
statement - Unique identifier matching the statement to use.
Returns:
List of mapped object

selectList

public <E> List<E> selectList(String statement,
                              Object parameter)
Description copied from interface: SqlSession
Retrieve a list of mapped objects from the statement key and parameter.

Specified by:
selectList in interface SqlSession
Type Parameters:
E - the returned list element type
Parameters:
statement - Unique identifier matching the statement to use.
parameter - A parameter object to pass to the statement.
Returns:
List of mapped object

selectList

public <E> List<E> selectList(String statement,
                              Object parameter,
                              RowBounds rowBounds)
Description copied from interface: SqlSession
Retrieve a list of mapped objects from the statement key and parameter, within the specified row bounds.

Specified by:
selectList in interface SqlSession
Type Parameters:
E - the returned list element type
Parameters:
statement - Unique identifier matching the statement to use.
parameter - A parameter object to pass to the statement.
rowBounds - Bounds to limit object retrieval
Returns:
List of mapped object

select

public void select(String statement,
                   ResultHandler handler)
Description copied from interface: SqlSession
Retrieve a single row mapped from the statement using a ResultHandler.

Specified by:
select in interface SqlSession
Parameters:
statement - Unique identifier matching the statement to use.
handler - ResultHandler that will handle each retrieved row

select

public void select(String statement,
                   Object parameter,
                   ResultHandler handler)
Description copied from interface: SqlSession
Retrieve a single row mapped from the statement key and parameter using a ResultHandler.

Specified by:
select in interface SqlSession
Parameters:
statement - Unique identifier matching the statement to use.
parameter - A parameter object to pass to the statement.
handler - ResultHandler that will handle each retrieved row

select

public void select(String statement,
                   Object parameter,
                   RowBounds rowBounds,
                   ResultHandler handler)
Description copied from interface: SqlSession
Retrieve a single row mapped from the statement key and parameter using a ResultHandler and RowBounds

Specified by:
select in interface SqlSession
Parameters:
statement - Unique identifier matching the statement to use.
rowBounds - RowBound instance to limit the query results
handler - ResultHandler that will handle each retrieved row

insert

public int insert(String statement)
Description copied from interface: SqlSession
Execute an insert statement.

Specified by:
insert in interface SqlSession
Parameters:
statement - Unique identifier matching the statement to execute.
Returns:
int The number of rows affected by the insert.

insert

public int insert(String statement,
                  Object parameter)
Description copied from interface: SqlSession
Execute an insert statement with the given parameter object. Any generated autoincrement values or selectKey entries will modify the given parameter object properties. Only the number of rows affected will be returned.

Specified by:
insert in interface SqlSession
Parameters:
statement - Unique identifier matching the statement to execute.
parameter - A parameter object to pass to the statement.
Returns:
int The number of rows affected by the insert.

update

public int update(String statement)
Description copied from interface: SqlSession
Execute an update statement. The number of rows affected will be returned.

Specified by:
update in interface SqlSession
Parameters:
statement - Unique identifier matching the statement to execute.
Returns:
int The number of rows affected by the update.

update

public int update(String statement,
                  Object parameter)
Description copied from interface: SqlSession
Execute an update statement. The number of rows affected will be returned.

Specified by:
update in interface SqlSession
Parameters:
statement - Unique identifier matching the statement to execute.
parameter - A parameter object to pass to the statement.
Returns:
int The number of rows affected by the update.

delete

public int delete(String statement)
Description copied from interface: SqlSession
Execute a delete statement. The number of rows affected will be returned.

Specified by:
delete in interface SqlSession
Parameters:
statement - Unique identifier matching the statement to execute.
Returns:
int The number of rows affected by the delete.

delete

public int delete(String statement,
                  Object parameter)
Description copied from interface: SqlSession
Execute a delete statement. The number of rows affected will be returned.

Specified by:
delete in interface SqlSession
Parameters:
statement - Unique identifier matching the statement to execute.
parameter - A parameter object to pass to the statement.
Returns:
int The number of rows affected by the delete.

getMapper

public <T> T getMapper(Class<T> type)
Description copied from interface: SqlSession
Retrieves a mapper.

Specified by:
getMapper in interface SqlSession
Type Parameters:
T - the mapper type
Parameters:
type - Mapper interface class
Returns:
a mapper bound to this SqlSession

getConnection

public Connection getConnection()
Description copied from interface: SqlSession
Retrieves inner database connection

Specified by:
getConnection in interface SqlSession
Returns:
Connection

clearCache

public void clearCache()
Description copied from interface: SqlSession
Clears local session cache

Specified by:
clearCache in interface SqlSession

commit

public void commit()
Description copied from interface: SqlSession
Flushes batch statements and commits database connection. Note that database connection will not be committed if no updates/deletes/inserts were called. To force the commit call SqlSession.commit(boolean)

Specified by:
commit in interface SqlSession

commit

public void commit(boolean force)
Description copied from interface: SqlSession
Flushes batch statements and commits database connection.

Specified by:
commit in interface SqlSession
Parameters:
force - forces connection commit

rollback

public void rollback()
Description copied from interface: SqlSession
Discards pending batch statements and rolls database connection back. Note that database connection will not be rolled back if no updates/deletes/inserts were called. To force the rollback call SqlSession.rollback(boolean)

Specified by:
rollback in interface SqlSession

rollback

public void rollback(boolean force)
Description copied from interface: SqlSession
Discards pending batch statements and rolls database connection back. Note that database connection will not be rolled back if no updates/deletes/inserts were called.

Specified by:
rollback in interface SqlSession
Parameters:
force - forces connection rollback

flushStatements

public List<BatchResult> flushStatements()
Description copied from interface: SqlSession
Flushes batch statements.

Specified by:
flushStatements in interface SqlSession
Returns:
BatchResult list of updated records

close

public void close()
Description copied from interface: SqlSession
Closes the session

Specified by:
close in interface SqlSession


Copyright © 2010-2012 MyBatis.org. All Rights Reserved.