com.atlassian.hibernate

Class HibernateObjectDao

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate.support.HibernateDaoSupport

com.atlassian.hibernate.HibernateObjectDao

All Implemented Interfaces:

ObjectDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

BodyContentHibernateDao, CachableHibernateObjectDao, DefaultGlobalDescriptionDao, HibernateAbstractPageDao, HibernateAttachmentDataDao, HibernateContentPermissionSetDao, HibernateDraftDao, HibernateIndexQueueEntryDao, HibernateLabelDao, HibernateVersionHistoryDao, VersionedHibernateObjectDao

public abstract class HibernateObjectDao
extends org.springframework.orm.hibernate.support.HibernateDaoSupport
implements ObjectDao

Generic DAO for hibernate objects. Takes care of indexing and de-indexing, and setting creation and update times for objects.

For this reason, you should always do object CRUD through the DAO, you shouldn't trust Hibernate to do it for you: Hibernate will save the object, but skip the additional stuff the DAO does.

Subclasses will need to implement the getPersistentClass() method to return the class that the DAO is serving: that way getByClassId() will perform correctly.

Subclasses should also override updateModificationData() if they want to perform any additional modifications on objects that are being saved through the DAO. Just remember to call super. (updateModificationData will not be called if an object is saved through saveRaw())

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HibernateObjectDao.Cacheability

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	log Deprecated. Since 4.0. Use a class-private logger.

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface bucket.core.persistence.ObjectDao

NON_CACHEABLE

Constructor Summary

Constructors

Constructor and Description
HibernateObjectDao()

Method Summary

Modifier and Type	Method and Description
List	findAll() Find all objects of the class provided by getPersistentClass()
List	findAllSorted(String sortField) Find all objects currently persisted of a particular type and sort results by named property.
List	findAllSorted(String sortField, boolean cacheable, int offset, int maxResultCount) Find all objects currently persisted of a particular type and sort results by named property.
<T> PageResponse<T>	findByClassIds(Iterable<Long> ids, LimitedRequest limitedRequest, com.google.common.base.Predicate<? super T> filter) Find a list of objects from the same persistent class.
protected List	findNamedQuery(String queryName) TODO Deprecate these method variants and use findNamedQueryStringParams(String,boolean,int,int, Object[]).
protected List	findNamedQuery(String queryName, boolean cacheable) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQuery(String queryName, boolean cacheable, int maxResultCount) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQuery(String queryName, HibernateObjectDao.Cacheability cacheability)
protected List	findNamedQuery(String queryName, HibernateObjectDao.Cacheability cacheability, int maxResultCount)
protected List	findNamedQueryStringParam(String queryName, String paramName, Object paramValue)
protected List	findNamedQueryStringParam(String queryName, String paramName, Object paramValue, boolean cacheable) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQueryStringParam(String queryName, String paramName, Object paramValue, boolean cacheable, int maxResultCount) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQueryStringParam(String queryName, String paramName, Object paramValue, HibernateObjectDao.Cacheability cacheability)
protected List	findNamedQueryStringParam(String queryName, String paramName, Object paramValue, HibernateObjectDao.Cacheability cacheability, int maxResultCount)
protected List	findNamedQueryStringParams(String queryName, boolean cacheable, int offset, int maxResultCount, Object... paramNamesAndValues) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQueryStringParams(String queryName, HibernateObjectDao.Cacheability cacheability, int offset, int maxResultCount, Object... paramNamesAndValues)
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value)
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, boolean cacheable) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, boolean cacheable, int maxResultCount) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, HibernateObjectDao.Cacheability cacheability)
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, HibernateObjectDao.Cacheability cacheability, int maxResultCount)
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value)
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value, boolean cacheable) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value, boolean cacheable, int maxResultCount) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value, HibernateObjectDao.Cacheability cacheability)
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value, HibernateObjectDao.Cacheability cacheability, int maxResultCount)
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value, String param4Name, Object param4Value)
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value, String param4Name, Object param4Value, boolean cacheable) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value, String param4Name, Object param4Value, boolean cacheable, int maxResultCount) Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value, String param4Name, Object param4Value, HibernateObjectDao.Cacheability cacheability)
protected List	findNamedQueryStringParams(String queryName, String paramName, Object paramValue, String param2Name, Object param2Value, String param3Name, Object param3Value, String param4Name, Object param4Value, HibernateObjectDao.Cacheability cacheability, int maxResultCount)
protected <T extends com.atlassian.core.bean.EntityObject> T	findSingleObject(List<T> results) Deprecated. since 5.2. Entity ID comparison is not a recommended way to select a result. Use uniqueResult(java.util.List), Query.uniqueResult(), Criteria.uniqueResult(), or manually handle it yourself.
protected com.atlassian.core.bean.EntityObject	getByClassId(long id) Retrieve the object with a particular id from the database.
protected int	getCountResult(List<Integer> results)
protected void	index(com.atlassian.core.bean.EntityObject objectToSave)
void	refresh(com.atlassian.core.bean.EntityObject objectToRefresh) Update the stat of an object based on the current state of the database.
protected void	reIndex(com.atlassian.core.bean.EntityObject objectToSave)
void	remove(com.atlassian.core.bean.EntityObject objectToRemove) Remove an object from the database
void	replicate(Object objectToReplicate) Replicate the object.
void	save(com.atlassian.core.bean.EntityObject objectToSave) Save an object.
void	saveRaw(com.atlassian.core.bean.EntityObject objectToSave) Save the object without updateModificationData being called.
void	setIndexer(com.atlassian.bonnie.Indexer indexer)
protected void	unIndex(com.atlassian.core.bean.EntityObject objectToSave, boolean unindexDependents)
protected <T extends com.atlassian.core.bean.EntityObject> T	uniqueResult(List<T> results) Attempts to select a single result from a list of results.
protected void	updateModificationData(com.atlassian.core.bean.EntityObject objectToSave) Perform any modifications that need to be done to an object every time it is saved.

Methods inherited from class org.springframework.orm.hibernate.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Methods inherited from interface bucket.core.persistence.ObjectDao

getPersistentClass

Field Detail

log

@Deprecated
protected static final org.apache.log4j.Logger log

Deprecated. Since 4.0. Use a class-private logger.

Constructor Detail

HibernateObjectDao

public HibernateObjectDao()

Method Detail

setIndexer

public void setIndexer(com.atlassian.bonnie.Indexer indexer)

getByClassId

@Nullable
protected com.atlassian.core.bean.EntityObject getByClassId(long id)

Retrieve the object with a particular id from the database. The object must be of the same class as the DAO's getPersistentClass() method returns.

Parameters:

id - the id of the object to look up

Returns:

the corresponding object, or null if the object does not exist with the appropriate class and id.

findByClassIds

@Nonnull
public <T> PageResponse<T> findByClassIds(Iterable<Long> ids,
                                                   LimitedRequest limitedRequest,
                                                   com.google.common.base.Predicate<? super T> filter)

Description copied from interface: ObjectDao

Find a list of objects from the same persistent class.

Specified by:

findByClassIds in interface ObjectDao

Type Parameters:

T - the type of entity to return

Parameters:

ids - - the ids of the entities to find

limitedRequest - the pagination request defining the page size to fetch

filter - a predicate to do in memory filtering of the result set before returning

Returns:

a list of objects matching the filters

findAll

@Nonnull
public List findAll()

Find all objects of the class provided by getPersistentClass()

Specified by:

findAll in interface ObjectDao

Returns:

a list of all objects of the appropriate class, or the empty list if no objects are found

findAllSorted

@Nonnull
public List findAllSorted(String sortField)

Description copied from interface: ObjectDao

Find all objects currently persisted of a particular type and sort results by named property.

Specified by:

findAllSorted in interface ObjectDao

Parameters:

sortField - the name of the property to be sorted on. This should be null if no sorting is required.

findAllSorted

@Nonnull
public List findAllSorted(String sortField,
                                   boolean cacheable,
                                   int offset,
                                   int maxResultCount)

Description copied from interface: ObjectDao

Find all objects currently persisted of a particular type and sort results by named property. This version of the method allows more control over the query.

Specified by:

findAllSorted in interface ObjectDao

Parameters:

sortField - the name of the property to be sorted on. This should be null if no sorting is required.

cacheable - control whether the results should be cached

offset - the index of the first result to be returned

maxResultCount - the maximum number of results required. Use -1 to specify no limit.

save

public void save(com.atlassian.core.bean.EntityObject objectToSave)

Save an object. The object's last-modified time will be updated, and if the object is searchable it will be indexed.

Specified by:

save in interface ObjectDao

Parameters:

objectToSave -

updateModificationData

protected void updateModificationData(com.atlassian.core.bean.EntityObject objectToSave)

Perform any modifications that need to be done to an object every time it is saved. The default implementation updates the last-modified timestamp, and sets the creation timestamp if it has not yet been set.

Parameters:

objectToSave - the object that is about to be saved

saveRaw

public void saveRaw(com.atlassian.core.bean.EntityObject objectToSave)

Save the object without updateModificationData being called. Modification/creation time will not be set, but the object will still be indexed if it is searchable.

Specified by:

saveRaw in interface ObjectDao

Parameters:

objectToSave - object to save

remove

public void remove(com.atlassian.core.bean.EntityObject objectToRemove)

Remove an object from the database

Specified by:

remove in interface ObjectDao

Parameters:

objectToRemove - the object to remove

refresh

public void refresh(com.atlassian.core.bean.EntityObject objectToRefresh)

Update the stat of an object based on the current state of the database. The object will be modified in place

Specified by:

refresh in interface ObjectDao

Parameters:

objectToRefresh - the object to refresh

replicate

public void replicate(Object objectToReplicate)

Description copied from interface: ObjectDao

Replicate the object. Replication does not generate a new id if the object does not exist in database and it overwrites the database row if the object already exists in database.

Specified by:

replicate in interface ObjectDao

index

protected void index(com.atlassian.core.bean.EntityObject objectToSave)

reIndex

protected void reIndex(com.atlassian.core.bean.EntityObject objectToSave)

unIndex

protected void unIndex(com.atlassian.core.bean.EntityObject objectToSave,
                       boolean unindexDependents)

findNamedQuery

protected List findNamedQuery(String queryName)

TODO Deprecate these method variants and use findNamedQueryStringParams(String,boolean,int,int, Object[]).

findNamedQuery

@Deprecated
protected List findNamedQuery(String queryName,
                                          boolean cacheable)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQuery

protected List findNamedQuery(String queryName,
                              HibernateObjectDao.Cacheability cacheability)

findNamedQuery

@Deprecated
protected List findNamedQuery(String queryName,
                                          boolean cacheable,
                                          int maxResultCount)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQuery

protected List findNamedQuery(String queryName,
                              HibernateObjectDao.Cacheability cacheability,
                              int maxResultCount)

findNamedQueryStringParam

protected List findNamedQueryStringParam(String queryName,
                                         String paramName,
                                         Object paramValue)

findNamedQueryStringParam

@Deprecated
protected List findNamedQueryStringParam(String queryName,
                                                     String paramName,
                                                     Object paramValue,
                                                     boolean cacheable)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQueryStringParam

protected List findNamedQueryStringParam(String queryName,
                                         String paramName,
                                         Object paramValue,
                                         HibernateObjectDao.Cacheability cacheability)

findNamedQueryStringParam

@Deprecated
protected List findNamedQueryStringParam(String queryName,
                                                     String paramName,
                                                     Object paramValue,
                                                     boolean cacheable,
                                                     int maxResultCount)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQueryStringParam

protected List findNamedQueryStringParam(String queryName,
                                         String paramName,
                                         Object paramValue,
                                         HibernateObjectDao.Cacheability cacheability,
                                         int maxResultCount)

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          String paramName,
                                          Object paramValue,
                                          String param2Name,
                                          Object param2Value)

findNamedQueryStringParams

@Deprecated
protected List findNamedQueryStringParams(String queryName,
                                                      String paramName,
                                                      Object paramValue,
                                                      String param2Name,
                                                      Object param2Value,
                                                      boolean cacheable)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          String paramName,
                                          Object paramValue,
                                          String param2Name,
                                          Object param2Value,
                                          HibernateObjectDao.Cacheability cacheability)

findNamedQueryStringParams

@Deprecated
protected List findNamedQueryStringParams(String queryName,
                                                      String paramName,
                                                      Object paramValue,
                                                      String param2Name,
                                                      Object param2Value,
                                                      boolean cacheable,
                                                      int maxResultCount)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          String paramName,
                                          Object paramValue,
                                          String param2Name,
                                          Object param2Value,
                                          HibernateObjectDao.Cacheability cacheability,
                                          int maxResultCount)

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          String paramName,
                                          Object paramValue,
                                          String param2Name,
                                          Object param2Value,
                                          String param3Name,
                                          Object param3Value)

findNamedQueryStringParams

@Deprecated
protected List findNamedQueryStringParams(String queryName,
                                                      String paramName,
                                                      Object paramValue,
                                                      String param2Name,
                                                      Object param2Value,
                                                      String param3Name,
                                                      Object param3Value,
                                                      boolean cacheable)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          String paramName,
                                          Object paramValue,
                                          String param2Name,
                                          Object param2Value,
                                          String param3Name,
                                          Object param3Value,
                                          HibernateObjectDao.Cacheability cacheability)

findNamedQueryStringParams

@Deprecated
protected List findNamedQueryStringParams(String queryName,
                                                      String paramName,
                                                      Object paramValue,
                                                      String param2Name,
                                                      Object param2Value,
                                                      String param3Name,
                                                      Object param3Value,
                                                      boolean cacheable,
                                                      int maxResultCount)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          String paramName,
                                          Object paramValue,
                                          String param2Name,
                                          Object param2Value,
                                          String param3Name,
                                          Object param3Value,
                                          HibernateObjectDao.Cacheability cacheability,
                                          int maxResultCount)

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          String paramName,
                                          Object paramValue,
                                          String param2Name,
                                          Object param2Value,
                                          String param3Name,
                                          Object param3Value,
                                          String param4Name,
                                          Object param4Value)

findNamedQueryStringParams

@Deprecated
protected List findNamedQueryStringParams(String queryName,
                                                      String paramName,
                                                      Object paramValue,
                                                      String param2Name,
                                                      Object param2Value,
                                                      String param3Name,
                                                      Object param3Value,
                                                      String param4Name,
                                                      Object param4Value,
                                                      boolean cacheable)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          String paramName,
                                          Object paramValue,
                                          String param2Name,
                                          Object param2Value,
                                          String param3Name,
                                          Object param3Value,
                                          String param4Name,
                                          Object param4Value,
                                          HibernateObjectDao.Cacheability cacheability)

findNamedQueryStringParams

@Deprecated
protected List findNamedQueryStringParams(String queryName,
                                                      String paramName,
                                                      Object paramValue,
                                                      String param2Name,
                                                      Object param2Value,
                                                      String param3Name,
                                                      Object param3Value,
                                                      String param4Name,
                                                      Object param4Value,
                                                      boolean cacheable,
                                                      int maxResultCount)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          String paramName,
                                          Object paramValue,
                                          String param2Name,
                                          Object param2Value,
                                          String param3Name,
                                          Object param3Value,
                                          String param4Name,
                                          Object param4Value,
                                          HibernateObjectDao.Cacheability cacheability,
                                          int maxResultCount)

findNamedQueryStringParams

@Deprecated
protected List findNamedQueryStringParams(String queryName,
                                                      boolean cacheable,
                                                      int offset,
                                                      int maxResultCount,
                                                      Object... paramNamesAndValues)

Deprecated. since 5.8 Use the equivalent method that uses the HibernateObjectDao.Cacheability enum instead of the cacheable boolean flag

findNamedQueryStringParams

protected List findNamedQueryStringParams(String queryName,
                                          HibernateObjectDao.Cacheability cacheability,
                                          int offset,
                                          int maxResultCount,
                                          Object... paramNamesAndValues)

getCountResult

protected int getCountResult(List<Integer> results)

findSingleObject

@Deprecated
 @Nullable
protected <T extends com.atlassian.core.bean.EntityObject> T findSingleObject(List<T> results)

Deprecated. since 5.2. Entity ID comparison is not a recommended way to select a result. Use uniqueResult(java.util.List), Query.uniqueResult(), Criteria.uniqueResult(), or manually handle it yourself.

Attempts to select a single result from a list of results. If the list has only one item, then that item is returned. If the list has more than one item, then the item with the lowest ID is returned. If the list is empty, null is returned.

uniqueResult

protected <T extends com.atlassian.core.bean.EntityObject> T uniqueResult(List<T> results)
                                                                   throws net.sf.hibernate.NonUniqueResultException

Attempts to select a single result from a list of results. If the list has only one item, then that item is returned. If the list has more than one item, then an exception will be thrown unless all items in the list are the same object. If the list is empty, null is returned.

Returns:

The single unique object in the list, or null if list is empty

Throws:

net.sf.hibernate.NonUniqueResultException - If more than one unique objects is found in the list.