no.g9.dataaccess

Class AbstractHibernateSession

java.lang.Object

no.g9.dataaccess.AbstractHibernateSession

All Implemented Interfaces:

Session

Direct Known Subclasses:

HibernateSession, HibernateStatelessSession

public abstract class AbstractHibernateSession
extends Object
implements Session

Common methods for a Hibernate implementation of the Session interface.

Constructor Summary

Constructors

Constructor and Description
AbstractHibernateSession()

Method Summary

Modifier and Type	Method and Description
protected org.hibernate.Criteria	applyFindData(org.hibernate.Criteria criteria, FindData findData) Apply settings from the findData object to the Hibernate criteria.
protected org.hibernate.Query	applyFindData(org.hibernate.Query query, FindData findData) Apply settings from the findData object to the Hibernate query.
protected org.hibernate.Criteria	applyFindDataAlias(org.hibernate.Criteria criteria, FindData findData) Create criteria aliases for each alias instance in findData.
protected org.hibernate.Criteria	applyFindDataProjection(org.hibernate.Criteria criteria, FindData findData) Create criteria projections from findData.
void	beginTransaction() Start a new transaction.
protected abstract org.hibernate.Transaction	beginTransactionImpl() Subclass specific implementation of session beginTransaction.
List<Object>	buildCriterionList(Object key, List<String> keyAttributeNames) Build a list of "equal" criterions for the given key object and list of attribute names.
protected abstract org.hibernate.Query	buildQueryImpl(String queryString) Subclass specific implementation of buildQuery.
List<Object>	buildQueryParameterValueList(Object key, List<String> keyAttributeNames) Build a list of parameter values for the given key object and list of attribute names.
String	buildQueryString(Class<?> clazz, List<String> keyAttributeNames) Build a HQL query string for the given class and list of attribute names.
boolean	canRollbackTransaction() Return true if the session has a transaction that can be rolled back.
void	close() Close this database session.
protected abstract void	closeImpl() Subclass specific implementation of session close.
void	commitTransaction() Commit the current transaction.
protected abstract org.hibernate.Criteria	createCriteriaImpl(FindData findData) Subclass specific implementation of createCriteria.
void	delete(Object object) Delete the given object in the database.
protected abstract void	deleteImpl(Object object) Subclass specific implementation of delete.
void	flush() Flush the session cache changes to the database.
protected abstract void	flushImpl() Subclass specific implementation of session flush.
Object	get(FindData findData) Get one object from the database according to the given findData.
List<?>	getAll(FindData findData) Get a list of objects from the database according to the given findData.
abstract org.hibernate.SharedSessionContract	getSession()
boolean	hasActiveTransaction() Return true if the session has an active transaction.
protected abstract boolean	hasActiveTransactionImpl() Subclass specific implementation of session hasActiveTransaction.
void	initialize(Object object) Initialize (load) a proxy object or collection from the database.
Serializable	insert(Object object) Insert a new object in the database.
protected abstract Serializable	insertImpl(Object object) Subclass specific implementation of insert.
boolean	isInitialized(Object object) Check if the given proxy object or collection is initialized (loaded) from the database.
Object	merge(Object object) Copy the state of the detached instance to a persistent instance with the same identifier.
protected abstract Object	mergeImpl(Object object) Subclass specific implementation of merge.
protected Object	qbc(FindData findData, boolean all) Execute a Criteria based query operation.
protected Object	qbe(FindData findData, boolean all) Execute a Query-By-Example operation.
protected Object	query(FindData findData, boolean all) Build and execute a Hibernate query from the given FindData.
void	refresh(Object object) Refresh the (cached) object from the database.
protected abstract void	refreshImpl(Object object) Subclass specific implementation of refresh.
void	rollbackTransaction() Rollback the current transaction.
protected Object	simpleGet(FindData findData) Execute a simple get operation.
protected abstract Object	simpleGetImpl(FindData findData) Subclass specific implementation of simpleGet.
void	update(Object object) Update the given object.
protected abstract void	updateImpl(Object object) Subclass specific implementation of update.

Methods inherited from class java.lang.Object

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

Methods inherited from interface no.g9.dataaccess.Session

hasLockFlag

Constructor Detail

AbstractHibernateSession

public AbstractHibernateSession()

Method Detail

get

public Object get(FindData findData)
           throws G9DataAccessException

Description copied from interface: Session

Get one object from the database according to the given findData.

Specified by:

get in interface Session

Parameters:

findData - (missing javadoc)

Returns:

(missing javadoc)

Throws:

G9DataAccessException

getAll

public List<?> getAll(FindData findData)
               throws G9DataAccessException

Description copied from interface: Session

Get a list of objects from the database according to the given findData.

Specified by:

getAll in interface Session

Parameters:

findData - (missing javadoc)

Returns:

(missing javadoc)

Throws:

G9DataAccessException

insert

public Serializable insert(Object object)
                    throws G9DataAccessException

Description copied from interface: Session

Insert a new object in the database.

Specified by:

insert in interface Session

Parameters:

object - (missing javadoc)

Returns:

(missing javadoc)

Throws:

G9DataAccessException

update

public void update(Object object)
            throws G9DataAccessException

Description copied from interface: Session

Update the given object.

Specified by:

update in interface Session

Parameters:

object - (missing javadoc)

Throws:

G9DataAccessException

merge

public Object merge(Object object)
             throws G9DataAccessException

Description copied from interface: Session

Copy the state of the detached instance to a persistent instance with the same identifier. The persistent instance will be loaded if necessary.

Specified by:

merge in interface Session

Parameters:

object - the detached instance

Returns:

the merged persistent instance

Throws:

G9DataAccessException

delete

public void delete(Object object)
            throws G9DataAccessException

Description copied from interface: Session

Delete the given object in the database.

Specified by:

delete in interface Session

Parameters:

object - (missing javadoc)

Throws:

G9DataAccessException

isInitialized

public boolean isInitialized(Object object)

Description copied from interface: Session

Check if the given proxy object or collection is initialized (loaded) from the database.

Specified by:

isInitialized in interface Session

Parameters:

object - the proxy object or collection to check

initialize

public void initialize(Object object)
                throws G9DataAccessException

Description copied from interface: Session

Initialize (load) a proxy object or collection from the database.

Specified by:

initialize in interface Session

Parameters:

object - (missing javadoc)

Throws:

G9DataAccessException

refresh

public void refresh(Object object)
             throws G9DataAccessException

Description copied from interface: Session

Refresh the (cached) object from the database. Updates the object state after database changes (triggers etc).

Specified by:

refresh in interface Session

Parameters:

object - (missing javadoc)

Throws:

G9DataAccessException

close

public void close()
           throws G9DataAccessException

Description copied from interface: Session

Close this database session.

Specified by:

close in interface Session

Throws:

G9DataAccessException

flush

public void flush()
           throws G9DataAccessException

Description copied from interface: Session

Flush the session cache changes to the database.

Specified by:

flush in interface Session

Throws:

G9DataAccessException

beginTransaction

public void beginTransaction()
                      throws G9DataAccessException

Description copied from interface: Session

Start a new transaction.

Specified by:

beginTransaction in interface Session

Throws:

G9DataAccessException

commitTransaction

public void commitTransaction()
                       throws G9DataAccessException

Description copied from interface: Session

Commit the current transaction.

Specified by:

commitTransaction in interface Session

Throws:

G9DataAccessException

rollbackTransaction

public void rollbackTransaction()

Description copied from interface: Session

Rollback the current transaction.

Specified by:

rollbackTransaction in interface Session

canRollbackTransaction

public boolean canRollbackTransaction()

Description copied from interface: Session

Return true if the session has a transaction that can be rolled back.

Specified by:

canRollbackTransaction in interface Session

Returns:

(missing javadoc)

hasActiveTransaction

public boolean hasActiveTransaction()
                             throws G9DataAccessException

Description copied from interface: Session

Return true if the session has an active transaction.

Specified by:

hasActiveTransaction in interface Session

Returns:

(missing javadoc)

Throws:

G9DataAccessException

getSession

public abstract org.hibernate.SharedSessionContract getSession()

query

protected Object query(FindData findData,
                       boolean all)
                throws G9DataAccessException

Build and execute a Hibernate query from the given FindData.

Parameters:

findData - - the query is based on the given FindData.

all - - false if only the first result matching the query is returned.

Returns:

the instances matching the query.

Throws:

G9DataAccessException - (no doc)

buildQueryString

public String buildQueryString(Class<?> clazz,
                               List<String> keyAttributeNames)

Build a HQL query string for the given class and list of attribute names. The query string uses positional parameters (if any).

Specified by:

buildQueryString in interface Session

Parameters:

clazz - - the class for the query.

keyAttributeNames - - list containing the name of the key attributes.

Returns:

the HQL query string.

buildQueryParameterValueList

public List<Object> buildQueryParameterValueList(Object key,
                                                 List<String> keyAttributeNames)

Description copied from interface: Session

Build a list of parameter values for the given key object and list of attribute names.

Specified by:

buildQueryParameterValueList in interface Session

Parameters:

key - (missing javadoc)

keyAttributeNames - (missing javadoc)

Returns:

(missing javadoc)

buildCriterionList

public List<Object> buildCriterionList(Object key,
                                       List<String> keyAttributeNames)

Description copied from interface: Session

Build a list of "equal" criterions for the given key object and list of attribute names.

Specified by:

buildCriterionList in interface Session

Parameters:

key - (missing javadoc)

keyAttributeNames - (missing javadoc)

Returns:

the list of criterions.

applyFindDataProjection

protected org.hibernate.Criteria applyFindDataProjection(org.hibernate.Criteria criteria,
                                                         FindData findData)

Create criteria projections from findData.

Parameters:

criteria - - the criteria to set the projection on.

findData - - the input FindData.

Returns:

the updated criteria.

applyFindDataAlias

protected org.hibernate.Criteria applyFindDataAlias(org.hibernate.Criteria criteria,
                                                    FindData findData)

Create criteria aliases for each alias instance in findData.

Parameters:

criteria - - the criteria to update.

findData - - the FindData with the aliases.

Returns:

the updated criteria.

applyFindData

protected org.hibernate.Criteria applyFindData(org.hibernate.Criteria criteria,
                                               FindData findData)

Apply settings from the findData object to the Hibernate criteria.

Parameters:

criteria - - the criteria to update.

findData - - the FindData with the criteria settings.

Returns:

the updated criteria.

applyFindData

protected org.hibernate.Query applyFindData(org.hibernate.Query query,
                                            FindData findData)

Apply settings from the findData object to the Hibernate query.

Parameters:

query - - the query to update.

findData - - the FindData with the query settings.

Returns:

the updated query.

simpleGet

protected Object simpleGet(FindData findData)
                    throws G9DataAccessException

Execute a simple get operation.

Parameters:

findData - - holds the class and key information for the get.

Returns:

the found object.

Throws:

G9DataAccessException - if an exception occurred.

qbe

protected Object qbe(FindData findData,
                     boolean all)
              throws G9DataAccessException

Execute a Query-By-Example operation.

Parameters:

findData - - holds the input parameters for the QBE.

all - - false if only the first result matching the query is returned.

Returns:

the found object.

Throws:

G9DataAccessException - if an exception occurred.

qbc

protected Object qbc(FindData findData,
                     boolean all)
              throws G9DataAccessException

Execute a Criteria based query operation.

Parameters:

findData - - holds the input parameters for the query.

all - - false if only the first result matching the query is returned.

Returns:

the found object.

Throws:

G9DataAccessException - if an exception occurred.

simpleGetImpl

protected abstract Object simpleGetImpl(FindData findData)

Subclass specific implementation of simpleGet.

Parameters:

findData - - the class and key info for the get operation.

Returns:

the found instance.

createCriteriaImpl

protected abstract org.hibernate.Criteria createCriteriaImpl(FindData findData)

Subclass specific implementation of createCriteria.

Parameters:

findData - - the FindData input for the criteria to be created.

Returns:

the new criteria.

insertImpl

protected abstract Serializable insertImpl(Object object)

Subclass specific implementation of insert.

Parameters:

object - - the object to insert.

Returns:

the key for the inserted object.

updateImpl

protected abstract void updateImpl(Object object)

Subclass specific implementation of update.

Parameters:

object - - the object to update.

mergeImpl

protected abstract Object mergeImpl(Object object)

Subclass specific implementation of merge.

Parameters:

object - - the object to merge.

Returns:

the merged object.

deleteImpl

protected abstract void deleteImpl(Object object)

Subclass specific implementation of delete.

Parameters:

object - - the object to delete.

refreshImpl

protected abstract void refreshImpl(Object object)

Subclass specific implementation of refresh.

Parameters:

object - - the object to refresh.

closeImpl

protected abstract void closeImpl()

Subclass specific implementation of session close.

flushImpl

protected abstract void flushImpl()

Subclass specific implementation of session flush.

beginTransactionImpl

protected abstract org.hibernate.Transaction beginTransactionImpl()

Subclass specific implementation of session beginTransaction.

Returns:

the transaction object.

hasActiveTransactionImpl

protected abstract boolean hasActiveTransactionImpl()

Subclass specific implementation of session hasActiveTransaction.

Returns:

true if the session has an active transaction.

buildQueryImpl

protected abstract org.hibernate.Query buildQueryImpl(String queryString)

Subclass specific implementation of buildQuery.

Parameters:

queryString - - the input for the query.

Returns:

the new query.