org.nuiton.spgeed

Class SqlSession

java.lang.Object

org.nuiton.spgeed.SqlSession

All Implemented Interfaces:

AutoCloseable

public class SqlSession
extends Object
implements AutoCloseable

Represents your connection and the transaction on the database. Be carful, you need to close the current session, after each use.

Author:

julien

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassCreator	classCreator Use to generate proxy on the dao
protected Connection	connection Current JDBC connection
protected DataSource	dataSource Current datasource
protected Class<? extends SpgeedMapper>	defaultMapper Use to set a default Mapper
protected String	defaultTimeOutLimit Use to set a default limit of time for PostgreSQL request
protected Map<String,PipeFunction>	pipeFunctions Current pipe functions available

Constructor Summary

Constructors

Constructor and Description
SqlSession()
SqlSession(DataSource dataSource) Create session from a datasource
SqlSession(String url, String username, String password) Create session from url, username and password

Method Summary

Modifier and Type	Method and Description
void	addFunction(Map<String,PipeFunction> functions)
void	addFunction(String name, PipeFunction function)
void	close() Close the current transaction.
void	commit() Commit the current transaction.
boolean	execute(String sql, Map<String,Object> parameters, String... roles)
<E> E	executeQuery(String sql, Map<String,Object> parameters, Class<E> returnClass, String... roles)
int	executeUpdate(String sql, Map<String,Object> parameters, String... roles)
Connection	getConnection() Use to get the current transaction when the SQL statements is executed.
<E> E	getDao(Class<E> klass, Object... args) Get a current dao plug on the session.
DataSource	getDataSource()
Class<? extends SpgeedMapper>	getDefaultMapper() Get the actual default mapper
String	getDefaultTimeOutLimit() Get the actual default limit of time for PostgreSQL request
Map<String,PipeFunction>	getPipeFunctions()
void	rollback() Rollback the current transaction.
void	setDefaultMapper(Class<? extends SpgeedMapper> defaultMapper) Set a default mapper
void	setDefaultTimeOutLimit(String defaultTimeOutLimit) Use to set a default limit of time for PostgreSQL request

Methods inherited from class java.lang.Object

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

Field Detail

pipeFunctions

protected Map<String,PipeFunction> pipeFunctions

Current pipe functions available

dataSource

protected DataSource dataSource

Current datasource

connection

protected Connection connection

Current JDBC connection

classCreator

protected ClassCreator classCreator

Use to generate proxy on the dao

defaultTimeOutLimit

protected String defaultTimeOutLimit

Use to set a default limit of time for PostgreSQL request

defaultMapper

protected Class<? extends SpgeedMapper> defaultMapper

Use to set a default Mapper

Constructor Detail

SqlSession

public SqlSession()

SqlSession

public SqlSession(String url,
                  String username,
                  String password)

Create session from url, username and password

SqlSession

public SqlSession(DataSource dataSource)

Create session from a datasource

Method Detail

getDefaultMapper

public Class<? extends SpgeedMapper> getDefaultMapper()

Get the actual default mapper

Returns:

the actual default limit

setDefaultMapper

public void setDefaultMapper(Class<? extends SpgeedMapper> defaultMapper)

Set a default mapper

Parameters:

defaultMapper - class wanted as default mapper

getDefaultTimeOutLimit

public String getDefaultTimeOutLimit()

Get the actual default limit of time for PostgreSQL request

Returns:

the actual default limit

setDefaultTimeOutLimit

public void setDefaultTimeOutLimit(String defaultTimeOutLimit)

Use to set a default limit of time for PostgreSQL request

Parameters:

defaultTimeOutLimit - time wanted as default limit

getDataSource

public DataSource getDataSource()

addFunction

public void addFunction(String name,
                        PipeFunction function)

addFunction

public void addFunction(Map<String,PipeFunction> functions)

getPipeFunctions

public Map<String,PipeFunction> getPipeFunctions()

getConnection

public Connection getConnection()
                         throws SQLException

Use to get the current transaction when the SQL statements is executed.

Throws:

SQLException

commit

public void commit()
            throws SQLException

Commit the current transaction.

Throws:

SQLException

rollback

public void rollback()
              throws SQLException

Rollback the current transaction.

Throws:

SQLException

close

public void close()
           throws SQLException

Close the current transaction.

Specified by:

close in interface AutoCloseable

Throws:

SQLException

getDao

public <E> E getDao(Class<E> klass,
                    Object... args)

Get a current dao plug on the session.

Parameters:

klass - class of Dao wanted

args - args use to create dao, dao must has constructor with that args

executeQuery

public <E> E executeQuery(String sql,
                          Map<String,Object> parameters,
                          Class<E> returnClass,
                          String... roles)
                   throws Exception

Throws:

Exception

executeUpdate

public int executeUpdate(String sql,
                         Map<String,Object> parameters,
                         String... roles)
                  throws Exception

Throws:

Exception

execute

public boolean execute(String sql,
                       Map<String,Object> parameters,
                       String... roles)
                throws Exception

Throws:

Exception