com.logicaldoc.core.document.dao

Interface DocumentDAO

All Superinterfaces:

PersistentObjectDAO<Document>

All Known Implementing Classes:

HibernateDocumentDAO

public interface DocumentDAO
extends PersistentObjectDAO<Document>

This class is a DAO-service for documents.

Version:

1.0

Author:

Michael Scholz, Marco Meschieri

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 maxResults) 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) Initializes lazy loaded collections
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
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 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, store

Method Detail

findByCustomId

Document findByCustomId(String customId)

This method finds a document by the custom ID.

Parameters:

customId - custom ID of the document.

Returns:

Document with given ID.

findByUserId

List<Long> findByUserId(long userId)

Finds all documents for an user.

Parameters:

userId - ID of the user.

Returns:

Collection of all documentId required for the specified user.

findDocIdByFolder

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

Finds all document ids inside the given folder.

Parameters:

folderId - Folder identifier

Returns:

Collection of all document id in the folder.

findByFolder

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

Finds all documents inside the given folder.

Parameters:

folderId - Folder identifier

Returns:

Collection of all documents in the folder.

findLockedByUserId

@Deprecated
List<Document> findLockedByUserId(long userId)

Deprecated.

Finds all documents locked by a user.

Parameters:

userId - Id of the user.

Returns:

Collection of all Documents locked by the specified user.

findByLockUserAndStatus

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

Finds all document of 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

List<Document> findLastModifiedByUserId(long userId,
                                      int maxResults)

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

Parameters:

userId - ID of the user.

Returns:

Collection of the last documents changed by the specified user.

findLastDownloadsByUserId

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

Finds the last downloaded documents by the given user

Parameters:

userId - id of the user

maxResults - maximum number of returned elements

Returns:

findByIds

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

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

findDocIdByTag

List<Long> findDocIdByTag(String tag)

This method finds all Doc Ids by a tag.

Parameters:

tag - Tag of the document.

Returns:

Document with specified tag.

findTags

Map<String,Integer> findTags(String firstLetter)

This method selects all tags and counts the occurrences.

findAllTags

List<String> findAllTags(String firstLetter)

Searches for all tags,

Parameters:

firstLetter - Optional first letter hint

Returns:

The list of all tags in the system

findByUserIdAndTag

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

Finds authorized documents for a user having a specified tag.

Parameters:

userId - ID of the user

tag - Tag of the document

max - Optional, defines the maximum records number

Returns:

Collection of found documents

findDocIdByUserIdAndTag

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

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.

findLinkedDocuments

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

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

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)

Parameters:

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

fileName -

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

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)

Parameters:

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

title -

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

Returns:

initialize

void initialize(Document doc)

Initializes lazy loaded collections

Specified by:

initialize in interface PersistentObjectDAO<Document>

Parameters:

doc - The document to be initialized

getTotalSize

long getTotalSize(boolean computeDeleted)

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

Parameters:

computeDeleted - If true, even deleted documents are considered

Returns:

findDeletedDocIds

List<Long> findDeletedDocIds()

Gets the collection of deleted document ids

findDeletedDocs

List<Document> findDeletedDocs()

Finds the list of deleted documents.

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

count

long count(boolean computeDeleted)

Counts the number of documents

Parameters:

computeDeleted - If true, even deleted documents are considered

findByIndexed

List<Document> findByIndexed(int indexed)

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

Parameters:

indexed - the indexed property

Returns:

Collection of all documents

countByIndexed

long countByIndexed(int indexed)

Counts the number of documents indexed or not

restore

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

Restores a previously deleted document

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

makeImmutable

void makeImmutable(long docId,
                 History transaction)

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

Parameters:

docId -

transaction - entry to log the event

deleteAll

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

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

Parameters:

documents - The documents to be deleted

transaction - entry to log the event

store

boolean store(Document doc,
            History transaction)

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

Parameters:

doc -

transaction - entry to log the event

Returns:

True if successfully stored in a database.

delete

boolean delete(long docId,
             History transaction)

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

Parameters:

docId - The id of the document to delete

transaction - entry to log the event

Returns:

True if successfully deleted from the database.

findShortcutIds

List<Long> findShortcutIds(long docId)

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

Parameters:

docId - The document Id

findDeleted

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

Finds all deleted docs of a specific user.

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

deleteOrphaned

boolean deleteOrphaned(long deleteUserId)

This method deletes the documents into deleted folders.

Parameters:

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

Returns:

True if successfully deleted from the database.

findPublishedIds

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

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

updateDigest

void updateDigest(Document doc)

Updates the document's digest (SHA-1)

Parameters:

doc - The document to be processed

cleanExpiredTransactions

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