com.logicaldoc.core.document

Class DocumentManagerImpl

java.lang.Object

com.logicaldoc.core.document.DocumentManagerImpl

All Implemented Interfaces:

DocumentManager

public class DocumentManagerImpl
extends Object
implements DocumentManager

Basic Implementation of DocumentManager

Since:

3.5

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
DocumentManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	changeIndexingStatus(Document doc, int status) Utility method used to declare that: a document must be taken into consideration by the indexer (status = AbstractDocument.INDEX_TO_INDEX).
void	checkin(long docId, File file, String filename, boolean release, Document docVO, History transaction) Checks in the given document
void	checkin(long docId, InputStream content, String filename, boolean release, Document docVO, History transaction) Checks in the given document
void	checkout(long docId, History transaction) Checks out the given document
Document	copyToFolder(Document doc, Folder folder, History transaction) Copy a document to the specified folder.
Document	create(File file, Document docVO, History transaction) Creates a new Document.
Document	create(InputStream content, Document docVO, History transaction) Creates a new Document.
Document	createShortcut(Document doc, Folder folder, History transaction) Create a shortcut associated to the given doc to the specified folder.
void	deleteFromIndex(Document doc) Utility method for document removal from index
Version	deleteVersion(long versionId, History transaction) Deletes a specific version.
void	lock(long docId, int status, History transaction) Locks the given document
void	makeImmutable(long docId, History transaction) Marks the document, with the given docId, as immutable and save the given document history
void	moveToFolder(Document doc, Folder folder, History transaction) Moves a document to the specified folder.
void	reindex(long docId) Reindexes an existing document in the full-text index.
void	rename(Document doc, String newName, boolean title, History transaction) Rename an existing document title/filename.
void	setConfig(ContextProperties config)
void	setDocumentDAO(DocumentDAO documentDAO)
void	setDocumentTemplateDAO(DocumentTemplateDAO documentTemplateDAO)
void	setFolderDAO(FolderDAO folderDAO)
void	setIndexer(SearchEngine indexer)
void	setListenerManager(DocumentListenerManager listenerManager)
void	setStorer(Storer storer)
void	setUserDAO(UserDAO userDAO)
void	setVersionDAO(VersionDAO versionDAO)
void	unlock(long docId, History transaction) UNChecks out the given document
void	update(Document doc, Document docVO, History transaction) Updates an existing document and marks it to be re-indexed

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

Constructor Detail

DocumentManagerImpl

public DocumentManagerImpl()

Method Detail

setListenerManager

public void setListenerManager(DocumentListenerManager listenerManager)

setDocumentDAO

public void setDocumentDAO(DocumentDAO documentDAO)

setDocumentTemplateDAO

public void setDocumentTemplateDAO(DocumentTemplateDAO documentTemplateDAO)

setIndexer

public void setIndexer(SearchEngine indexer)

checkin

public void checkin(long docId,
           File file,
           String filename,
           boolean release,
           Document docVO,
           History transaction)
             throws Exception

Description copied from interface: DocumentManager

Checks in the given document

Specified by:

checkin in interface DocumentManager

Parameters:

docId - the document to be checked in

file - of the new document version

filename - new filename (can also be the old one)

release - True if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)

docVO - The value object containing document's metadata applied during the checkin (optional)

transaction - entry to log the event, set the user and comment

Throws:

Exception - if an error occurs, this exception is thrown

checkin

public void checkin(long docId,
           InputStream content,
           String filename,
           boolean release,
           Document docVO,
           History transaction)
             throws Exception

Description copied from interface: DocumentManager

Checks in the given document

Specified by:

checkin in interface DocumentManager

Parameters:

docId - the document to be checked in

content - input stream pointing to the new document version

filename - new filename (can also be the old one)

release - True if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)

docVO - The value object containing document's metadata applied during the checkin (optional)

transaction - entry to log the event, set the user and comment

Throws:

Exception - if an error occurs, this exception is thrown

checkout

public void checkout(long docId,
            History transaction)
              throws Exception

Description copied from interface: DocumentManager

Checks out the given document

Specified by:

checkout in interface DocumentManager

Parameters:

docId - the document to be checked out

Throws:

Exception - if an error occurs, this exception is thrown

lock

public void lock(long docId,
        int status,
        History transaction)
          throws Exception

Description copied from interface: DocumentManager

Locks the given document

Specified by:

lock in interface DocumentManager

Parameters:

docId - the document to be locked

status - the lock type (used to populate status attribute of the document)

transaction - entry to log the event (set the user)

Throws:

Exception - if an error occurs, this exception is thrown

deleteFromIndex

public void deleteFromIndex(Document doc)

Utility method for document removal from index

Specified by:

deleteFromIndex in interface DocumentManager

Parameters:

doc -

reindex

public void reindex(long docId)
             throws Exception

Description copied from interface: DocumentManager

Reindexes an existing document in the full-text index.

Specified by:

reindex in interface DocumentManager

Parameters:

docId - The document to be indexed

Throws:

Exception - if an error occurs, this exception is thrown

update

public void update(Document doc,
          Document docVO,
          History transaction)
            throws Exception

Description copied from interface: DocumentManager

Updates an existing document and marks it to be re-indexed

Specified by:

update in interface DocumentManager

Parameters:

doc - The document to be updated

docVO - value object containing the new metadata

transaction - entry to log the event (set the user)

Throws:

Exception - if an error occurs, this exception is thrown

moveToFolder

public void moveToFolder(Document doc,
                Folder folder,
                History transaction)
                  throws Exception

Description copied from interface: DocumentManager

Moves a document to the specified folder. All stores(db, file system, index) will be consequently altered.

Specified by:

moveToFolder in interface DocumentManager

Parameters:

doc - The document to move

folder - The target folder

transaction - entry to log the event (set the user)

Throws:

Exception

create

public Document create(File file,
              Document docVO,
              History transaction)
                throws Exception

Description copied from interface: DocumentManager

Creates a new Document. Saves the information provided. That also includes updating the search index for example.

Specified by:

create in interface DocumentManager

Parameters:

file - The document's file

docVO - The value object containing the document's metadata

transaction - The trandaction metadata (remember to set the user and the comment)

Returns:

The newly created document

Throws:

Exception

create

public Document create(InputStream content,
              Document docVO,
              History transaction)
                throws Exception

Description copied from interface: DocumentManager

Creates a new Document. Saves the information provided. That also includes updating the search index for example.

Specified by:

create in interface DocumentManager

Parameters:

content - The document's content

docVO - The value object containing the document's metadata

transaction - The transaction metadata (remember to set the user and the comment)

Returns:

The newly created document

Throws:

Exception

copyToFolder

public Document copyToFolder(Document doc,
                    Folder folder,
                    History transaction)
                      throws Exception

Description copied from interface: DocumentManager

Copy a document to the specified folder.

Specified by:

copyToFolder in interface DocumentManager

Parameters:

doc - The document to move

folder - The target folder

transaction - entry to log the event (set the user)

Returns:

The created document

Throws:

Exception

unlock

public void unlock(long docId,
          History transaction)
            throws Exception

Description copied from interface: DocumentManager

UNChecks out the given document

Specified by:

unlock in interface DocumentManager

Parameters:

docId - the document to be unchecked out

transaction - entry to log the event

Throws:

Exception - if an error occurs, this exception is thrown

makeImmutable

public void makeImmutable(long docId,
                 History transaction)
                   throws Exception

Description copied from interface: DocumentManager

Marks the document, with the given docId, as immutable and save the given document history

Specified by:

makeImmutable in interface DocumentManager

transaction - entry to log the event (set the user)

Throws:

Exception

rename

public void rename(Document doc,
          String newName,
          boolean title,
          History transaction)
            throws Exception

Description copied from interface: DocumentManager

Rename an existing document title/filename.

Specified by:

rename in interface DocumentManager

Parameters:

doc - The document to be renamed

newName - The new title/filename of the document

title - True if the title must be renamed, False for the filename

transaction - entry to log the event (set the user)

Throws:

Exception - if an error occurs, this exception is thrown

createShortcut

public Document createShortcut(Document doc,
                      Folder folder,
                      History transaction)
                        throws Exception

Description copied from interface: DocumentManager

Create a shortcut associated to the given doc to the specified folder.

Specified by:

createShortcut in interface DocumentManager

Parameters:

doc - The document for which will be created the shortcut

folder - The target folder

transaction - entry to log the event (set the user)

Returns:

The created document

Throws:

Exception

setVersionDAO

public void setVersionDAO(VersionDAO versionDAO)

setStorer

public void setStorer(Storer storer)

Specified by:

setStorer in interface DocumentManager

setConfig

public void setConfig(ContextProperties config)

changeIndexingStatus

public void changeIndexingStatus(Document doc,
                        int status)

Description copied from interface: DocumentManager

Utility method used to declare that:

1. a document must be taken into consideration by the indexer (status = AbstractDocument.INDEX_TO_INDEX).
2. a document must not be taken into consideration by the indexer (status = AbstractDocument.INDEX_SKIP). If the document was previously indexed it is removed from the index.

Status:

1. AbstractDocument.INDEX_TO_INDEX
2. AbstractDocument.INDEX_SKIP

Specified by:

changeIndexingStatus in interface DocumentManager

Parameters:

doc - The document for which will be changed the indexer status.

status - The new document indexer status.

setUserDAO

public void setUserDAO(UserDAO userDAO)

setFolderDAO

public void setFolderDAO(FolderDAO folderDAO)

deleteVersion

public Version deleteVersion(long versionId,
                    History transaction)
                      throws Exception

Description copied from interface: DocumentManager

Deletes a specific version.

Specified by:

deleteVersion in interface DocumentManager

Parameters:

versionId - The version to delete

Returns:

the latest version

Throws:

Exception