com.logicaldoc.core.document.dao

Class HibernateDocumentDAO

java.lang.Object

com.logicaldoc.core.HibernatePersistentObjectDAO<Document>

com.logicaldoc.core.document.dao.HibernateDocumentDAO

All Implemented Interfaces:

DocumentDAO, PersistentObjectDAO<Document>

public class HibernateDocumentDAO
extends HibernatePersistentObjectDAO<Document>
implements DocumentDAO

Hibernate implementation of DocumentDAO

Since:

3.0

Author:

Marco Meschieri - 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	cleanExpiredTransactions() Cleans all references to expired transactions.
long	count(boolean computeDeleted) Counts the number of documents
long	countByIndexed(int indexed) Counts the number of documents indexed or not
boolean	delete(long docId, History transaction) This method deletes the document object and insert a new document history entry.
void	deleteAll(Collection<Document> documents, History transaction) Deletes all documents form the database and modifies the custom ids of all documents
boolean	deleteOrphaned(long deleteUserId) This method deletes the documents into deleted folders.
List<String>	findAllTags(String firstLetter) Searches for all tags,
Document	findByCustomId(String customId) This method finds a document by the custom ID.
List<Document>	findByFileNameAndParentFolderId(Long folderId, String fileName, Long excludeId, Integer max) Finds that document that lies under a specific folder (given by the id) an with a given fileName(like operator is used)
List<Document>	findByFolder(long folderId, Integer max) Finds all documents inside the given folder.
List<Document>	findByIds(Long[] ids, Integer max) Finds all documents whose id is included in the given pool of ids
List<Document>	findByIndexed(int indexed) Finds all documents by the indexed state.
List<Document>	findByLockUserAndStatus(Long userId, Integer status) Finds all document of the specified status and locked by the specified user
List<Document>	findByTitleAndParentFolderId(long folderId, String title, Long excludeId) Finds that document that lies under a specific folder (given by the id) an with a given title(like operator is used)
List<Long>	findByUserId(long userId) Finds all documents for an user.
List<Document>	findByUserIdAndTag(long userId, String tag, Integer max) Finds authorized documents for a user having a specified tag.
List<Document>	findDeleted(long userId, Integer maxHits) Finds all deleted docs of a specific user.
List<Long>	findDeletedDocIds() Gets the collection of deleted document ids
List<Document>	findDeletedDocs() Finds the list of deleted documents.
List<Long>	findDocIdByFolder(long folderId, Integer max) Finds all document ids inside the given folder.
List<Long>	findDocIdByTag(String tag) This method finds all Doc Ids by a tag.
List<Long>	findDocIdByUserIdAndTag(long userId, String tag) Finds authorized documents ids for a user having a specified tag.
List<Document>	findLastDownloadsByUserId(long userId, int maxResults) Finds the last downloaded documents by the given user
List<Document>	findLastModifiedByUserId(long userId, int maxElements) Finds a max number of documents last modified by an user.
List<Document>	findLinkedDocuments(long docId, String linkType, Integer direction) This method enlists documents linked to the given document.
List<Document>	findLockedByUserId(long userId) Deprecated.
Collection<Long>	findPublishedIds(Collection<Long> folderIds) Finds all document ids inside the specified folders that are published in the current date.
List<Long>	findShortcutIds(long docId) Gets the ids of all shortcuts associated to the document with the given docId
Map<String,Integer>	findTags(String firstLetter) This method selects all tags and counts the occurrences.
long	getTotalSize(boolean computeDeleted) Obtains the total size of the archive, that is the sum of sizes of all documents
void	initialize(Document doc) Doesn't do anything by default
void	makeImmutable(long docId, History transaction) Marks the document, with the given docId, as immutable.
void	restore(long docId, long folderId, History transaction) Restores a previously deleted document
void	setConfig(ContextProperties config)
void	setFolderDAO(FolderDAO folderDAO)
void	setHistoryDAO(HistoryDAO historyDAO)
void	setLinkDAO(DocumentLinkDAO linkDAO)
void	setListenerManager(DocumentListenerManager listenerManager)
void	setNoteDAO(DocumentNoteDAO noteDAO)
void	setStorer(Storer storer)
void	setUserDAO(UserDAO userDAO)
void	setUserDocDAO(UserDocDAO userDocDAO)
void	setVersionDAO(VersionDAO versionDAO)
boolean	store(Document doc) This method persists the entity object.
boolean	store(Document doc, History transaction) This method persists the document object and insert a new document history entry.
void	updateDigest(Document doc) Updates the document's digest (SHA-1)

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, 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, jdbcUpdate, jdbcUpdate, query, queryForInt, queryForList, queryForList, queryForLong, queryForRowSet

Method Detail

setListenerManager

public void setListenerManager(DocumentListenerManager listenerManager)

setUserDocDAO

public void setUserDocDAO(UserDocDAO userDocDAO)

setVersionDAO

public void setVersionDAO(VersionDAO versionDAO)

setLinkDAO

public void setLinkDAO(DocumentLinkDAO linkDAO)

setUserDAO

public void setUserDAO(UserDAO userDAO)

setHistoryDAO

public void setHistoryDAO(HistoryDAO historyDAO)

delete

public boolean delete(long docId,
             History transaction)

Description copied from interface: DocumentDAO

This method deletes the document object and insert a new document history entry.

Specified by:

delete in interface DocumentDAO

Parameters:

docId - The id of the document to delete

transaction - entry to log the event

Returns:

True if successfully deleted from the database.

findByUserId

public List<Long> findByUserId(long userId)

Description copied from interface: DocumentDAO

Finds all documents for an user.

Specified by:

findByUserId in interface DocumentDAO

Parameters:

userId - ID of the user.

Returns:

Collection of all documentId required for the specified user.

findLockedByUserId

@Deprecated
public List<Document> findLockedByUserId(long userId)

Deprecated.

Description copied from interface: DocumentDAO

Finds all documents locked by a user.

Specified by:

findLockedByUserId in interface DocumentDAO

Parameters:

userId - Id of the user.

Returns:

Collection of all Documents locked by the specified user.

See Also:

com.logicaldoc.core.document.dao.DocumentDAO#findLockedByUserId(java.lang.String)

findByLockUserAndStatus

public List<Document> findByLockUserAndStatus(Long userId,
                                     Integer status)

Description copied from interface: DocumentDAO

Finds all document of the specified status and locked by the specified user

Specified by:

findByLockUserAndStatus in interface DocumentDAO

Parameters:

userId - The user id(optional)

status - The status code(optional)

Returns:

Collection of all Documents locked by the specified user and of the specified status.

findDocIdByTag

public List<Long> findDocIdByTag(String tag)

Description copied from interface: DocumentDAO

This method finds all Doc Ids by a tag.

Specified by:

findDocIdByTag in interface DocumentDAO

Parameters:

tag - Tag of the document.

Returns:

Document with specified tag.

store

public boolean store(Document doc)

Description copied from interface: PersistentObjectDAO

This method persists the entity object.

Specified by:

store in interface PersistentObjectDAO<Document>

Overrides:

store in class HibernatePersistentObjectDAO<Document>

Parameters:

doc - entity to be stored.

Returns:

True if successfully stored in a database.

store

public boolean store(Document doc,
            History transaction)

Description copied from interface: DocumentDAO

This method persists the document object and insert a new document history entry.

Specified by:

store in interface DocumentDAO

transaction - entry to log the event

Returns:

True if successfully stored in a database.

updateDigest

public void updateDigest(Document doc)

Description copied from interface: DocumentDAO

Updates the document's digest (SHA-1)

Specified by:

updateDigest in interface DocumentDAO

Parameters:

doc - The document to be processed

findLastModifiedByUserId

public List<Document> findLastModifiedByUserId(long userId,
                                      int maxElements)

Description copied from interface: DocumentDAO

Finds a max number of documents last modified by an user.

Specified by:

findLastModifiedByUserId in interface DocumentDAO

Parameters:

userId - ID of the user.

Returns:

Collection of the last documents changed by the specified user.

findTags

public Map<String,Integer> findTags(String firstLetter)

Description copied from interface: DocumentDAO

This method selects all tags and counts the occurrences.

Specified by:

findTags in interface DocumentDAO

findAllTags

public List<String> findAllTags(String firstLetter)

Description copied from interface: DocumentDAO

Searches for all tags,

Specified by:

findAllTags in interface DocumentDAO

Parameters:

firstLetter - Optional first letter hint

Returns:

The list of all tags in the system

findByUserIdAndTag

public List<Document> findByUserIdAndTag(long userId,
                                String tag,
                                Integer max)

Description copied from interface: DocumentDAO

Finds authorized documents for a user having a specified tag.

Specified by:

findByUserIdAndTag in interface DocumentDAO

Parameters:

userId - ID of the user

tag - Tag of the document

max - Optional, defines the maximum records number

Returns:

Collection of found documents

findDocIdByUserIdAndTag

public List<Long> findDocIdByUserIdAndTag(long userId,
                                 String tag)

Description copied from interface: DocumentDAO

Finds authorized documents ids for a user having a specified tag.

Specified by:

findDocIdByUserIdAndTag in interface DocumentDAO

Parameters:

userId - ID of the user.

tag - Tag of the document

Returns:

Set of found ids.

findLastDownloadsByUserId

public List<Document> findLastDownloadsByUserId(long userId,
                                       int maxResults)

Description copied from interface: DocumentDAO

Finds the last downloaded documents by the given user

Specified by:

findLastDownloadsByUserId in interface DocumentDAO

Parameters:

userId - id of the user

maxResults - maximum number of returned elements

Returns:

findDocIdByFolder

public List<Long> findDocIdByFolder(long folderId,
                           Integer max)

Description copied from interface: DocumentDAO

Finds all document ids inside the given folder.

Specified by:

findDocIdByFolder in interface DocumentDAO

Parameters:

folderId - Folder identifier

Returns:

Collection of all document id in the folder.

findByFolder

public List<Document> findByFolder(long folderId,
                          Integer max)

Description copied from interface: DocumentDAO

Finds all documents inside the given folder.

Specified by:

findByFolder in interface DocumentDAO

Parameters:

folderId - Folder identifier

Returns:

Collection of all documents in the folder.

findLinkedDocuments

public List<Document> findLinkedDocuments(long docId,
                                 String linkType,
                                 Integer direction)

Description copied from interface: DocumentDAO

This method enlists documents linked to the given document.

Important: The attribute direction defines the search logic as follows:

• 1: docId will be compared to link's document1
• 2: docId will be compared to link's document2
• null: docId will be compared to both document1 and document2

Specified by:

findLinkedDocuments in interface DocumentDAO

Parameters:

docId - All documents linked to this one will be searched

linkType - Type of the link (optional)

direction - if 1 docId will be compared to link's document1, id 2 docId will be compared to link's document2, if null docId will be compared to both document1 and document2 of the link.

Returns:

The collection of linked documents

findByFileNameAndParentFolderId

public List<Document> findByFileNameAndParentFolderId(Long folderId,
                                             String fileName,
                                             Long excludeId,
                                             Integer max)

Description copied from interface: DocumentDAO

Finds that document that lies under a specific folder (given by the id) an with a given fileName(like operator is used)

Specified by:

findByFileNameAndParentFolderId in interface DocumentDAO

Parameters:

folderId - The folder id (it can be null).

excludeId - Optional id of a document that must not be considered

max - Optional maximum number of returned elements

Returns:

The list of documents with the given fileName. If the folder id is null, the searched document can belong to any folder in the repository.

findByTitleAndParentFolderId

public List<Document> findByTitleAndParentFolderId(long folderId,
                                          String title,
                                          Long excludeId)

Description copied from interface: DocumentDAO

Finds that document that lies under a specific folder (given by the id) an with a given title(like operator is used)

Specified by:

findByTitleAndParentFolderId in interface DocumentDAO

Parameters:

folderId - The folder id (it can be null).

excludeId - Optional id of a document that must not be considered

Returns:

initialize

public void initialize(Document doc)

Description copied from class: HibernatePersistentObjectDAO

Doesn't do anything by default

Specified by:

initialize in interface DocumentDAO

Specified by:

initialize in interface PersistentObjectDAO<Document>

Overrides:

initialize in class HibernatePersistentObjectDAO<Document>

Parameters:

doc - The entity to be initialised

findDeletedDocIds

public List<Long> findDeletedDocIds()

Description copied from interface: DocumentDAO

Gets the collection of deleted document ids

Specified by:

findDeletedDocIds in interface DocumentDAO

findDeletedDocs

public List<Document> findDeletedDocs()

Description copied from interface: DocumentDAO

Finds the list of deleted documents.

Attention: The returned objects are not fully operative and are populated with a minimal set of data.

Specified by:

findDeletedDocs in interface DocumentDAO

getTotalSize

public long getTotalSize(boolean computeDeleted)

Description copied from interface: DocumentDAO

Obtains the total size of the archive, that is the sum of sizes of all documents

Specified by:

getTotalSize in interface DocumentDAO

Parameters:

computeDeleted - If true, even deleted documents are considered

Returns:

count

public long count(boolean computeDeleted)

Description copied from interface: DocumentDAO

Counts the number of documents

Specified by:

count in interface DocumentDAO

Parameters:

computeDeleted - If true, even deleted documents are considered

findByIndexed

public List<Document> findByIndexed(int indexed)

Description copied from interface: DocumentDAO

Finds all documents by the indexed state. Order by ascending lastModifed

Specified by:

findByIndexed in interface DocumentDAO

Parameters:

indexed - the indexed property

Returns:

Collection of all documents

restore

public void restore(long docId,
           long folderId,
           History transaction)

Description copied from interface: DocumentDAO

Restores a previously deleted document

Specified by:

restore in interface DocumentDAO

Parameters:

docId - Id of the document to be restored

folderId - Id of the folder the document will be restored into

transaction - entry to log the event

findByCustomId

public Document findByCustomId(String customId)

Description copied from interface: DocumentDAO

This method finds a document by the custom ID.

Specified by:

findByCustomId in interface DocumentDAO

Parameters:

customId - custom ID of the document.

Returns:

Document with given ID.

makeImmutable

public void makeImmutable(long docId,
                 History transaction)

Description copied from interface: DocumentDAO

Marks the document, with the given docId, as immutable. Unlocks the document if it was locked.

Specified by:

makeImmutable in interface DocumentDAO

transaction - entry to log the event

deleteAll

public void deleteAll(Collection<Document> documents,
             History transaction)

Description copied from interface: DocumentDAO

Deletes all documents form the database and modifies the custom ids of all documents

Specified by:

deleteAll in interface DocumentDAO

Parameters:

documents - The documents to be deleted

transaction - entry to log the event

setNoteDAO

public void setNoteDAO(DocumentNoteDAO noteDAO)

setStorer

public void setStorer(Storer storer)

countByIndexed

public long countByIndexed(int indexed)

Description copied from interface: DocumentDAO

Counts the number of documents indexed or not

Specified by:

countByIndexed in interface DocumentDAO

findShortcutIds

public List<Long> findShortcutIds(long docId)

Description copied from interface: DocumentDAO

Gets the ids of all shortcuts associated to the document with the given docId

Specified by:

findShortcutIds in interface DocumentDAO

Parameters:

docId - The document Id

findDeleted

public List<Document> findDeleted(long userId,
                         Integer maxHits)

Description copied from interface: DocumentDAO

Finds all deleted docs of a specific user.

Specified by:

findDeleted in interface DocumentDAO

Parameters:

userId - The user that performed the deletion

maxHits - Optional defines the max number of returned hits

Returns:

The documents list ordered by descending lastModified

setConfig

public void setConfig(ContextProperties config)

setFolderDAO

public void setFolderDAO(FolderDAO folderDAO)

findByIds

public List<Document> findByIds(Long[] ids,
                       Integer max)

Description copied from interface: DocumentDAO

Finds all documents whose id is included in the given pool of ids

Specified by:

findByIds in interface DocumentDAO

deleteOrphaned

public boolean deleteOrphaned(long deleteUserId)

Description copied from interface: DocumentDAO

This method deletes the documents into deleted folders.

Specified by:

deleteOrphaned in interface DocumentDAO

Parameters:

deleteUserId - The id of the user that performs the deleting.

Returns:

True if successfully deleted from the database.

findPublishedIds

public Collection<Long> findPublishedIds(Collection<Long> folderIds)

Description copied from interface: DocumentDAO

Finds all document ids inside the specified folders that are published in the current date.

Specified by:

findPublishedIds in interface DocumentDAO

Parameters:

folderIds - Set of folder ids in which the method will search

Returns:

List of published document ids

cleanExpiredTransactions

public void cleanExpiredTransactions()

Description copied from interface: DocumentDAO

Cleans all references to expired transactions. If no lock is found for a document referencing a given transaction, the transactionId will be set to null.

Specified by:

cleanExpiredTransactions in interface DocumentDAO