Package com.logicaldoc.core.document
Interface DocumentDAO
- All Superinterfaces:
PersistentObjectDAO<Document>
- All Known Implementing Classes:
HibernateDocumentDAO
This class is a DAO-service for documents.
- Version:
- 1.0
- Author:
- Michael Scholz, Marco Meschieri
-
Field Summary
Fields inherited from interface com.logicaldoc.core.PersistentObjectDAO
ENTITY
-
Method Summary
Modifier and TypeMethodDescriptionvoid
applyParentFolderSecurity
(long docId, DocumentHistory transaction) Replaces the document's security policies with those from the parent foldervoid
archive
(long docId, DocumentHistory transaction) Archives a documentvoid
Cleans all references to expired transactions.void
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 tocleanUnexistingUniqueTagsOneByOne()
void
Cleans the ld_uniquetag table removing no more used tags programmatically one by one.long
computeTotalSize
(Long tenantId, Long publisherId, boolean computeDeleted) Obtains the total size of the repository, that is the sum of sizes of all documents and their versionslong
Counts the number of documentslong
countByIndexed
(int indexed) Counts the number of documents in a given indexation status(@seeAbstractDocument.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 documentsvoid
deleteAll
(Collection<Document> documents, DocumentHistory transaction) Shortcut for deleteAll(documents, 1, transaction)void
deleteOrphaned
(long deleteUserId) This method deletes the documents into deleted folders.findAliasIds
(long docId) Gets the ids of all aliases associated to the document with the given docIdfindAllTags
(String firstLetter, Long tenantId) Searches for all tags,findArchivedByFolder
(long folderId) Finds archived documents in a folder (direct childeren only)findByCustomId
(String customId, long tenantId) This method finds a document by the custom ID.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)findByFolder
(long folderId, Integer max) Finds all documents direct children of the given folder.Finds all documents whose id is included in the given pool of idsfindByIndexed
(int indexed) Finds all documents by the indexed state.findByLockUserAndStatus
(Long userId, Integer status) Finds all document of0 the specified status and locked by the specified userfindByPath
(String path, long tenantId) Finds a document by it's full pathfindByUserId
(long userId) Finds all documents for an user.findByUserIdAndTag
(long userId, String tag, Integer max) Finds authorized documents for a user having a specified tag.findDeleted
(long userId, Integer max) Finds all deleted docs of a specific user.Gets the collection of deleted document idsFinds the list of deleted documents.findDocIdByFolder
(long folderId, Integer max) Finds all document ids inside the given folder.findDocIdByTag
(String tag) This method finds all Doc Ids by a tag.findDocIdByUserIdAndTag
(long userId, String tag) Finds authorized documents ids for a user having a specified tag.findDocument
(long docId) This method finds a document by the ID and if it is an alias the referenced document is returned instead.findDuplicatedDigests
(Long tenantId, Long folderId) Retrieves the list of duplicated checksumsfindLastDownloadsByUserId
(long userId, int max) Finds the last downloaded documents by the given userfindLastModifiedByUserId
(long userId, int max) Finds a max number of documents last modified by an user.findLinkedDocuments
(long docId, String linkType, Integer direction) This method enlists documents linked to the given document.findPublishedIds
(Collection<Long> folderIds) Finds all document ids inside the specified folders that are published in the current date.findTags
(long docId) Retrieves the alphabetically ordered list of all the document's tagsSelects all tags and counts the occurrences.getAllowedPermissions
(long documentId, long userId) Finds all permissions of a user enabled on the specified documentgetTagCloud
(long tenantId, int max) Gets the tag cloud for the given tenantgetTagCloud
(String sid) Gets the tag cloud for the given tenantgetWorkspace
(long docId) Retrieves, the workspace where the document(or alias) is storedvoid
initialize
(Document doc) Initializes lazy loaded collectionsvoid
Puts into ld_uniquetag the new unique tagsboolean
isDownloadAllowed
(long documentId, long userId) boolean
isMoveAllowed
(long documentId, 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 documentId, long userId) boolean
isPrintAllowed
(long documentId, long userId) boolean
isReadAllowed
(long documentId, long userId) boolean
isWriteAllowed
(long documentId, 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 documentvoid
saveDocumentHistory
(Document doc, DocumentHistory transaction) Saves a document's historyvoid
setPassword
(long docId, String password, DocumentHistory transaction) Protects the document with a password.void
store
(Document doc, DocumentHistory transaction) This method persists the document object and insert a new document history entryvoid
unarchive
(long docId, DocumentHistory transaction) Restores a previously archived documentvoid
unsetPassword
(long docId, DocumentHistory transaction) Removes the password protection from the document.void
Updates the count of the unique tagsvoid
updateDigest
(Document doc) Updates the document's digest (SHA-1)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, store
-
Method Details
-
findDocument
This method finds a document by the ID and if it is an alias the referenced document is returned instead.- Parameters:
docId
- ID of the document(or the alias)- Returns:
- Document with given ID
- Throws:
PersistenceException
- an error happened in the database
-
findByCustomId
This method finds a document by the custom ID.- Parameters:
customId
- custom ID of the document.tenantId
- ID of the contained tenant.- Returns:
- Document with given ID.
- Throws:
PersistenceException
- error at data layer
-
findByUserId
Finds all documents for an user.- Parameters:
userId
- ID of the user.- Returns:
- Collection of all documentId required for the specified user.
- Throws:
PersistenceException
- error at data layer
-
findDocIdByFolder
Finds all document ids inside the given folder.- Parameters:
folderId
- Folder identifiermax
- Optional, maximum number of returned elements- Returns:
- Collection of all document id in the folder.
- Throws:
PersistenceException
- error at data layer
-
findByFolder
Finds all documents direct children of the given folder.- Parameters:
folderId
- Folder identifiermax
- Optional, defines the maximum records number- Returns:
- Collection of all documents in the folder
- Throws:
PersistenceException
- error at data layer
-
findByLockUserAndStatus
Finds all document of0 the specified status and locked by the specified user- 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.
-
findLastModifiedByUserId
Finds a max number of documents last modified by an user.- Parameters:
userId
- ID of the user.max
- maximum number of returned elements- Returns:
- Collection of the last documents changed by the specified user.
- Throws:
PersistenceException
- error at data layer
-
findLastDownloadsByUserId
Finds the last downloaded documents by the given user- Parameters:
userId
- id of the usermax
- maximum number of returned elements- Returns:
- list of documents
- Throws:
PersistenceException
- error at data layer
-
findByIds
Finds all documents whose id is included in the given pool of ids- Parameters:
ids
- identifiers of the documentsmax
- Optional, maximum number of returned elements- Returns:
- list of documents
-
findDocIdByTag
This method finds all Doc Ids by a tag.- Parameters:
tag
- Tag of the document.- Returns:
- Document with specified tag.
- Throws:
PersistenceException
- error at data layer
-
findTags
Selects all tags and counts the occurrences.- Parameters:
firstLetter
- the first lettertenantId
- identifier of the tenant- Returns:
- the map tag - count
- Throws:
PersistenceException
- error at data layer
-
findAllTags
Searches for all tags,- Parameters:
firstLetter
- Optional first letter hinttenantId
- ID of the tenant to search in- Returns:
- The list of all tags in the system
- Throws:
PersistenceException
- error at data layer
-
findByUserIdAndTag
Finds authorized documents for a user having a specified tag.- Parameters:
userId
- ID of the usertag
- Tag of the documentmax
- Optional, defines the maximum records number- Returns:
- Collection of found documents
- Throws:
PersistenceException
- error at data layer
-
findDocIdByUserIdAndTag
Finds authorized documents ids for a user having a specified tag.- Parameters:
userId
- ID of the user.tag
- Tag of the document- Returns:
- Set of found ids.
- Throws:
PersistenceException
- error at data layer
-
findLinkedDocuments
List<Document> findLinkedDocuments(long docId, String linkType, Integer direction) throws PersistenceException 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
- Parameters:
docId
- All documents linked to this one will be searchedlinkType
- 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
List<Document> findByFileNameAndParentFolderId(Long folderId, String fileName, Long excludeId, Long tenantId, Integer max) throws PersistenceException Finds that document that lies under a specific folder (given by the id) an with a given fileName(like operator is used)- 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 consideredtenantId
- Optional id of the tenantmax
- 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
-
findByPath
Finds a document by it's full path- Parameters:
path
- The path comprehensive of the file nametenantId
- The tenant- Returns:
- the found document
- Throws:
PersistenceException
- error at data layer
-
initialize
Initializes lazy loaded collections- Specified by:
initialize
in interfacePersistentObjectDAO<Document>
- Parameters:
doc
- The document to be initialized
-
computeTotalSize
long computeTotalSize(Long tenantId, Long publisherId, boolean computeDeleted) throws PersistenceException Obtains the total size of the repository, that is the sum of sizes of all documents and their versions- Parameters:
tenantId
- identifier of the tenant(optional)publisherId
- 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
-
findDeletedDocIds
Gets the collection of deleted document ids- Returns:
- collection of document identifiers
- Throws:
PersistenceException
- error at data layer
-
findDeletedDocs
Finds the list of deleted documents.Attention: The returned objects are not fully operative and are populated with a minimal set of data.
- Returns:
- the list of documents
- Throws:
PersistenceException
- error at data layer
-
count
long count(Long tenantId, boolean computeDeleted, boolean computeArchived) throws PersistenceException Counts the number of documents- Parameters:
tenantId
- The tenant to search incomputeDeleted
- If true, even deleted documents are consideredcomputeArchived
- If true, even archived documents are considered- Returns:
- number of documents
- Throws:
PersistenceException
- error at data layer
-
findByIndexed
Finds all documents by the indexed state. Order by ascending lastModifed- Parameters:
indexed
- the indexed property- Returns:
- Collection of all documents
- Throws:
PersistenceException
- error at data layer
-
countByIndexed
Counts the number of documents in a given indexation status(@seeAbstractDocument.getIndexed()
- Parameters:
indexed
- the indexation status to check- Returns:
- number of documents
- Throws:
PersistenceException
- error at data layer
-
restore
Restores a previously deleted document- Parameters:
docId
- Id of the document to be restoredfolderId
- Id of the folder the document will be restored intotransaction
- entry to log the event- Throws:
PersistenceException
- error at data layer
-
unarchive
Restores a previously archived document- Parameters:
docId
- Ids of the document to be restoredtransaction
- entry to log the event- Throws:
PersistenceException
- error at data layer
-
makeImmutable
Marks the document, with the given docId, as immutable. Unlocks the document if it was locked.- Parameters:
docId
- identifier of the documenttransaction
- entry to log the event- Throws:
PersistenceException
- error at data layer
-
deleteAll
void deleteAll(Collection<Document> documents, DocumentHistory transaction) throws PersistenceException Shortcut for deleteAll(documents, 1, transaction)- Parameters:
documents
- the documentstransaction
- the current session- Throws:
PersistenceException
- error at data layer
-
deleteAll
void deleteAll(Collection<Document> documents, int delCode, DocumentHistory transaction) throws PersistenceException Deletes all documents form the database and modifies the custom ids of all documents- Parameters:
documents
- The documents to be deleteddelCode
- The deletion codetransaction
- entry to log the event- Throws:
PersistenceException
- error at data layer
-
store
This method persists the document object and insert a new document history entry- Parameters:
doc
- the documenttransaction
- entry to log the event- Throws:
PersistenceException
- error at data layer
-
delete
This method deletes the document object and insert a new document history entry.- Parameters:
docId
- The id of the document to deletedelCode
- The deletion codetransaction
- entry to log the event- Throws:
PersistenceException
- error at data layer
-
delete
Shortcut for delete(docId, 1, transaction)- Parameters:
docId
- identifier of the documenttransaction
- entry to log the event- Throws:
PersistenceException
- error at data layer
-
archive
Archives a document- Parameters:
docId
- identifier of the documenttransaction
- entry to log the event- Throws:
PersistenceException
- error at data layer
-
findArchivedByFolder
Finds archived documents in a folder (direct childeren only)- Parameters:
folderId
- identifier of the folder- Returns:
- list of documents
- Throws:
PersistenceException
- error at data layer
-
findAliasIds
Gets the ids of all aliases associated to the document with the given docId- Parameters:
docId
- identifier of the document- Returns:
- list of identifiers of aliases
- Throws:
PersistenceException
- error at data layer
-
findDeleted
Finds all deleted docs of a specific user.- Parameters:
userId
- The user that performed the deletionmax
- Optional, defines the max number of returned elements- Returns:
- The documents list
- Throws:
PersistenceException
- error at data layer
-
deleteOrphaned
This method deletes the documents into deleted folders.- Parameters:
deleteUserId
- The id of the user that performs the deleting- Throws:
PersistenceException
- error at data layer
-
findPublishedIds
Finds all document ids inside the specified folders that are published in the current date.- Parameters:
folderIds
- Set of folder ids in which the method will search- Returns:
- List of published document ids
- Throws:
PersistenceException
- error at data layer
-
updateDigest
Updates the document's digest (SHA-1)- Parameters:
doc
- The document to be processed- Throws:
PersistenceException
- error at data layer
-
cleanExpiredTransactions
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.- Throws:
PersistenceException
- error at data layer
-
saveDocumentHistory
Saves a document's history- Parameters:
doc
- the documenttransaction
- the current session- Throws:
PersistenceException
- error at data layer
-
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 tocleanUnexistingUniqueTagsOneByOne()
- Throws:
PersistenceException
- error at data layer
-
cleanUnexistingUniqueTagsOneByOne
Cleans the ld_uniquetag table removing no more used tags programmatically one by one. This method is not as optimized ascleanUnexistingUniqueTags()
and should not be invoked directly- Throws:
PersistenceException
- error at data layer
-
insertNewUniqueTags
Puts into ld_uniquetag the new unique tags- Throws:
PersistenceException
- error at data layer
-
updateCountUniqueTags
Updates the count of the unique tags- Throws:
PersistenceException
- error at data layer
-
getTagCloud
Gets the tag cloud for the given tenant- Parameters:
tenantId
- identifier of the tenantmax
- maximum number of returned elements- Returns:
- list of tag clouds
- Throws:
PersistenceException
- error at data layer
-
getTagCloud
Gets the tag cloud for the given tenant- Parameters:
sid
- identifier of the session- Returns:
- list of tag clouds
- Throws:
PersistenceException
- error at data layer
-
getWorkspace
Retrieves, the workspace where the document(or alias) is stored- Parameters:
docId
- identifier of a document- Returns:
- the parent workspace
- Throws:
PersistenceException
- error at data layer
-
setPassword
void setPassword(long docId, String password, DocumentHistory transaction) throws PersistenceException Protects the document with a password. The same password is replicated to all the versions- Parameters:
docId
- ID of the documentpassword
- The new password in cleartransaction
- history informations- Throws:
PersistenceException
- error at data layer
-
unsetPassword
Removes the password protection from the document. The same action is replicated to all the versions- Parameters:
docId
- ID of the documenttransaction
- session informations- Throws:
PersistenceException
- error at data layer
-
findDuplicatedDigests
Retrieves the list of duplicated checksums- Parameters:
tenantId
- identifier of the tenantfolderId
- identifier of the folder- Returns:
- list of duplicated digests
- Throws:
PersistenceException
- error at data layer
-
findTags
Retrieves the alphabetically ordered list of all the document's tags- Parameters:
docId
- identifier of the document- Returns:
- list of the document's tags
- Throws:
PersistenceException
- error at data layer
-
applyParentFolderSecurity
Replaces the document's security policies with those from the parent folder- Parameters:
docId
- identifier of the documenttransaction
- the current transaction- Throws:
PersistenceException
- error at data layer
-
isWriteAllowed
This method is looking up for writing rights for a document and an user.- Parameters:
documentId
- ID of the documentuserId
- ID of the user- Returns:
- if the write permission is granted
- Throws:
PersistenceException
- error at data layer
-
isReadAllowed
- Throws:
PersistenceException
-
isPreviewAllowed
- Throws:
PersistenceException
-
isPrintAllowed
- Throws:
PersistenceException
-
isDownloadAllowed
- Throws:
PersistenceException
-
isMoveAllowed
- Throws:
PersistenceException
-
isPermissionAllowed
boolean isPermissionAllowed(Permission permission, long documentId, long userId) throws PersistenceException This method checks if the given permission is enabled for a document and an user.- Parameters:
permission
- the permission to checkdocumentId
- ID of the folderuserId
- ID of the user- Returns:
- if the permission is granted to the user
- Throws:
PersistenceException
- error at data layer
-
getAllowedPermissions
Finds all permissions of a user enabled on the specified document- Parameters:
documentId
- ID of the documentuserId
- ID of the user- Returns:
- Collection of enabled permissions
- Throws:
PersistenceException
- error at data layer
-