SessionTemplate (ChRL - ORM Framework 1.0.0 API)

java.lang.Object
- at.chrl.orm.hibernate.SessionTemplate

All Implemented Interfaces:: AutoCloseable

public abstract class SessionTemplate
extends Object
implements AutoCloseable

Field Summary

Fields
Modifier and Type Field and Description

protected org.hibernate.Session session

Fields
Modifier and Type	Field and Description
`protected org.hibernate.Session`	`session`

Constructor Summary

Constructors
Modifier Constructor and Description

protected SessionTemplate()

Constructors
Modifier	Constructor and Description
`protected`	`SessionTemplate()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`<T> long`	`count(Class<T> cls)` Returns count of datasets for given class
`<T> org.hibernate.Criteria`	`createCriteria(Class<T> persistentClass)` Returns criteria associated with this session for given class
`org.hibernate.Query`	`createQuery(String stmt)` Create query
`org.hibernate.SQLQuery`	`createSQLQuery(String stmt)` Create SQL query
`org.hibernate.StatelessSession`	`createStatelessSession()` Creates a new `StatelessSession` instance
`void`	`delete(Object obj)` Calls `Session.delete(Object)`
`void`	`evict(Object obj)` Evict
`<T> Collection<T>`	`executeHQLQuery(String query)`
`<T> Collection<T>`	`executeHQLQuery(String query, int maxResults)`
`<T> T`	`executeHQLQueryUniqueResult(String query)`
`<T> Collection<T>`	`executeNamedQuery(String query)`
`<T> Collection<T>`	`executeNamedQuery(String query, int maxResults)`
`<T> T`	`executeNamedQueryUniqueResult(String query)`
`<T> Collection<T>`	`executeQuery(org.hibernate.Criteria crit)` Executes given `Criteria`
`<T> Collection<T>`	`executeQuery(org.hibernate.Criteria crit, int maxResults)` Executes given `Criteria`
`<T> Collection<T>`	`executeQuery(org.hibernate.Criteria crit, int maxResults, boolean chacheable)` Executes given Criteria
`<T> Collection<T>`	`executeQuery(org.hibernate.Query q)` Executes given `Query`
`<T> Collection<T>`	`executeQuery(org.hibernate.Query q, int maxResults)` Executes given `Query`
`<T> Collection<T>`	`executeQuery(org.hibernate.Query q, int maxResults, boolean chacheable)` Executes given Query
`<T> T`	`executeQueryUniqueResult(org.hibernate.Criteria q)`
`<T> T`	`executeQueryUniqueResult(org.hibernate.Criteria crit, boolean chacheable)`
`<T> T`	`executeQueryUniqueResult(org.hibernate.Query q)`
`<T> T`	`executeQueryUniqueResult(org.hibernate.Query q, boolean chacheable)`
`<T> Collection<T>`	`executeSQLQuery(String query)`
`<T> Collection<T>`	`executeSQLQuery(String query, int maxResults)`
`<T> T`	`executeSQLQueryUniqueResult(String query)`
`int`	`executeUpdate(org.hibernate.Query q)` Executes Update Statement
`static <T> Collection<T>`	`filterNull(Collection<T> input)`
`void`	`flush()` Flush
`<T> Collection<T>`	`getAll(Class<T> entityClass)` Returns all instances of given class.
`<T> Collection<T>`	`getAll(Class<T> entityClass, int maxResults)` Returns maxResults instances of given class
`protected abstract IHibernateConfig`	`getHibernateConfig()`
`<T> T`	`getObjectForPK(Class<T> cls, Serializable id)` Get the pojo object for the given Pojo Class and identifier
`<T,K> Collection<T>`	`getObjectsForPK(Class<T> cls, Collection<K> ids)` get Objects for primary key
`protected org.hibernate.Session`	`getSession()` returns low level Hibernate `Session`
`org.hibernate.SessionFactory`	`getSessionFactory()` Returns active Session Factory
`boolean`	`isOpen()` Check if the Session is still opened
`<T> Iterator<T>`	`iterator(org.hibernate.Criteria crit, boolean stateless)` Scroll over the query results with a iterator
`<T> Iterator<T>`	`iterator(org.hibernate.Query q, boolean stateless)` Scroll over the query results with a iterator
`<T> T`	`merge(T obj)` Calls `Session.merge(Object)`
`void`	`persist(Object obj)` Calls `Session.delete(Object)`
`static String[][]`	`printOpenSessionInfo()` Returns information for open sessions
`void`	`refresh(Object obj)` Calls `Session.refresh(Object)`
`protected void`	`rollback()` Rollback a Transaction
`void`	`save(Object obj)` Calls `Session.save(Object)`
`void`	`saveOrUpdate(Object obj)` Calls `Session.saveOrUpdate(Object)`
`<T> Iterable<T>`	`scroll(org.hibernate.Criteria crit)` Scroll over the query results
`<T> Iterable<T>`	`scroll(org.hibernate.Criteria crit, boolean stateless)` Scroll over the query results
`<T> Iterable<T>`	`scroll(org.hibernate.Query q)` Scroll over the query results
`<T> Iterable<T>`	`scroll(org.hibernate.Query q, boolean stateless)` Scroll over the query results
`<T> Iterable<T>`	`scrollAll(Class<T> entityClass)` Returns a iterator with all entityClass instances in database
`<T,K> Iterable<T>`	`scrollObjectsForPK(Class<T> cls, Collection<K> ids)` get Objects for primary key
`static void`	`shutdown()`
`<T> Stream<T>`	`stream(org.hibernate.Criteria crit)` crates a Stream with given `Criteria` crit
`<T> Stream<T>`	`stream(org.hibernate.Query q)` crates a Stream with given `Query` q
`<T,K> Stream<T>`	`streamObjectsForPK(Class<T> cls, Collection<K> ids)` get Objects for primary key
`<T> Stream<T>`	`streamReadOnly(org.hibernate.Criteria crit)` Creates `Stream` with given criteria Result
`<T> Stream<T>`	`streamReadOnly(org.hibernate.Query q)` Creates `Stream` with given query Result
`<T> Stream<T>`	`streamStateless(Class<?> persistentClass, Function<org.hibernate.Criteria,org.hibernate.Criteria> criteriaFilter)` creates a `Stream` with given query String in a `StatelessSession`
`<T> Stream<T>`	`streamStateless(String query)` creates a `Stream` with given query String in a `StatelessSession`
`void`	`update(Object obj)` Calls `Session.update(Object)`

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

- Field Detail
  - session
```
protected final org.hibernate.Session session
```
- Constructor Detail
  - SessionTemplate
```
protected SessionTemplate()
```
- Method Detail
  - shutdown
```
public static void shutdown()
```
  - getHibernateConfig
```
protected abstract IHibernateConfig getHibernateConfig()
```
  - getObjectForPK
```
public <T> T getObjectForPK(Class<T> cls,
                            Serializable id)
```
    Get the pojo object for the given Pojo Class and identifier
    
    Parameters:
    
    cls - - the Pojo Class
    
    id - - the identifier for the pojo object
    
    Returns:
    
    the pojo object for the given identifier or null if object doesn't exists
  - getObjectsForPK
```
public <T,K> Collection<T> getObjectsForPK(Class<T> cls,
                                           Collection<K> ids)
```
    get Objects for primary key
    
    Parameters:
    
    cls - - given persistence class
    
    ids - - identifier
    
    Returns:
    
    Collection with given Objects (persistent)
  - streamObjectsForPK
```
public <T,K> Stream<T> streamObjectsForPK(Class<T> cls,
                                          Collection<K> ids)
```
    get Objects for primary key
    
    Parameters:
    
    cls - - given persistence class
    
    ids - - identifier
    
    Returns:
    
    Stream with given Objects (persistent)
  - scrollObjectsForPK
```
public <T,K> Iterable<T> scrollObjectsForPK(Class<T> cls,
                                            Collection<K> ids)
```
    get Objects for primary key
    
    Parameters:
    
    cls - - given persistence class
    
    ids - - identifier
    
    Returns:
    
    Stream with given Objects (persistent)
  - createStatelessSession
```
public org.hibernate.StatelessSession createStatelessSession()
```
    Creates a new StatelessSession instance
    
    Returns:
    
    new StatelessSession
  - printOpenSessionInfo
```
public static String[][] printOpenSessionInfo()
```
    Returns information for open sessions
    
    Returns:
  - save
```
public void save(Object obj)
          throws Exception
```
    Calls Session.save(Object)
    
    Parameters:
    
    obj -
    
    Throws:
    
    Exception
  - saveOrUpdate
```
public void saveOrUpdate(Object obj)
                  throws Exception
```
    Calls Session.saveOrUpdate(Object)
    
    Parameters:
    
    obj -
    
    Throws:
    
    Exception
  - merge
```
public <T> T merge(T obj)
            throws Exception
```
    Calls Session.merge(Object)
    
    Parameters:
    
    obj -
    
    Throws:
    
    Exception
  - update
```
public void update(Object obj)
            throws Exception
```
    Calls Session.update(Object)
    
    Parameters:
    
    obj -
    
    Throws:
    
    Exception
  - refresh
```
public void refresh(Object obj)
             throws Exception
```
    Calls Session.refresh(Object)
    
    Parameters:
    
    obj -
    
    Throws:
    
    Exception
  - delete
```
public void delete(Object obj)
            throws Exception
```
    Calls Session.delete(Object)
    
    Parameters:
    
    obj -
    
    Throws:
    
    Exception
  - persist
```
public void persist(Object obj)
             throws Exception
```
    Calls Session.delete(Object)
    
    Parameters:
    
    obj -
    
    Throws:
    
    Exception
  - getSessionFactory
```
public org.hibernate.SessionFactory getSessionFactory()
```
    Returns active Session Factory
    
    Returns:
    
    session Factory
  - rollback
```
protected void rollback()
```
    Rollback a Transaction
  - isOpen
```
public boolean isOpen()
```
    Check if the Session is still opened
    
    Returns:
  - createQuery
```
public org.hibernate.Query createQuery(String stmt)
```
    Create query
    
    Parameters:
    
    stmt - the statement
  - createSQLQuery
```
public org.hibernate.SQLQuery createSQLQuery(String stmt)
```
    Create SQL query
    
    Parameters:
    
    stmt - the SQL statement
  - flush
```
public void flush()
```
    Flush
  - evict
```
public void evict(Object obj)
```
    Evict
  - getSession
```
protected org.hibernate.Session getSession()
```
    returns low level Hibernate Session
    
    Returns:
    
    associated session
  - createCriteria
```
public <T> org.hibernate.Criteria createCriteria(Class<T> persistentClass)
```
    Returns criteria associated with this session for given class
    
    Parameters:
    
    persistentClass - - given class
    
    Returns:
    
    empty criteria query
  - executeQuery
```
public <T> Collection<T> executeQuery(org.hibernate.Criteria crit)
```
    Executes given Criteria
    
    Parameters:
    
    crit - - criteria to execute
    
    Returns:
    
    result set as collection
  - executeQuery
```
public <T> Collection<T> executeQuery(org.hibernate.Criteria crit,
                                      int maxResults)
```
    Executes given Criteria
    
    Parameters:
    
    crit - - criteria to execute
    
    maxResults - - maximal results
    
    Returns:
    
    result set as collection
  - executeQuery
```
public <T> Collection<T> executeQuery(org.hibernate.Query q)
```
    Executes given Query
    
    Parameters:
    
    q - - query to execute
    
    Returns:
    
    result set as collection
  - executeQuery
```
public <T> Collection<T> executeQuery(org.hibernate.Query q,
                                      int maxResults)
```
    Executes given Query
    
    Parameters:
    
    q - - query to execute
    
    maxResults - - maximal results
    
    Returns:
    
    result set as collection
  - executeUpdate
```
public int executeUpdate(org.hibernate.Query q)
```
    Executes Update Statement
    
    Parameters:
    
    q - - given query
    
    Returns:
    
    affected row count
  - executeQuery
```
public <T> Collection<T> executeQuery(org.hibernate.Query q,
                                      int maxResults,
                                      boolean chacheable)
```
    Executes given Query
    
    Parameters:
    
    q - - given query
    
    maxResults - - maximal results
    
    chacheable - - cachable
    
    Returns:
    
    Collection with results or empty collection(No null elements)
  - executeQuery
```
public <T> Collection<T> executeQuery(org.hibernate.Criteria crit,
                                      int maxResults,
                                      boolean chacheable)
```
    Executes given Criteria
    
    Parameters:
    
    crit - - given criteria
    
    maxResults - - maxResults
    
    chacheable - - cacheable
    
    Returns:
    
    Collection with results or empty collection(No null elements)
  - scroll
```
public <T> Iterable<T> scroll(org.hibernate.Query q)
```
    Scroll over the query results
    
    Parameters:
    
    q - - given query
    
    Returns:
    
    Iterator instance
  - scroll
```
public <T> Iterable<T> scroll(org.hibernate.Query q,
                              boolean stateless)
```
    Scroll over the query results
    
    Parameters:
    
    q - - given query
    
    stateless - - stateless flag
    
    Returns:
    
    Iterable instance
  - iterator
```
public <T> Iterator<T> iterator(org.hibernate.Query q,
                                boolean stateless)
```
    Scroll over the query results with a iterator
    
    Parameters:
    
    q - - given query
    
    stateless - - stateless flag
    
    Returns:
    
    Iterable instance
    
    See Also:
    
    SessionTemplate#scroll(Query)}
  - scroll
```
public <T> Iterable<T> scroll(org.hibernate.Criteria crit)
```
    Scroll over the query results
    
    Parameters:
    
    cri - - given criteria
    
    Returns:
    
    Iterator instance
  - scroll
```
public <T> Iterable<T> scroll(org.hibernate.Criteria crit,
                              boolean stateless)
```
    Scroll over the query results
    
    Parameters:
    
    crit - - given criteria
    
    stateless - - stateless flag
    
    Returns:
    
    Iterable instance
  - iterator
```
public <T> Iterator<T> iterator(org.hibernate.Criteria crit,
                                boolean stateless)
```
    Scroll over the query results with a iterator
    
    Parameters:
    
    crit - - given criteria
    
    stateless - - stateless flag
    
    Returns:
    
    Iterator instance
    
    See Also:
    
    SessionTemplate#scroll(Criteria)}
  - streamReadOnly
```
public <T> Stream<T> streamReadOnly(org.hibernate.Query q)
```
    Creates Stream with given query Result
    
    Parameters:
    
    q - - given Query q. q is marked as ReadOnly with Query#setReadOnly(true)
    
    Returns:
    
    new Stream with given ResultSet
  - stream
```
public <T> Stream<T> stream(org.hibernate.Query q)
```
    crates a Stream with given Query q
    
    Parameters:
    
    q - - given Query
    
    Returns:
    
    new Stream with given ResultSet
  - streamStateless
```
public <T> Stream<T> streamStateless(String query)
```
    creates a Stream with given query String in a StatelessSession
    
    Parameters:
    
    query - - given query String
    
    Returns:
    
    new Stream with given ResultSet
  - streamReadOnly
```
public <T> Stream<T> streamReadOnly(org.hibernate.Criteria crit)
```
    Creates Stream with given criteria Result
    
    Parameters:
    
    crit - - given Critera crit. crit is marked as ReadOnly with Query#setReadOnly(true)
    
    Returns:
    
    new Stream with given ResultSet
  - stream
```
public <T> Stream<T> stream(org.hibernate.Criteria crit)
```
    crates a Stream with given Criteria crit
    
    Parameters:
    
    crit - - given Criteria
    
    Returns:
    
    new Stream with given ResultSet
  - streamStateless
```
public <T> Stream<T> streamStateless(Class<?> persistentClass,
                                     Function<org.hibernate.Criteria,org.hibernate.Criteria> criteriaFilter)
```
    creates a Stream with given query String in a StatelessSession
    
    Parameters:
    
    persistentClass - - class parameter for SharedSessionContract.createCriteria(Class) - given query String
    
    criteriaFilter - - manipulationFunction for created Criteria. Called before executing
    
    Returns:
    
    new Stream with given ResultSet
  - getAll
```
public <T> Collection<T> getAll(Class<T> entityClass)
```
    Returns all instances of given class.
    USE SCROLLING IF RESULT SET MAY BE LARGE
    use SessionTemplate#scrollAll(Class entityClass) instead
    
    Parameters:
    
    entityClass - - given entityClass
    
    Returns:
    
    Collection with all instances in database
  - getAll
```
public <T> Collection<T> getAll(Class<T> entityClass,
                                int maxResults)
```
    Returns maxResults instances of given class
    
    Parameters:
    
    entityClass - - given entityClass
    
    maxResults - - maximalResultCount
    
    Returns:
    
    Collection with instances
  - count
```
public <T> long count(Class<T> cls)
```
    Returns count of datasets for given class
    
    Parameters:
    
    cls -
    
    Returns:
    
    count
  - scrollAll
```
public <T> Iterable<T> scrollAll(Class<T> entityClass)
```
    Returns a iterator with all entityClass instances in database
    
    Parameters:
    
    entityClass - - given entity class
    
    Returns:
    
    Iterator of result set
  - executeHQLQuery
```
public <T> Collection<T> executeHQLQuery(String query,
                                         int maxResults)
```
  - executeSQLQuery
```
public <T> Collection<T> executeSQLQuery(String query,
                                         int maxResults)
```
  - executeNamedQuery
```
public <T> Collection<T> executeNamedQuery(String query,
                                           int maxResults)
```
  - executeHQLQuery
```
public <T> Collection<T> executeHQLQuery(String query)
```
  - executeSQLQuery
```
public <T> Collection<T> executeSQLQuery(String query)
```
  - executeNamedQuery
```
public <T> Collection<T> executeNamedQuery(String query)
```
  - executeQueryUniqueResult
```
public <T> T executeQueryUniqueResult(org.hibernate.Query q)
```
  - executeQueryUniqueResult
```
public <T> T executeQueryUniqueResult(org.hibernate.Query q,
                                      boolean chacheable)
```
  - executeQueryUniqueResult
```
public <T> T executeQueryUniqueResult(org.hibernate.Criteria q)
```
  - executeQueryUniqueResult
```
public <T> T executeQueryUniqueResult(org.hibernate.Criteria crit,
                                      boolean chacheable)
```
  - executeHQLQueryUniqueResult
```
public <T> T executeHQLQueryUniqueResult(String query)
```
  - executeSQLQueryUniqueResult
```
public <T> T executeSQLQueryUniqueResult(String query)
```
  - executeNamedQueryUniqueResult
```
public <T> T executeNamedQueryUniqueResult(String query)
```
  - filterNull
```
public static <T> Collection<T> filterNull(Collection<T> input)
```
  - close
```
public void close()
           throws Exception
```
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception

Class SessionTemplate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

session

Constructor Detail

SessionTemplate

Method Detail

shutdown

getHibernateConfig

getObjectForPK

getObjectsForPK

streamObjectsForPK

scrollObjectsForPK

createStatelessSession

printOpenSessionInfo

save

saveOrUpdate

merge

update

refresh

delete

persist

getSessionFactory

rollback

isOpen

createQuery

createSQLQuery

flush

evict

getSession

createCriteria

executeQuery

executeQuery

executeQuery

executeQuery

executeUpdate

executeQuery

executeQuery

scroll

scroll

iterator

scroll

scroll

iterator

streamReadOnly

stream

streamStateless

streamReadOnly

stream

streamStateless

getAll

getAll

count

scrollAll

executeHQLQuery

executeSQLQuery

executeNamedQuery

executeHQLQuery

executeSQLQuery

executeNamedQuery

executeQueryUniqueResult

executeQueryUniqueResult

executeQueryUniqueResult

executeQueryUniqueResult

executeHQLQueryUniqueResult

executeSQLQueryUniqueResult

executeNamedQueryUniqueResult

filterNull

close