Package com.logicaldoc.core.document

Class HibernateDocumentDAO

java.lang.Object

com.logicaldoc.core.HibernatePersistentObjectDAO<Document>

com.logicaldoc.core.document.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 - LogicalDOC

Field Summary

Fields inherited from interface com.logicaldoc.core.PersistentObjectDAO

ENTITY

Method Summary

Modifier and Type	Method	Description
void	applyParentFolderSecurity(long docId, DocumentHistory transaction)	Replaces the document's security policies with those from the parent folder
void	archive(long docId, DocumentHistory transaction)	Archives a document
void	cleanExpiredTransactions()	Cleans all references to expired transactions.
void	cleanUnexistingUniqueTags()	Cleans the ld_uniquetag table removing no more used tags, this method is optimized and uses a couple of prepared statements, in case of error it switches to DocumentDAO.cleanUnexistingUniqueTagsOneByOne()
void	cleanUnexistingUniqueTagsOneByOne()	Cleans the ld_uniquetag table removing no more used tags programmatically one by one.
long	computeTotalSize(Long tenantId, Long userId, boolean computeDeleted)	Obtains the total size of the repository, that is the sum of sizes of all documents and their versions
long	count(Long tenantId, boolean computeDeleted, boolean computeArchived)	Counts the number of documents
long	countByIndexed(int indexed)	Counts the number of documents in a given indexation status(@see AbstractDocument.getIndexed()
void	delete(long docId, int delCode, DocumentHistory transaction)	This method deletes the document object and insert a new document history entry.
void	delete(long docId, DocumentHistory transaction)	Shortcut for delete(docId, 1, transaction)
void	deleteAll(Collection<Document> documents, int delCode, DocumentHistory transaction)	Deletes all documents form the database and modifies the custom ids of all documents
void	deleteAll(Collection<Document> documents, DocumentHistory transaction)	Shortcut for deleteAll(documents, 1, transaction)
void	deleteOrphaned(long deleteUserId)	This method deletes the documents into deleted folders.
List<Long>	findAliasIds(long docId)	Gets the ids of all aliases associated to the document with the given docId
List<String>	findAllTags(String firstLetter, Long tenantId)	Searches for all tags,
List<Document>	findArchivedByFolder(long folderId)	Finds archived documents in a folder (direct childeren only)
Document	findByCustomId(String customId, long tenantId)	This method finds a document by the custom ID.
List<Document>	findByFileNameAndParentFolderId(Long folderId, String fileName, Long excludeId, Long tenantId, 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 direct children of the given folder.
List<Document>	findByIds(Set<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 of0 the specified status and locked by the specified user
Document	findByPath(String path, long tenantId)	Finds a document by it's full path
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.
Document	findDocument(long docId)	This method finds a document by the ID and if it is an alias the referenced document is returned instead.
List<String>	findDuplicatedDigests(Long tenantId, Long folderId)	Retrieves the list of duplicated checksums
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.
Collection<Long>	findPublishedIds(Collection<Long> folderIds)	Finds all document ids inside the specified folders that are published in the current date.
List<String>	findTags(long docId)	Retrieves the alphabetically ordered list of all the document's tags
Map<String,Long>	findTags(String firstLetter, Long tenantId)	Selects all tags and counts the occurrences.
Set<Permission>	getAllowedPermissions(long docId, long userId)	Finds all permissions of a user enabled on the specified document
List<TagCloud>	getTagCloud(long tenantId, int maxTags)	Gets the tag cloud for the given tenant
List<TagCloud>	getTagCloud(String sid)	Gets the tag cloud for the given tenant
Folder	getWorkspace(long docId)	Retrieves, the workspace where the document(or alias) is stored
void	initialize(Document doc)	Doesn't do anything by default
void	insertNewUniqueTags()	Puts into ld_uniquetag the new unique tags
boolean	isDownloadAllowed(long id, long userId)
boolean	isMoveAllowed(long id, long userId)
boolean	isPermissionAllowed(Permission permission, long documentId, long userId)	This method checks if the given permission is enabled for a document and an user.
boolean	isPreviewAllowed(long docId, long userId)
boolean	isPrintAllowed(long id, long userId)
boolean	isReadAllowed(long docId, long userId)
boolean	isWriteAllowed(long id, long userId)	This method is looking up for writing rights for a document and an user.
void	makeImmutable(long docId, DocumentHistory transaction)	Marks the document, with the given docId, as immutable.
void	restore(long docId, long folderId, DocumentHistory transaction)	Restores a previously deleted document
void	saveDocumentHistory(Document doc, DocumentHistory transaction)	Saves a document's history
void	setPassword(long docId, String password, DocumentHistory transaction)	Protects the document with a password.
void	store(Document doc)	This method persists the entity object
void	store(Document doc, DocumentHistory transaction)	This method persists the document object and insert a new document history entry
void	unarchive(long docId, DocumentHistory transaction)	Restores a previously archived document
void	unsetPassword(long docId, DocumentHistory transaction)	Removes the password protection from the document.
void	updateCountUniqueTags()	Updates the count of the unique tags
void	updateDigest(Document doc)	Updates the document's digest (SHA-1)

Methods inherited from class com.logicaldoc.core.HibernatePersistentObjectDAO

bulkUpdate, delete, delete, deleteAll, deleteAll, findAll, findAll, findAllIds, findAllIds, findById, findById, findByObjectQuery, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDatabaseMetadata, getDbms, getSessionFactory, isOracle, jdbcUpdate, jdbcUpdate, query, query, queryForDouble, queryForDouble, queryForInt, queryForList, queryForList, queryForList, queryForLong, queryForLong, queryForObject, queryForRowSet, queryForRowSet, queryForString, setSessionFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.logicaldoc.core.PersistentObjectDAO

bulkUpdate, delete, delete, deleteAll, deleteAll, findAll, findAll, findAllIds, findAllIds, findById, findById, findByObjectQuery, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDatabaseMetadata, getDbms, isOracle, jdbcUpdate, jdbcUpdate, query, query, queryForDouble, queryForDouble, queryForInt, queryForList, queryForList, queryForList, queryForLong, queryForLong, queryForObject, queryForRowSet, queryForRowSet, queryForString

Method Details

archive

public void archive(long docId,
 DocumentHistory transaction)
             throws PersistenceException

Description copied from interface: DocumentDAO

Archives a document

Specified by:

archive in interface DocumentDAO

Parameters:

docId - identifier of the document

transaction - entry to log the event

Throws:

PersistenceException - error at data layer

unarchive

public void unarchive(long docId,
 DocumentHistory transaction)
               throws PersistenceException

Description copied from interface: DocumentDAO

Restores a previously archived document

Specified by:

unarchive in interface DocumentDAO

Parameters:

docId - Ids of the document to be restored

transaction - entry to log the event

Throws:

PersistenceException - error at data layer

delete

public void delete(long docId,
 DocumentHistory transaction)
            throws PersistenceException

Description copied from interface: DocumentDAO

Shortcut for delete(docId, 1, transaction)

Specified by:

delete in interface DocumentDAO

Parameters:

docId - identifier of the document

transaction - entry to log the event

Throws:

PersistenceException - error at data layer

delete

public void delete(long docId,
 int delCode,
 DocumentHistory transaction)
            throws PersistenceException

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

delCode - The deletion code

transaction - entry to log the event

Throws:

PersistenceException - error at data layer

findByUserId

public List<Long> findByUserId(long userId)
                        throws PersistenceException

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.

Throws:

PersistenceException - error at data layer

findByLockUserAndStatus

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

Description copied from interface: DocumentDAO

Finds all document of0 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)
                          throws PersistenceException

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.

Throws:

PersistenceException - error at data layer

store

public void store(Document doc)
           throws PersistenceException

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

Throws:

PersistenceException - raised in case of errors in the database

store

public void store(Document doc,
 DocumentHistory transaction)
           throws PersistenceException

Description copied from interface: DocumentDAO

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

Specified by:

store in interface DocumentDAO

Parameters:

doc - the document

transaction - entry to log the event

Throws:

PersistenceException - error at data layer

updateDigest

public void updateDigest(Document doc)
                  throws PersistenceException

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

Throws:

PersistenceException - error at data layer

findLastModifiedByUserId

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

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.

maxElements - maximum number of returned elements

Returns:

Collection of the last documents changed by the specified user.

Throws:

PersistenceException - error at data layer

findTags

public List<String> findTags(long docId)
                      throws PersistenceException

Description copied from interface: DocumentDAO

Retrieves the alphabetically ordered list of all the document's tags

Specified by:

findTags in interface DocumentDAO

Parameters:

docId - identifier of the document

Returns:

list of the document's tags

Throws:

PersistenceException - error at data layer

findTags

public Map<String,Long> findTags(String firstLetter,
 Long tenantId)
                          throws PersistenceException

Description copied from interface: DocumentDAO

Selects all tags and counts the occurrences.

Specified by:

findTags in interface DocumentDAO

Parameters:

firstLetter - the first letter

tenantId - identifier of the tenant

Returns:

the map tag - count

Throws:

PersistenceException - error at data layer

findAllTags

public List<String> findAllTags(String firstLetter,
 Long tenantId)
                         throws PersistenceException

Description copied from interface: DocumentDAO

Searches for all tags,

Specified by:

findAllTags in interface DocumentDAO

Parameters:

firstLetter - Optional first letter hint

tenantId - ID of the tenant to search in

Returns:

The list of all tags in the system

Throws:

PersistenceException - error at data layer

findByUserIdAndTag

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

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

Throws:

PersistenceException - error at data layer

findDocIdByUserIdAndTag

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

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.

Throws:

PersistenceException - error at data layer

findLastDownloadsByUserId

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

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:

list of documents

Throws:

PersistenceException - error at data layer

findDocIdByFolder

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

Description copied from interface: DocumentDAO

Finds all document ids inside the given folder.

Specified by:

findDocIdByFolder in interface DocumentDAO

Parameters:

folderId - Folder identifier

max - Optional, maximum number of returned elements

Returns:

Collection of all document id in the folder.

Throws:

PersistenceException - error at data layer

findByFolder

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

Description copied from interface: DocumentDAO

Finds all documents direct children of the given folder.

Specified by:

findByFolder in interface DocumentDAO

Parameters:

folderId - Folder identifier

max - Optional, defines the maximum records number

Returns:

Collection of all documents in the folder

Throws:

PersistenceException - error at data layer

findArchivedByFolder

public List<Document> findArchivedByFolder(long folderId)
                                    throws PersistenceException

Description copied from interface: DocumentDAO

Finds archived documents in a folder (direct childeren only)

Specified by:

findArchivedByFolder in interface DocumentDAO

Parameters:

folderId - identifier of the folder

Returns:

list of documents

Throws:

PersistenceException - error at data layer

findLinkedDocuments

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

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

Throws:

PersistenceException - error at data layer

findByFileNameAndParentFolderId

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

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).

fileName - name of the file or a part of it (you can use SQL % jolly chars, eg: contract.pdf, %ontrac%)

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

tenantId - Optional id of the tenant

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

Throws:

PersistenceException - error at data layer

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()
                             throws PersistenceException

Description copied from interface: DocumentDAO

Gets the collection of deleted document ids

Specified by:

findDeletedDocIds in interface DocumentDAO

Returns:

collection of document identifiers

Throws:

PersistenceException - error at data layer

findDeletedDocs

public List<Document> findDeletedDocs()
                               throws PersistenceException

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

Returns:

the list of documents

Throws:

PersistenceException - error at data layer

computeTotalSize

public long computeTotalSize(Long tenantId,
 Long userId,
 boolean computeDeleted)
                      throws PersistenceException

Description copied from interface: DocumentDAO

Obtains the total size of the repository, that is the sum of sizes of all documents and their versions

Specified by:

computeTotalSize in interface DocumentDAO

Parameters:

tenantId - identifier of the tenant(optional)

userId - identifier of the publisher user (optional)

computeDeleted - If true, even deleted documents are considered

Returns:

the total size expressed in bytes

Throws:

PersistenceException - error at data layer

count

public long count(Long tenantId,
 boolean computeDeleted,
 boolean computeArchived)
           throws PersistenceException

Description copied from interface: DocumentDAO

Counts the number of documents

Specified by:

count in interface DocumentDAO

Parameters:

tenantId - The tenant to search in

computeDeleted - If true, even deleted documents are considered

computeArchived - If true, even archived documents are considered

Returns:

number of documents

Throws:

PersistenceException - error at data layer

findByIndexed

public List<Document> findByIndexed(int indexed)
                             throws PersistenceException

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

Throws:

PersistenceException - error at data layer

restore

public void restore(long docId,
 long folderId,
 DocumentHistory transaction)
             throws PersistenceException

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

Throws:

PersistenceException - error at data layer

findByCustomId

public Document findByCustomId(String customId,
 long tenantId)
                        throws PersistenceException

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.

tenantId - ID of the contained tenant.

Returns:

Document with given ID.

Throws:

PersistenceException - error at data layer

makeImmutable

public void makeImmutable(long docId,
 DocumentHistory transaction)
                   throws PersistenceException

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

Parameters:

docId - identifier of the document

transaction - entry to log the event

Throws:

PersistenceException - error at data layer

deleteAll

public void deleteAll(Collection<Document> documents,
 DocumentHistory transaction)
               throws PersistenceException

Description copied from interface: DocumentDAO

Shortcut for deleteAll(documents, 1, transaction)

Specified by:

deleteAll in interface DocumentDAO

Parameters:

documents - the documents

transaction - the current session

Throws:

PersistenceException - error at data layer

deleteAll

public void deleteAll(Collection<Document> documents,
 int delCode,
 DocumentHistory transaction)
               throws PersistenceException

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

delCode - The deletion code

transaction - entry to log the event

Throws:

PersistenceException - error at data layer

saveDocumentHistory

public void saveDocumentHistory(Document doc,
 DocumentHistory transaction)
                         throws PersistenceException

Description copied from interface: DocumentDAO

Saves a document's history

Specified by:

saveDocumentHistory in interface DocumentDAO

Parameters:

doc - the document

transaction - the current session

Throws:

PersistenceException - error at data layer

countByIndexed

public long countByIndexed(int indexed)
                    throws PersistenceException

Description copied from interface: DocumentDAO

Counts the number of documents in a given indexation status(@see AbstractDocument.getIndexed()

Specified by:

countByIndexed in interface DocumentDAO

Parameters:

indexed - the indexation status to check

Returns:

number of documents

Throws:

PersistenceException - error at data layer

findAliasIds

public List<Long> findAliasIds(long docId)
                        throws PersistenceException

Description copied from interface: DocumentDAO

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

Specified by:

findAliasIds in interface DocumentDAO

Parameters:

docId - identifier of the document

Returns:

list of identifiers of aliases

Throws:

PersistenceException - error at data layer

findDeleted

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

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 elements

Returns:

The documents list

Throws:

PersistenceException - error at data layer

findByIds

public List<Document> findByIds(Set<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

Parameters:

ids - identifiers of the documents

max - Optional, maximum number of returned elements

Returns:

list of documents

deleteOrphaned

public void deleteOrphaned(long deleteUserId)
                    throws PersistenceException

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

Throws:

PersistenceException - error at data layer

findPublishedIds

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

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

Throws:

PersistenceException - error at data layer

cleanExpiredTransactions

public void cleanExpiredTransactions()
                              throws PersistenceException

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

Throws:

PersistenceException - error at data layer

cleanUnexistingUniqueTags

public void cleanUnexistingUniqueTags()
                               throws PersistenceException

Description copied from interface: DocumentDAO

Cleans the ld_uniquetag table removing no more used tags, this method is optimized and uses a couple of prepared statements, in case of error it switches to DocumentDAO.cleanUnexistingUniqueTagsOneByOne()

Specified by:

cleanUnexistingUniqueTags in interface DocumentDAO

Throws:

PersistenceException - error at data layer

cleanUnexistingUniqueTagsOneByOne

public void cleanUnexistingUniqueTagsOneByOne()
                                       throws PersistenceException

Description copied from interface: DocumentDAO

Cleans the ld_uniquetag table removing no more used tags programmatically one by one. This method is not as optimized as DocumentDAO.cleanUnexistingUniqueTags() and should not be invoked directly

Specified by:

cleanUnexistingUniqueTagsOneByOne in interface DocumentDAO

Throws:

PersistenceException - error at data layer

insertNewUniqueTags

public void insertNewUniqueTags()
                         throws PersistenceException

Description copied from interface: DocumentDAO

Puts into ld_uniquetag the new unique tags

Specified by:

insertNewUniqueTags in interface DocumentDAO

Throws:

PersistenceException - error at data layer

updateCountUniqueTags

public void updateCountUniqueTags()
                           throws PersistenceException

Description copied from interface: DocumentDAO

Updates the count of the unique tags

Specified by:

updateCountUniqueTags in interface DocumentDAO

Throws:

PersistenceException - error at data layer

getTagCloud

public List<TagCloud> getTagCloud(long tenantId,
 int maxTags)
                           throws PersistenceException

Description copied from interface: DocumentDAO

Gets the tag cloud for the given tenant

Specified by:

getTagCloud in interface DocumentDAO

Parameters:

tenantId - identifier of the tenant

maxTags - maximum number of returned elements

Returns:

list of tag clouds

Throws:

PersistenceException - error at data layer

getTagCloud

public List<TagCloud> getTagCloud(String sid)
                           throws PersistenceException

Description copied from interface: DocumentDAO

Gets the tag cloud for the given tenant

Specified by:

getTagCloud in interface DocumentDAO

Parameters:

sid - identifier of the session

Returns:

list of tag clouds

Throws:

PersistenceException - error at data layer

findDocument

public Document findDocument(long docId)
                      throws PersistenceException

Description copied from interface: DocumentDAO

This method finds a document by the ID and if it is an alias the referenced document is returned instead.

Specified by:

findDocument in interface DocumentDAO

Parameters:

docId - ID of the document(or the alias)

Returns:

Document with given ID

Throws:

PersistenceException - an error happened in the database

getWorkspace

public Folder getWorkspace(long docId)
                    throws PersistenceException

Description copied from interface: DocumentDAO

Retrieves, the workspace where the document(or alias) is stored

Specified by:

getWorkspace in interface DocumentDAO

Parameters:

docId - identifier of a document

Returns:

the parent workspace

Throws:

PersistenceException - error at data layer

setPassword

public void setPassword(long docId,
 String password,
 DocumentHistory transaction)
                 throws PersistenceException

Description copied from interface: DocumentDAO

Protects the document with a password. The same password is replicated to all the versions

Specified by:

setPassword in interface DocumentDAO

Parameters:

docId - ID of the document

password - The new password in clear

transaction - history informations

Throws:

PersistenceException - error at data layer

unsetPassword

public void unsetPassword(long docId,
 DocumentHistory transaction)
                   throws PersistenceException

Description copied from interface: DocumentDAO

Removes the password protection from the document. The same action is replicated to all the versions

Specified by:

unsetPassword in interface DocumentDAO

Parameters:

docId - ID of the document

transaction - session informations

Throws:

PersistenceException - error at data layer

findByPath

public Document findByPath(String path,
 long tenantId)
                    throws PersistenceException

Description copied from interface: DocumentDAO

Finds a document by it's full path

Specified by:

findByPath in interface DocumentDAO

Parameters:

path - The path comprehensive of the file name

tenantId - The tenant

Returns:

the found document

Throws:

PersistenceException - error at data layer

findDuplicatedDigests

public List<String> findDuplicatedDigests(Long tenantId,
 Long folderId)
                                   throws PersistenceException

Description copied from interface: DocumentDAO

Retrieves the list of duplicated checksums

Specified by:

findDuplicatedDigests in interface DocumentDAO

Parameters:

tenantId - identifier of the tenant

folderId - identifier of the folder

Returns:

list of duplicated digests

Throws:

PersistenceException - error at data layer

isPrintAllowed

public boolean isPrintAllowed(long id,
 long userId)
                       throws PersistenceException

Specified by:

isPrintAllowed in interface DocumentDAO

Throws:

PersistenceException

isWriteAllowed

public boolean isWriteAllowed(long id,
 long userId)
                       throws PersistenceException

Description copied from interface: DocumentDAO

This method is looking up for writing rights for a document and an user.

Specified by:

isWriteAllowed in interface DocumentDAO

Parameters:

id - ID of the document

userId - ID of the user

Returns:

if the write permission is granted

Throws:

PersistenceException - error at data layer

isDownloadAllowed

public boolean isDownloadAllowed(long id,
 long userId)
                          throws PersistenceException

Specified by:

isDownloadAllowed in interface DocumentDAO

Throws:

PersistenceException

isMoveAllowed

public boolean isMoveAllowed(long id,
 long userId)
                      throws PersistenceException

Specified by:

isMoveAllowed in interface DocumentDAO

Throws:

PersistenceException

isReadAllowed

public boolean isReadAllowed(long docId,
 long userId)
                      throws PersistenceException

Specified by:

isReadAllowed in interface DocumentDAO

Throws:

PersistenceException

isPreviewAllowed

public boolean isPreviewAllowed(long docId,
 long userId)
                         throws PersistenceException

Specified by:

isPreviewAllowed in interface DocumentDAO

Throws:

PersistenceException

isPermissionAllowed

public boolean isPermissionAllowed(Permission permission,
 long documentId,
 long userId)
                            throws PersistenceException

Description copied from interface: DocumentDAO

This method checks if the given permission is enabled for a document and an user.

Specified by:

isPermissionAllowed in interface DocumentDAO

Parameters:

permission - the permission to check

documentId - ID of the folder

userId - ID of the user

Returns:

if the permission is granted to the user

Throws:

PersistenceException - error at data layer

getAllowedPermissions

public Set<Permission> getAllowedPermissions(long docId,
 long userId)
                                      throws PersistenceException

Description copied from interface: DocumentDAO

Finds all permissions of a user enabled on the specified document

Specified by:

getAllowedPermissions in interface DocumentDAO

Parameters:

docId - ID of the document

userId - ID of the user

Returns:

Collection of enabled permissions

Throws:

PersistenceException - error at data layer

applyParentFolderSecurity

public void applyParentFolderSecurity(long docId,
 DocumentHistory transaction)
                               throws PersistenceException

Description copied from interface: DocumentDAO

Replaces the document's security policies with those from the parent folder

Specified by:

applyParentFolderSecurity in interface DocumentDAO

Parameters:

docId - identifier of the document

transaction - the current transaction

Throws:

PersistenceException - error at data layer