KCSessionManager (IDBS2)

java.lang.Object
- it.unimi.dico.islab.idbs2.common.AbstractSessionManager
- - it.unimi.dico.islab.idbs2.kc.session.KCSessionManager

public class KCSessionManager
extends it.unimi.dico.islab.idbs2.common.AbstractSessionManager

Field Summary

Fields
Modifier and Type	Field and Description
`protected static boolean`	`AUTO_DATABASE_COHERENCE`
`static DocumentManager`	`dm` `DocumentManager` reference, used to manage `Document` objects.
`static KCManager`	`kcm` `KCManager` reference, used to manage `KnowledgeChunk` objects.
`static PredicateManager`	`pm` `PredicateManager` reference, used to manage `Predicate` objects.
`static TermManager`	`tm` `TermManager` reference, used to manage `Term` objects.
`static TypeManager`	`tym` `TypeManager` reference, used to manage `Type` objects.

Fields inherited from class it.unimi.dico.islab.idbs2.common.AbstractSessionManager
cfgMan, configuration, internalSF, log

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`beginTransaction()` Start a new transaction for the internal Session.
`protected static void`	`checkActiveTransaction()` Check if the internal session has an active transaction, otherwise creates automatically a new transaction warning the user.
`static void`	`commitTransaction()` Commit the internal session active transaction.
`static boolean`	`createDb()` TODO: Scrivere guida!!
`static Query`	`executeQuery(String query)` Executes the HQL (Hibernate Query Language) `query` given as input using the internal session (requires an explicit call to `beginTransaction()`).
`static Boolean`	`getAutoDatabaseCoherence()`
`protected static Session`	`getInternalSession()` Getter for the internal Hibernate Session.
`static SessionFactory`	`getSessionFactory()` Returns an Hibernate Session Factory created for this cloud model.
`static SessionFactory`	`getSessionFactory(File confFile)` Same as `getSessionFactory()`.
`static void`	`rollbackTransaction()`
`protected static void`	`saveOrUpdate(Object obj)` Give persistence (on relational database) to an object mapped with Hibernate using the internal `Session Factory` of this class.
`void`	`setAutoDatabaseCoherence(boolean active)` Activate/deactivate the database coherence system; this system could be useful when adding new KCs to and existing and already filled database.

Methods inherited from class it.unimi.dico.islab.idbs2.common.AbstractSessionManager
_beginTransaction, _checkActiveTransaction, _commitTransaction, _createDb, _executeQuery, _flushTransaction, _getSessionFactory, _getSessionFactory, _initSessionFactory, _rollbackTransaction, _saveOrUpdateObject

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

- Field Detail
  - kcm
```
public static KCManager kcm
```
    KCManager reference, used to manage KnowledgeChunk objects.
  - dm
```
public static DocumentManager dm
```
    DocumentManager reference, used to manage Document objects.
  - tym
```
public static TypeManager tym
```
    TypeManager reference, used to manage Type objects.
  - tm
```
public static TermManager tm
```
    TermManager reference, used to manage Term objects.
  - pm
```
public static PredicateManager pm
```
    PredicateManager reference, used to manage Predicate objects.
  - AUTO_DATABASE_COHERENCE
```
protected static boolean AUTO_DATABASE_COHERENCE
```
- Method Detail
  - executeQuery
```
public static Query executeQuery(String query)
```
    Executes the HQL (Hibernate Query Language) query given as input using the internal session (requires an explicit call to beginTransaction()).
    
    Parameters:
    query - the HQL query to be executed. Only SELECT queries are accepted.
    
    Returns:
    A list of Objects as result of the query or null if no result has been returned.
  - saveOrUpdate
```
protected static void saveOrUpdate(Object obj)
```
    Give persistence (on relational database) to an object mapped with Hibernate using the internal Session Factory of this class.
    
    Parameters:
    obj - The Hibernate mapped object to be persisted.
  - checkActiveTransaction
```
protected static void checkActiveTransaction()
```
    Check if the internal session has an active transaction, otherwise creates automatically a new transaction warning the user.
  - getInternalSession
```
protected static Session getInternalSession()
```
    Getter for the internal Hibernate Session.
    
    Returns:
    the hibernate Session managed by this class.
  - beginTransaction
```
public static void beginTransaction()
```
    Start a new transaction for the internal Session.
  - commitTransaction
```
public static void commitTransaction()
```
    Commit the internal session active transaction. This method MUST be called if some KnowledgeChunk have been saved or modified using internal session. Otherwise the saved data won't be materialized.
  - rollbackTransaction
```
public static void rollbackTransaction()
```
  - getSessionFactory
```
public static SessionFactory getSessionFactory()
```
    Returns an Hibernate Session Factory created for this cloud model. This Session Factory will be different at any call of this method and is different from the internal Session Factory used by other methods (e.g. saveOrUpdate and getKnowledgeChunkById).
    
    This session factory is created using the config/kcDatabaseConfiguration.xml file.
    
    Returns:
    Hibernate SessionFactory
  - getSessionFactory
```
public static SessionFactory getSessionFactory(File confFile)
```
    Same as getSessionFactory(). Only difference is that the configuration file the SessionFactory will be built upon is passed as argument. This method can be used to obtain new SessionFactories for databases different from the standard one.
    
    Parameters:
    confFile - the configuration file in a standard xml Hibernate version.
    
    Returns:
    the created SessionFactory.
  - createDb
```
public static boolean createDb()
```
    TODO: Scrivere guida!!
    
    Throws:
    
    SQLException
  - setAutoDatabaseCoherence
```
public void setAutoDatabaseCoherence(boolean active)
```
    Activate/deactivate the database coherence system; this system could be useful when adding new KCs to and existing and already filled database. When activated the behavior of the addType, addTerm, and addDocument methods are changed. For better understanding we present the following example based on the addType method:
    1. The method addType is called
    2. The Primary Key of the new Type is computed
    3. The database is queried looking for an already present identical value of the key
    When the database coherence system is disabled, steps 3 and 3.1 are not executed and step 3.2 is executed as default; in this situation when an inserted type is already present for this KC on the database, a Primary Kew Violation Exception is raised.
  - getAutoDatabaseCoherence
```
public static Boolean getAutoDatabaseCoherence()
```
    Returns:
    true if the autoDatabaseCoherence system is active, false otherwise.
    See Also:
    for better explanation.

Class KCSessionManager

Field Summary

Fields inherited from class it.unimi.dico.islab.idbs2.common.AbstractSessionManager

Method Summary

Methods inherited from class it.unimi.dico.islab.idbs2.common.AbstractSessionManager

Methods inherited from class java.lang.Object

Field Detail

kcm

dm

tym

tm

pm

AUTO_DATABASE_COHERENCE

Method Detail

executeQuery

saveOrUpdate

checkActiveTransaction

getInternalSession

beginTransaction

commitTransaction

rollbackTransaction

getSessionFactory

getSessionFactory

createDb

setAutoDatabaseCoherence

getAutoDatabaseCoherence