com.logicaldoc.core.document.dao

Class HibernateHistoryDAO

java.lang.Object

com.logicaldoc.core.HibernatePersistentObjectDAO<History>

com.logicaldoc.core.document.dao.HibernateHistoryDAO

All Implemented Interfaces:

HistoryDAO, PersistentObjectDAO<History>

public class HibernateHistoryDAO
extends HibernatePersistentObjectDAO<History>
implements HistoryDAO

Hibernate implementation of HistoryDAO

Since:

3.0

Author:

Alessandro Gasparini - Logical Objects

Field Summary

Fields inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO

entityClass, log, sessionFactory

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanOldHistories(int ttl) This method deletes all the document history entries oldest than the given days from now.
List<History>	findByDocId(long docId) This method selects all histories of a given document.
List<History>	findByFolderId(long folderId) This method selects all histories of a given folder.
List<History>	findByPath(String pathExpression, Date olderDate, Collection<String> events, Integer max) This method finds all histories about a path (you can use expression)
List<History>	findByUserId(long userId) This method selects all histories of a given user.
List<History>	findByUserIdAndEvent(long userId, String event, String sessionId) This method selects all histories of a given user and related to the given event.
List<History>	findNotNotified(Integer max) This method selects all histories not notified yet.
boolean	isEnabled() Checks if the histories recording is enabled
void	setConfig(ContextProperties config)
boolean	store(History entity) This method persists the entity object.

Methods inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO

bulkUpdate, delete, deleteAll, evict, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, flush, getConnection, getCurrentSession, getDbms, getSessionFactory, initialize, isHsql, isMySQL, isOracle, isSqlServer, jdbcUpdate, jdbcUpdate, merge, prepareQuery, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet, refresh, saveOrUpdate, setSessionFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO

bulkUpdate, delete, deleteAll, findAll, findAllIds, findById, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDbms, initialize, jdbcUpdate, jdbcUpdate, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet

Method Detail

findByDocId

public List<History> findByDocId(long docId)

Description copied from interface: HistoryDAO

This method selects all histories of a given document.

Specified by:

findByDocId in interface HistoryDAO

Parameters:

docId - - ID of the document.

Returns:

list of histories ordered by date

See Also:

HistoryDAO.findByDocId(long)

findByUserId

public List<History> findByUserId(long userId)

Description copied from interface: HistoryDAO

This method selects all histories of a given user.

Specified by:

findByUserId in interface HistoryDAO

Returns:

list of histories ordered by date

See Also:

HistoryDAO.findByUserId(long)

findByFolderId

public List<History> findByFolderId(long folderId)

Description copied from interface: HistoryDAO

This method selects all histories of a given folder.

Specified by:

findByFolderId in interface HistoryDAO

Parameters:

folderId - - ID of the document.

Returns:

list of histories ordered by date

See Also:

HistoryDAO.findByFolderId(long)

findNotNotified

public List<History> findNotNotified(Integer max)

Description copied from interface: HistoryDAO

This method selects all histories not notified yet.

Specified by:

findNotNotified in interface HistoryDAO

Returns:

max Optional maximum number of records

cleanOldHistories

public void cleanOldHistories(int ttl)

Description copied from interface: HistoryDAO

This method deletes all the document history entries oldest than the given days from now. If ttl is 0 or -1, the cancellation is not made.

Specified by:

cleanOldHistories in interface HistoryDAO

Parameters:

ttl - The maximum number of days over which the history is considered old

See Also:

UserHistoryDAO.cleanOldHistories(int)

findByUserIdAndEvent

public List<History> findByUserIdAndEvent(long userId,
                                 String event,
                                 String sessionId)

Description copied from interface: HistoryDAO

This method selects all histories of a given user and related to the given event.

Specified by:

findByUserIdAndEvent in interface HistoryDAO

Parameters:

userId - The user identifier

event - The string represtation of history event (optional)

sessionId - The session identifier (optional)

Returns:

list of histories ordered by date

store

public boolean store(History entity)

Description copied from interface: PersistentObjectDAO

This method persists the entity object.

Specified by:

store in interface PersistentObjectDAO<History>

Overrides:

store in class HibernatePersistentObjectDAO<History>

Parameters:

entity - entity to be stored.

Returns:

True if successfully stored in a database.

isEnabled

public boolean isEnabled()

Description copied from interface: HistoryDAO

Checks if the histories recording is enabled

Specified by:

isEnabled in interface HistoryDAO

setConfig

public void setConfig(ContextProperties config)

findByPath

public List<History> findByPath(String pathExpression,
                       Date olderDate,
                       Collection<String> events,
                       Integer max)

Description copied from interface: HistoryDAO

This method finds all histories about a path (you can use expression)

Specified by:

findByPath in interface HistoryDAO

Parameters:

pathExpression - The path expression (like /Default/acme%)

olderDate - The older date for the retrieved histories

max - Optional maximum number of records

Returns: