HibernateService (ChRL - ORM Framework 1.1.0 API)

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

All Implemented Interfaces:: AutoCloseable

public final class HibernateService
extends Object
implements AutoCloseable

Author:: bravestone

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes all Cached Factories
`boolean`	`connect(IHibernateConfig hibernateConfig)` Tries to set up a factory for given configuration
`boolean`	`disconnect(IHibernateConfig hibernateConfig)` Tries to disconnect and close factory
`void`	`exportSchema(HibernateConfig config, String exportFile)` Creates Schema of given Config in given File.
`javax.persistence.EntityManager`	`getEntityManager(JPAConfig config)` Returns a new `EntityManager`.
`javax.persistence.EntityManagerFactory`	`getEntityManagerFactory(JPAConfig config)` Returns a Entity Manager Factory Cached by this Service Returns like specified in `ConcurrentHashMap.get(Object)`
`String[]`	`getFullStatistics()` Returns statistics for every database connections.
`static HibernateService`	`getInstance()`
`org.hibernate.Session`	`getSession(IHibernateConfig config)` Returns a new open and valid `Session`.
`org.hibernate.SessionFactory`	`getSessionFactory(IHibernateConfig hconfig)` Returns a Session Factory Cached by this Service Returns like specified in `ConcurrentHashMap.get(Object)` if given parameter is a instance of `JPAConfig` this method will cast a given `HibernateEntityManagerFactory` to a `SessionFactory` if necessery.
`org.hibernate.StatelessSession`	`getStatelessSession(IHibernateConfig config)` Returns a new open and valid `StatelessSession`.
`static void`	`persistList(List<?> list, HibernateConfig conf)` Calls `Session.saveOrUpdate(Object)` on every object in given list.
`static void`	`persistListParallel(List<?> list, HibernateConfig conf, double loadFactor)` Calls `persistList(List, HibernateConfig)` concurrently.
`boolean`	`reloadConfiguration(IHibernateConfig hibernateConfig)` Tries to reload given connection
`String`	`toString()`

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

- Method Detail
  - connect
```
public boolean connect(IHibernateConfig hibernateConfig)
```
    Tries to set up a factory for given configuration
    
    Parameters:
    
    hibernateConfig - configuration with connection properties
    
    Returns:
    
    true if connection was correctly initialized
    
    Throws:
    
    IllegalArgumentException - if parameter is null
    
    org.hibernate.HibernateException - if Session Factory could not be created (if parameter is instance of HibernateConfig)
    
    javax.persistence.PersistenceException - if Entity Manager could not be created (if parameter is instance of JPAConfig)
    
    See Also:
    
    SessionFactory}
  - disconnect
```
public boolean disconnect(IHibernateConfig hibernateConfig)
```
    Tries to disconnect and close factory
    
    Parameters:
    
    hibernateConfig - configuration with connection properties
    
    Returns:
    
    true if factory was properly closed
    false if no factory was closed (or was never connected)
    
    Throws:
    
    IllegalArgumentException - if parameter is null
  - reloadConfiguration
```
public boolean reloadConfiguration(IHibernateConfig hibernateConfig)
```
    Tries to reload given connection
    
    Parameters:
    
    hibernateConfig - configuration to reload
    
    Returns:
    
    false if this configuration has no cached connection, or reload was not successful
    true otherwise
    
    Throws:
    
    IllegalArgumentException - if parameter is null
    
    org.hibernate.HibernateException - if Session Factory could not be created
    
    javax.persistence.PersistenceException - if Entity Manager could not be created
    
    See Also:
    
    HibernateService#connect(IHibernateConfig)}, HibernateService#disconnect(IHibernateConfig)}
  - getSessionFactory
```
public org.hibernate.SessionFactory getSessionFactory(IHibernateConfig hconfig)
```
    Returns a Session Factory Cached by this Service
    Returns like specified in ConcurrentHashMap.get(Object)
    if given parameter is a instance of JPAConfig this method will cast a given HibernateEntityManagerFactory to a SessionFactory if necessery.
    
    Parameters:
    
    hconfig - configuration to look for
    
    Returns:
    
    Cached Session Factory or null
    
    Throws:
    
    IllegalArgumentException - if parameter is null
  - getEntityManagerFactory
```
public javax.persistence.EntityManagerFactory getEntityManagerFactory(JPAConfig config)
```
    Returns a Entity Manager Factory Cached by this Service
    Returns like specified in ConcurrentHashMap.get(Object)
    
    Parameters:
    
    config - configuration to look for
    
    Returns:
    
    Cached Manager Factory or null
    
    Throws:
    
    IllegalArgumentException - if parameter is null
  - getSession
```
public org.hibernate.Session getSession(IHibernateConfig config)
```
    Returns a new open and valid Session. Calls connect(IHibernateConfig) if needed.
    
    Parameters:
    
    config - configuration
    
    Returns:
    
    a new open Hibernate Session
    
    Throws:
    
    IllegalArgumentException - if parameter is null
    
    org.hibernate.HibernateException - if Session Factory could not be created (if parameter is instance of HibernateConfig) - connect(IHibernateConfig)
    
    javax.persistence.PersistenceException - if Entity Manager could not be created (if parameter is instance of JPAConfig) - connect(IHibernateConfig)
    
    NullPointerException - if no SessionFactory could be obtained, when connect(IHibernateConfig) was called
    
    NullPointerException - if config is no instance of HibernateConfig or JPAConfig
    
    See Also:
    
    HibernateService#connect(IHibernateConfig)}, HibernateService#disconnect(IHibernateConfig)}
  - getStatelessSession
```
public org.hibernate.StatelessSession getStatelessSession(IHibernateConfig config)
```
    Returns a new open and valid StatelessSession. Calls connect(IHibernateConfig) if needed.
    
    Parameters:
    
    config - configuration
    
    Returns:
    
    a new open Hibernate Stateless Session
    
    Throws:
    
    IllegalArgumentException - if parameter is null
    
    org.hibernate.HibernateException - if Session Factory could not be created (if parameter is instance of HibernateConfig) - connect(IHibernateConfig)
    
    javax.persistence.PersistenceException - if Entity Manager could not be created (if parameter is instance of JPAConfig) - connect(IHibernateConfig)
    
    NullPointerException - if no SessionFactory could be obtained, when connect(IHibernateConfig) was called
    
    NullPointerException - if config is no instance of HibernateConfig or JPAConfig
    
    NotSupportedException - if config is a isntance of OGMConfig since Stateless sessions are not supported in ogm databases
    
    See Also:
    
    HibernateService#connect(IHibernateConfig)}, HibernateService#disconnect(IHibernateConfig)}
  - getEntityManager
```
public javax.persistence.EntityManager getEntityManager(JPAConfig config)
```
    Returns a new EntityManager. Calls connect(IHibernateConfig) if needed.
    
    Parameters:
    
    config - configuration
    
    Returns:
    
    a new Entity Manager
    
    Throws:
    
    IllegalArgumentException - if parameter is null
    
    javax.persistence.PersistenceException - if Entity Manager could not be created - connect(IHibernateConfig)
    
    NullPointerException - if no SessionFactory could be obtained, when connect(IHibernateConfig) was called
    
    See Also:
    
    HibernateService#connect(IHibernateConfig)}, HibernateService#disconnect(IHibernateConfig)}
  - exportSchema
```
public void exportSchema(HibernateConfig config,
                         String exportFile)
```
    Creates Schema of given Config in given File. Also prints output to console.
    
    Parameters:
    
    config - HibernateConfig config. Must be HibernateConfig.
    
    exportFile - Export File Directory
    
    Throws:
    
    org.hibernate.HibernateException - of config is no HibernateConfig
  - getFullStatistics
```
public String[] getFullStatistics()
```
    Returns statistics for every database connections.
    make sure statistic generation is set to true in hibernate config
    
    Returns:
    
    statistics
    
    See Also:
    
    HibernateConfig.GENERATE_STATISTICS
  - persistListParallel
```
public static void persistListParallel(List<?> list,
                                       HibernateConfig conf,
                                       double loadFactor)
```
    Calls persistList(List, HibernateConfig) concurrently.
    Creates HibernateConfig.C3P0_MAX_SIZE * laodFactor Threads.
    If single threaded processing is needed (loadFacoter == 0) use persistList(List, HibernateConfig) instead
    
    Parameters:
    
    list - object list to persist
    
    conf - database connection configuration
    
    loadFactor - % of used Sessions.
    1 equals HibernateConfig.C3P0_MAX_SIZE used sessions. 0 equals 1 used session. Use persistList(List, HibernateConfig) in this case.
    
    Throws:
    
    IllegalArgumentException - if loadFactor 0s > 1d || <= 0d
    
    Exception - as specified in persistList(List, HibernateConfig)
    
    See Also:
    
    persistList(List, HibernateConfig)
  - persistList
```
public static void persistList(List<?> list,
                               HibernateConfig conf)
```
    Calls Session.saveOrUpdate(Object) on every object in given list.
    if a exception occurs, given object wont be persisted.
    calls getSession(IHibernateConfig)
    uses HibernateConfig.STATEMENT_BATCH_SIZE for batch processing
    
    Parameters:
    
    list - object list to persist
    
    conf - database connection configuration
    
    Throws:
    
    Exception - as specified in getSession(IHibernateConfig)
    
    Exception - as specified in Session.saveOrUpdate(Object)
    
    Exception - as specified in Session#flush(Object)
    
    Exception - as specified in Session#close(Object)
    
    Exception - as specified in SharedSessionContract.getTransaction()
    
    Exception - as specified in Transaction.begin()
    
    Exception - as specified in Transaction.rollback()
    
    See Also:
    
    getSession(IHibernateConfig), HibernateConfig.STATEMENT_BATCH_SIZE
  - close
```
public void close()
           throws Exception
```
    Closes all Cached Factories
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    Exception
    
    See Also:
    
    AutoCloseable.close()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - getInstance
```
public static HibernateService getInstance()
```

Class HibernateService

Method Summary

Methods inherited from class java.lang.Object

Method Detail

connect

disconnect

reloadConfiguration

getSessionFactory

getEntityManagerFactory

getSession

getStatelessSession

getEntityManager

exportSchema

getFullStatistics

persistListParallel

persistList

close

toString

getInstance