Session (Ujorm 1.71

java.lang.Object
- org.ujorm.orm.Session

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class Session
extends Object
implements Closeable
```
The ORM session.
Methods of the session are not thread safe.

Field Summary

Fields
Modifier and Type Field and Description

static String SQL_ILLEGAL
Exception SQL message prefix

Fields
Modifier and Type	Field and Description
`static String`	`SQL_ILLEGAL` Exception SQL message prefix

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Transaction`	`beginTransaction()` Create a new transaction or a sub-transaction.
`protected void`	`call(DbProcedure procedure)` Call the stored procedure
`void`	`clearCache()` Clear the cache.
`void`	`clearCache(CachePolicy policy)` Clear cache and change its policy.
`void`	`close()` Close and release all DB connections.
`void`	`commit()` Make a commit for all databases.
`void`	`commit(boolean commit)` Make commit/rollback for all 'production' databases.
`void`	`commitTransaction()` Make a commit om all databases for the current transaction level.
`protected org.ujorm.criterion.Criterion`	`createPkCriterion(OrmUjo bo)` Returns an criterion by a PrimaryKey
`<U extends OrmUjo> Query<U>`	`createQuery(Class<U> aClass)` Create query for all table rows.
`<U extends OrmUjo> Query<U>`	`createQuery(Class<U> aClass, org.ujorm.criterion.Criterion<U> criterion)` Deprecated. Use the method `createQuery(Criterion, Class)` rather.
`<U extends OrmUjo> Query<U>`	`createQuery(org.ujorm.criterion.Criterion<U> criterion)` The table class is derived from the first criterion column.
`<U extends OrmUjo> Query<U>`	`createQuery(org.ujorm.criterion.Criterion<U> criterion, Class<U> aClass)` Create query.
`<U extends OrmUjo> int`	`delete(Class<U> tableClass, org.ujorm.criterion.Criterion<U> criterion)` Delete all object object by the criterion from parameter.
`<U extends OrmUjo> int`	`delete(org.ujorm.criterion.Criterion<U> criterion)` Delete all object object by the criterion from parameter.
`<T extends OrmUjo> int`	`delete(List<T> bos)` Delete all objects of the same type from database.
`protected <U extends OrmUjo> int`	`delete(MetaTable tableModel, org.ujorm.criterion.Criterion<U> criterion)` Delete all objects object form parameter Warning: method does not remove deleted object from internal cache, however you can call method clearCache() to release all objects from the cache.
`int`	`delete(OrmUjo bo)` Delete an optional object from the parameters.
`<U extends OrmUjo> boolean`	`exists(Class<U> entity)` Returns `true` if exists any database row for the required entity.
`<U extends OrmUjo> boolean`	`exists(org.ujorm.criterion.Criterion<U> criterion)` Returns `true` if exists any database row with the required condition.
`protected <U extends OrmUjo> boolean`	`exists(MetaTable table, org.ujorm.criterion.Criterion<U> criterion, org.ujorm.Key pk)` Returns `true` if exists any database row for the required criterion.
`OrmUjo`	`findCache(Class type, Object... pkeys)` Find object from internal cache
`OrmUjo`	`findCache(Class type, Object pkey)` Find object from internal cache
`MetaRelation2Many`	`getBasicColumn(org.ujorm.criterion.Criterion criterion)` Returns the first "basic" column of criterion.
`Connection`	`getConnection(int databaseIndex, boolean toModify)` Get a Connection for a required databse by a database order number (index).
`Connection`	`getConnection(MetaDatabase database, boolean toModify)` Get or create a Connection for a required database with an autocommit na false.
`<DB extends OrmUjo> DB`	`getDatabase(Class<DB> dbType)` Returns a Database instance.
`SqlDialect`	`getDialect(Class<? extends OrmUjo> ormType)` Check dialect type
`Connection`	`getFirstConnection()` Get the first Connection where an autocommit is set to false.
`Connection`	`getFirstConnection(boolean toModify)` Get the first Connection where an autocommit is set to false.
`<DB extends OrmUjo> DB`	`getFirstDatabase()` Returns the first Database instance.
`OrmHandler`	`getHandler()` Returns a handler
`LazyLoading`	`getLazyLoading()` Enable a lazy-loading of related Ujo object.
`protected List<MetaColumn>`	`getOrmColumns(org.ujorm.Key... keys)` Convert a key array to a column list.
`MetaParams`	`getParameters()` Returns parameters
`<U extends OrmUjo> long`	`getRowCount(Query<U> query)` Returns a count of rows
`Connection`	`getSeqConnection(MetaDatabase database)` Get sequence connection for a required database with an autocommit na false.
`JdbcStatement`	`getStatement(MetaDatabase database, CharSequence sql, boolean toModify)` Create new statement and assigng Savepoint for a trnasaction sase.
`JdbcStatement`	`getStatement(Query query)` Run SQL SELECT by query.
`JdbcStatement`	`getStatementCallable(MetaDatabase database, String sql, boolean toModify)` Create new statement
`Transaction`	`getTransaction()` Returns the current transaction
`boolean`	`hasDialect(Class<? extends OrmUjo> ormType, Class<? extends SqlDialect>... dialects)` Returns true, if ORM type have got any from listed dialects
`protected void`	`checkNotNull(OrmUjo ujo, String action)` Check the Ujo object to not null.
`boolean`	`isClosed()` Is the session closed?
`boolean`	`isRollbackOnly()` The rollback is allowed only.
`<U extends OrmUjo> UjoIterator<U>`	`iterateInternal(RelationToMany key, OrmUjo value)` Iterate key of values
`<U extends OrmUjo> U`	`load(Class<U> tableType, Object id)` Load UJO by a unique id.
`<U extends OrmUjo> U`	`loadBy(U ujo)` Load UJO by a unique id.
`<U extends OrmUjo> U`	`loadInternal(org.ujorm.Key relatedProperty, Object id, boolean mandatory)` Load UJO by a unique id.
`void`	`markForRolback()`
`static Session`	`newClosedSession(OrmHandler handler)` Create the closed session
`ForeignKey`	`readFK(OrmUjo ujo, org.ujorm.Key<?,? extends OrmUjo> key)` Build new Foreign key.
`boolean`	`reload(OrmUjo ujo)` Reload values of the persistent object.
`void`	`rollback()` Make a rollback for all databases.
`void`	`rollbackTransaction()` Make a rollback on all databases for the current transaction level.
`void`	`save(List<? extends OrmUjo> bos)` INSERT object into table using the Multirow inserts.
`void`	`save(List<? extends OrmUjo> bos, int multiLimit)` INSERT object into table using the Multirow inserts.
`void`	`save(OrmUjo bo)` Save all persistent attributes into DB table by an INSERT SQL statement.
`void`	`saveOrUpdate(OrmUjo bo)` Make a statement INSERT or UPDATE into a database table according to attribute `Session`.
`void`	`setLazyLoading(LazyLoading lazyLoadingEnabled)` Enable a lazy-loading of related Ujo object.
`int`	`update(OrmUjo bo)` Database UPDATE of the `modified columns` for the selected object.
`<U extends OrmUjo> int`	`update(U bo, org.ujorm.criterion.Criterion<U> criterion)` Database Batch UPDATE of the `modified columns` along a criterion.

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

- Field Detail
 - SQL_ILLEGAL
```
public static final String SQL_ILLEGAL
```
 Exception SQL message prefix
 
 See Also:
 
 Constant Field Values
- Method Detail
 - beginTransaction
```
public Transaction beginTransaction()
 throws IllegalStateException
```
 Create a new transaction or a sub-transaction.
 
 Returns:
 
 Create new (sub) transaction
 
 Throws:
 
 IllegalStateException - Throw the Exception if a Transaction is running
 - getTransaction
```
public Transaction getTransaction()
```
 Returns the current transaction
 
 Returns:
 
 Return null if no transaction is running.
 - getHandler
```
public final OrmHandler getHandler()
```
 Returns a handler
 - commitTransaction
```
public void commitTransaction()
```
 Make a commit om all databases for the current transaction level.
 - commit
```
public void commit()
```
 Make a commit for all databases.
 - rollbackTransaction
```
public void rollbackTransaction()
```
 Make a rollback on all databases for the current transaction level.
 - rollback
```
public final void rollback()
```
 Make a rollback for all databases.
 - commit
```
public final void commit(boolean commit)
 throws IllegalStateException
```
 Make commit/rollback for all 'production' databases.
 
 Parameters:
 
 commit - if parameters is false than make a rollback.
 
 Throws:
 
 IllegalStateException
 - createQuery
```
public  Query createQuery(Class aClass)
```
 Create query for all table rows.
 - createQuery
```
@Deprecated
public final  Query createQuery(Class aClass,
 org.ujorm.criterion.Criterion criterion)
```
 Deprecated. Use the method createQuery(Criterion, Class) rather.
 
 Create query.
 
 See Also:
 
 createQuery(org.ujorm.criterion.Criterion, java.lang.Class), createQuery(org.ujorm.criterion.Criterion)
 - createQuery
```
public final  Query createQuery(org.ujorm.criterion.Criterion criterion,
 Class aClass)
```
 Create query. This method has a slightly higher performance than the method createQuery(Criterion) without the Class parameter.
 
 See Also:
 
 createQuery(org.ujorm.criterion.Criterion)
 - createQuery
```
public final  Query createQuery(org.ujorm.criterion.Criterion criterion)
```
 The table class is derived from the first criterion column.
 - exists
```
public final  boolean exists(org.ujorm.criterion.Criterion criterion)
```
 Returns true if exists any database row with the required condition.
 - exists
```
public final  boolean exists(Class entity)
```
 Returns true if exists any database row for the required entity.
 - exists
```
protected final  boolean exists(MetaTable table,
 org.ujorm.criterion.Criterion criterion,
 org.ujorm.Key pk)
```
 Returns true if exists any database row for the required criterion.
 - getBasicColumn
```
public MetaRelation2Many getBasicColumn(org.ujorm.criterion.Criterion criterion)
```
 Returns the first "basic" column of criterion.
 
 Returns:
 
 Not null result
 - getFirstDatabase
```
public final <DB extends OrmUjo> DB getFirstDatabase()
```
 Returns the first Database instance.
 - getDatabase
```
public <DB extends OrmUjo> DB getDatabase(Class<DB> dbType)
```
 Returns a Database instance. If parameter is null, than method returns the first database.
 - saveOrUpdate
```
public void saveOrUpdate(OrmUjo bo)
 throws IllegalStateException
```
 Make a statement INSERT or UPDATE into a database table according to attribute Session. Related objects must be saved using an another call of the method. The method cleans all flags of modified attributes.
 
 Throws:
 
 IllegalStateException
 - save
```
public void save(List<? extends OrmUjo> bos)
 throws IllegalStateException
```
 INSERT object into table using the Multirow inserts.
 
 Parameters:
 
 bos - Business objects
 
 Throws:
 
 IllegalStateException
 
 See Also:
 
 MetaParams.INSERT_MULTIROW_ITEM_LIMIT
 - save
```
public void save(List<? extends OrmUjo> bos,
 int multiLimit)
 throws org.ujorm.core.IllegalUjormException
```
 INSERT object into table using the Multirow inserts. The method cleans all flags of modified attributes.
 
 Parameters:
 
 bos - List of the business object of the same class. If the list must not contain object of different types
 
 multiLimit - Row limit for the one insert. If the value will be out of range <1,bos.size()> than the value will be corrected. If the list item count is greater than multi limit so insert will be separated by more multirow inserts.
 
 Throws:
 
 IllegalStateException
 
 org.ujorm.core.IllegalUjormException
 - save
```
public void save(OrmUjo bo)
 throws IllegalStateException
```
 Save all persistent attributes into DB table by an INSERT SQL statement. The method cleans all flags of modified attributes.
 
 Throws:
 
 IllegalStateException
 - update
```
public int update(OrmUjo bo)
 throws IllegalStateException
```
 Database UPDATE of the modified columns for the selected object. The method cleans all flags of modified attributes.
 
 Returns:
 
 The row count.
 
 Throws:
 
 IllegalStateException
 
 See Also:
 
 OrmUjo.readChangedProperties(boolean)
 - update
```
public  int update(U bo,
 org.ujorm.criterion.Criterion criterion)
```
 Database Batch UPDATE of the modified columns along a criterion. The method cleans all flags of modified attributes.
 Warning: method does affect to parent objects, see the MetaParams.INHERITANCE_MODE for more information.
 
 Returns:
 
 The row count.
 
 See Also:
 
 OrmUjo.readChangedProperties(boolean)
 - delete
```
public  int delete(org.ujorm.criterion.Criterion criterion)
```
 Delete all object object by the criterion from parameter.
 Warning 1: method does not remove deleted object from internal cache, however you can call method clearCache() to release all objects from the cache.
 Warning 2: method does not delete parent objects, see the MetaParams.INHERITANCE_MODE for more information.
 
 Parameters:
 
 criterion - filter for deleting tables.
 
 Returns:
 
 Returns a number of the really deleted objects.
 - delete
```
public int delete(OrmUjo bo)
```
 Delete an optional object from the parameters.
 
 Parameters:
 
 bo - Business object to delete, or the null argument as a result of some nullable relation.
 
 Returns:
 
 Returns a number of the removing items or the zero if the argumetn is null.
 - delete
```
public <T extends OrmUjo> int delete(List<T> bos)
```
 Delete all objects of the same type from database.
 
 Parameters:
 
 bos - Business objects to delete, the the null argument is not allowed and the null items are not allowed too.
 
 Returns:
 
 Returns a number of the removing items or the zero if the argumetn is empty.
 - delete
```
public  int delete(Class tableClass,
 org.ujorm.criterion.Criterion criterion)
```
 Delete all object object by the criterion from parameter.
 Warning: method does not remove deleted object from internal cache, however you can call method clearCache() to release all objects from the cache.
 
 Parameters:
 
 tableClass - Type of table to delete
 
 criterion - filter for deleting tables.
 
 Returns:
 
 Returns a number of the really deleted objects.
 - delete
```
protected  int delete(MetaTable tableModel,
 org.ujorm.criterion.Criterion criterion)
```
 Delete all objects object form parameter
 Warning: method does not remove deleted object from internal cache, however you can call method clearCache() to release all objects from the cache.
 
 Parameters:
 
 tableModel - Type of table to delete
 
 criterion - filter for deleting tables.
 
 Returns:
 
 Returns a number of the really deleted objects.
 - call
```
protected void call(DbProcedure procedure)
```
 Call the stored procedure
 - getOrmColumns
```
protected List<MetaColumn> getOrmColumns(org.ujorm.Key... keys)
```
 Convert a key array to a column list.
 - createPkCriterion
```
protected org.ujorm.criterion.Criterion createPkCriterion(OrmUjo bo)
```
 Returns an criterion by a PrimaryKey
 - getRowCount
```
public  long getRowCount(Query query)
```
 Returns a count of rows
 - getStatement
```
public JdbcStatement getStatement(Query query)
```
 Run SQL SELECT by query.
 - iterateInternal
```
public  UjoIterator iterateInternal(RelationToMany key,
 OrmUjo value)
```
 Iterate key of values
 
 Parameters:
 
 key - Table key type of the RelationToMany.
 
 value - A value type of OrmUjo
 - getFirstConnection
```
public final Connection getFirstConnection()
 throws IllegalStateException
```
 Get the first Connection where an autocommit is set to false.
 
 Throws:
 
 IllegalStateException
 - getFirstConnection
```
public final Connection getFirstConnection(boolean toModify)
 throws IllegalStateException
```
 Get the first Connection where an autocommit is set to false.
 
 Parameters:
 
 toModify - By the value false is disabled to assign savepoints in an active transaction.
 
 Throws:
 
 IllegalStateException
 - getConnection
```
public final Connection getConnection(int databaseIndex,
 boolean toModify)
 throws IllegalStateException
```
 Get a Connection for a required databse by a database order number (index). The autocommit is set to false.
 
 Parameters:
 
 databaseIndex - The first database have got the index value: 0 .
 
 toModify - By the value false is disabled to assign savepoints in an active transaction.
 
 Throws:
 
 IllegalStateException
 - getConnection
```
public final Connection getConnection(MetaDatabase database,
 boolean toModify)
 throws IllegalStateException
```
 Get or create a Connection for a required database with an autocommit na false. If a transaction is running, than assign savepoints.
 
 Parameters:
 
 database - Database meta-model
 
 toModify - By the value false is disabled to assign savepoints in an active transaction.
 
 Throws:
 
 IllegalStateException - An envelope for a run-time SQL exception
 - getSeqConnection
```
public final Connection getSeqConnection(MetaDatabase database)
 throws IllegalStateException
```
 Get sequence connection for a required database with an autocommit na false. For internal use only.
 
 Throws:
 
 IllegalStateException
 - getStatement
```
public JdbcStatement getStatement(MetaDatabase database,
 CharSequence sql,
 boolean toModify)
 throws SQLException
```
 Create new statement and assigng Savepoint for a trnasaction sase.
 
 Throws:
 
 SQLException
 - getStatementCallable
```
public JdbcStatement getStatementCallable(MetaDatabase database,
 String sql,
 boolean toModify)
 throws SQLException
```
 Create new statement
 
 Throws:
 
 SQLException
 - load
```
public  U load(Class tableType,
 Object id)
 throws NoSuchElementException
```
 Load UJO by a unique id. If a result is not found then a null value is passed.
 
 Parameters:
 
 tableType - Type of Ujo
 
 id - Value ID
 
 Throws:
 
 NoSuchElementException
 - loadBy
```
public  U loadBy(U ujo)
 throws NoSuchElementException
```
 Load UJO by a unique id. If primary key is null or no result is found then the null value is returned.
 
 Parameters:
 
 ujo - Ujo object
 
 Throws:
 
 NoSuchElementException
 - reload
```
public boolean reload(OrmUjo ujo)
```
 Reload values of the persistent object.
 Note: If the object has implemented the interface ExtendedOrmUjo than foreign keys are reloaded else a lazy initialization is loaded - for the first key depth.
 
 Parameters:
 
 ujo - The persistent object to relading values.
 
 Returns:
 
 The FALSE value means that the object is missing in the database.
 - loadInternal
```
public  U loadInternal(org.ujorm.Key relatedProperty,
 Object id,
 boolean mandatory)
 throws NoSuchElementException
```
 Load UJO by a unique id. If the result is not unique, then an exception is throwed.
 
 Parameters:
 
 relatedProperty - Related key
 
 id - Valid ID
 
 mandatory - If result is mandatory then the method throws an exception if no object was found else returns null;
 
 Throws:
 
 NoSuchElementException
 - close
```
public void close()
 throws IllegalStateException
```
 Close and release all DB connections.
 
 Specified by:
 
 close in interface Closeable
 
 Specified by:
 
 close in interface AutoCloseable
 
 Throws:
 
 IllegalStateException - The exception contains a bug from Connection close;
 - isClosed
```
public boolean isClosed()
```
 Is the session closed?
 - findCache
```
public OrmUjo findCache(Class type,
 Object pkey)
```
 Find object from internal cache
 - findCache
```
public OrmUjo findCache(Class type,
 Object... pkeys)
```
 Find object from internal cache
 - clearCache
```
public void clearCache()
```
 Clear the cache.
 - clearCache
```
public final void clearCache(CachePolicy policy)
```
 Clear cache and change its policy.
 - getParameters
```
public final MetaParams getParameters()
```
 Returns parameters
 - isRollbackOnly
```
public boolean isRollbackOnly()
```
 The rollback is allowed only.
 
 Returns:
 
 The result is true if an inner session attribute is true or a related transaction have got the status equals {link Status#STATUS_ROLLEDBACK}.
 - markForRolback
```
public void markForRolback()
```
 - readFK
```
public ForeignKey readFK(OrmUjo ujo,
 org.ujorm.Key<?,? extends OrmUjo> key)
 throws org.ujorm.core.IllegalUjormException
```
 Build new Foreign key.
 
 Parameters:
 
 key - The key must be a relation type of "many to one".
 
 Throws:
 
 IllegalStateException - If a parameter key is not a foreign key.
 
 org.ujorm.core.IllegalUjormException
 - getDialect
```
public final SqlDialect getDialect(Class<? extends OrmUjo> ormType)
```
 Check dialect type
 - hasDialect
```
public boolean hasDialect(Class<? extends OrmUjo> ormType,
 Class<? extends SqlDialect>... dialects)
```
 Returns true, if ORM type have got any from listed dialects
 
 Parameters:
 
 ormType - Entity type
 
 dialects - Entity dialect type
 
 Returns:
 
 Returns true, if ORM type have got any from listed dialects
 - newClosedSession
```
public static Session newClosedSession(OrmHandler handler)
```
 Create the closed session
 - getLazyLoading
```
public LazyLoading getLazyLoading()
```
 Enable a lazy-loading of related Ujo object. The default value is assigned from the parameter MetaParams#LAZY_LOADING_ENABLED.
 
 Returns:
 
 the lazyLoadingEnabled
 - setLazyLoading
```
public void setLazyLoading(LazyLoading lazyLoadingEnabled)
```
 Enable a lazy-loading of related Ujo object. The default value is assigned from the parameter MetaParams#LAZY_LOADING_ENABLED.
 
 Parameters:
 
 lazyLoadingEnabled - the lazyLoadingEnabled to set
 - checkNotNull
```
protected void checkNotNull(OrmUjo ujo,
 String action)
 throws IllegalArgumentException
```
 Check the Ujo object to not null.
 
 Parameters:
 
 ujo -
 
 action -
 
 Throws:
 
 IllegalArgumentException - Throw the exception if a ujo argument is null.

Class Session

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SQL_ILLEGAL

Method Detail

beginTransaction

getTransaction

getHandler

commitTransaction

commit

rollbackTransaction

rollback

commit

createQuery

createQuery

createQuery

createQuery

exists

exists

exists

getBasicColumn

getFirstDatabase

getDatabase

saveOrUpdate

save

save

save

update

update

delete

delete

delete

delete

delete

call

getOrmColumns

createPkCriterion

getRowCount

getStatement

iterateInternal

getFirstConnection

getFirstConnection

getConnection

getConnection

getSeqConnection

getStatement

getStatementCallable

load

loadBy

reload

loadInternal

close

isClosed

findCache

findCache

clearCache

clearCache

getParameters

isRollbackOnly

markForRolback

readFK

getDialect

hasDialect

newClosedSession

getLazyLoading

setLazyLoading

checkNotNull