Uses of Class
com.logicaldoc.core.document.Document
Package
Description
Core plug-in that contains the most important domain objects
Automation subsystem that allows you to program your own logic inside the
platform.
The automation engine can be accessed through the class
Please note the special annotation
The automation engine can be accessed through the class
Automation
Please note the special annotation
AutomationDictionary
that is used to
automatically put in the Dictionary whatever bean you need.Machinery for converting documents to different formats.
Machinery for building thumbnails of the first page of the documents.
Machinery for parsing different file formats.
The core of the search engine.
The store sub-system responsible for persisting the binaries of the
documents.
GWT services implementations.
-
Uses of Document in com.logicaldoc.core
-
Uses of Document in com.logicaldoc.core.automation
Modifier and TypeMethodDescriptionInstantiate a new document that is a clone of the given one.Convert a document in another format and saves the result in another file in the same folderDocTool.copy
(Document doc, String targetPath, boolean links, boolean notes, boolean security, String username) Copies a document into a target folderCopies a document into a target folderDocTool.copyResource
(Document doc, String fileVersion, String suffix, String newFileName, String username) Copies a resource in a file in the same folder of the original documentCreated a new document into the databaseDocTool.createAlias
(Document originalDoc, Folder targetFolder, String type, String username) Creates an alias to a documentDocTool.createAlias
(Document originalDoc, String targetPath, String type, String username) Creates an alias to a documentDocTool.findById
(long docId) Retrieves a document by it's identifierDocTool.findByPath
(String path) Retrieves a document by it's pathDocTool.findByPath
(String path, Long tenantId) Retrieves a document by it's pathDocTool.merge
(Collection<Document> documents, long targetFolderId, String fileName, String username) Merges a set of documents into a single PDF fileModifier and TypeMethodDescriptionMailTool.extractAttachments
(Document doc, String filterFileName, String username) Extracts attachments of email files (.eml, .msg) in the current folderModifier and TypeMethodDescriptionvoid
Creates a new note for the whole documentInstantiate a new document that is a clone of the given one.Convert a document in another format and saves the result in another file in the same foldervoid
DocTool.convertPDF
(Document doc) Converts a document in PDF format and saves it as ancillary resource of the document with suffixFormatConverterManager.PDF_CONVERSION_SUFFIX
.DocTool.copy
(Document doc, String targetPath, boolean links, boolean notes, boolean security, String username) Copies a document into a target folderCopies a document into a target folderDocTool.copyResource
(Document doc, String fileVersion, String suffix, String newFileName, String username) Copies a resource in a file in the same folder of the original documentint
DocTool.countPages
(Document document) Counts the number of pages of a documentCreated a new document into the databaseDocTool.createAlias
(Document originalDoc, Folder targetFolder, String type, String username) Creates an alias to a documentDocTool.createAlias
(Document originalDoc, String targetPath, String type, String username) Creates an alias to a documentDocTool.createPath
(Document doc, String targetPath, String username) Creates a path, all existing nodes in the specified path will be reusedDocTool.displayUrl
(Document doc) Builds the display url of a document(display permalink)MailTool.documentToEMail
(Document document, boolean extractAttachments) Creates anEMail
object given the document that stores an email message.DocTool.downloadUrl
(Document doc) Builds the download url of a document(download permalink)MailTool.extractAttachments
(Document doc, String filterFileName, String username) Extracts attachments of email files (.eml, .msg) in the current folderCalculates the full path of a documentvoid
DocTool.initialize
(Document doc) Initializes lazy loaded collectionsLinks two documentsvoid
Moves a document into a target folderExtracts the texts from a document, using the same analyzer used for the full-text processing.void
Sends a document by email to a recipientvoid
MailTool.sendDocument
(Document document, String from, Collection<String> to, String subject, String message) Sends a document by email to a selection of recipientsvoid
Saves / updates a document into the databasevoid
DocTool.store
(Document doc, DocumentHistory transaction) Saves / updates a document into the databasevoid
Saves / updates a document into the databaseModifier and TypeMethodDescriptionDocTool.getIds
(Collection<Document> docs) Converts a collection of documents in a collection of identifiersDocTool.merge
(Collection<Document> documents, long targetFolderId, String fileName, String username) Merges a set of documents into a single PDF filevoid
MailTool.sendDocuments
(Collection<Document> documents, String from, String to, String subject, String message) Sends some documents to a recipientvoid
MailTool.sendDocuments
(Collection<Document> documents, String from, Collection<String> to, String subject, String message) Sends some documents to a selection of recipients -
Uses of Document in com.logicaldoc.core.conversion
Modifier and TypeMethodDescriptionFormatConverterManager.convert
(Document document, String fileVersion, String format, DocumentHistory transaction) Converts a document into another format and saves the resulting file in the same folderModifier and TypeMethodDescriptionfinal void
If the converter is enabled it invokes theAbstractFormatConverter.internalConvert(String, Document, File, File)
void
Performs the conversionFormatConverterManager.convert
(Document document, String fileVersion, String format, DocumentHistory transaction) Converts a document into another format and saves the resulting file in the same foldervoid
void
FormatConverterManager.convertToFile
(Document document, String fileVersion, File out, DocumentHistory transaction) Converts a document and writes the content of the conversion into a file.void
FormatConverterManager.convertToPdf
(Document document, String sid) Shortcut for convertToPdf(document, null, transaction)void
FormatConverterManager.convertToPdf
(Document document, String fileVersion, String sid) Creates the pdf for the specified document and file version (suffix PDF_CONVERSION_SUFFIX).byte[]
FormatConverterManager.getPdfContent
(Document document, String fileVersion, String sid) Retrieves the content of the Pdf conversion.void
GhostscriptConverter.internalConvert
(String sid, Document document, File src, File dest) void
ImageConverter.internalConvert
(String sid, Document document, File src, File dest) void
P7MConverter.internalConvert
(String sid, Document document, File src, File dest) void
PstConverter.internalConvert
(String sid, Document document, File src, File dest) void
RarConverter.internalConvert
(String sid, Document document, File src, File dest) void
SevenZipConverter.internalConvert
(String sid, Document document, File src, File dest) void
TarConverter.internalConvert
(String sid, Document document, File src, File dest) void
XMLConverter.internalConvert
(String sid, Document document, File src, File dest) void
ZipConverter.internalConvert
(String sid, Document document, File src, File dest) void
FormatConverterManager.writePdfToFile
(Document document, String fileVersion, File out, String sid) Write the content of the Pdf conversion into a file. -
Uses of Document in com.logicaldoc.core.document
Modifier and TypeMethodDescriptionDocumentManager.copyToFolder
(Document doc, Folder folder, DocumentHistory transaction, boolean links, boolean notes, boolean security) Copy a document to the specified folder.DocumentManagerImpl.copyToFolder
(Document doc, Folder folder, DocumentHistory transaction, boolean links, boolean notes, boolean security) DocumentManager.create
(File file, Document docVO, DocumentHistory transaction) Creates a new Document.DocumentManager.create
(InputStream content, Document docVO, DocumentHistory transaction) Creates a new Document.DocumentManagerImpl.create
(File file, Document docVO, DocumentHistory transaction) DocumentManagerImpl.create
(InputStream content, Document docVO, DocumentHistory transaction) DocumentManager.createAlias
(Document doc, Folder folder, String type, DocumentHistory transaction) Create an alias(shortcut) associated to the given doc to the specified folder.DocumentManagerImpl.createAlias
(Document doc, Folder folder, String aliasType, DocumentHistory transaction) DocumentDAO.findByCustomId
(String customId, long tenantId) This method finds a document by the custom ID.HibernateDocumentDAO.findByCustomId
(String customId, long tenantId) DocumentDAO.findByPath
(String path, long tenantId) Finds a document by it's full pathHibernateDocumentDAO.findByPath
(String path, long tenantId) DocumentDAO.findDocument
(long docId) This method finds a document by the ID and if it is an alias the referenced document is returned instead.HibernateDocumentDAO.findDocument
(long docId) DocumentLink.getDocument1()
DocumentLink.getDocument2()
DocumentManager.merge
(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction) Merges a set of documents into a single PDF fileDocumentManagerImpl.merge
(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction) DocumentManager.replaceAlias
(long aliasId, DocumentHistory transaction) Replaces an alias with a copy of the original fileDocumentManagerImpl.replaceAlias
(long aliasId, DocumentHistory transaction) Modifier and TypeMethodDescriptionDocumentDAO.findArchivedByFolder
(long folderId) Finds archived documents in a folder (direct childeren only)HibernateDocumentDAO.findArchivedByFolder
(long folderId) DocumentDAO.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)HibernateDocumentDAO.findByFileNameAndParentFolderId
(Long folderId, String fileName, Long excludeId, Long tenantId, Integer max) DocumentDAO.findByFolder
(long folderId, Integer max) Finds all documents direct children of the given folder.HibernateDocumentDAO.findByFolder
(long folderId, Integer max) Finds all documents whose id is included in the given pool of idsDocumentDAO.findByIndexed
(int indexed) Finds all documents by the indexed state.HibernateDocumentDAO.findByIndexed
(int indexed) DocumentDAO.findByLockUserAndStatus
(Long userId, Integer status) Finds all document of0 the specified status and locked by the specified userHibernateDocumentDAO.findByLockUserAndStatus
(Long userId, Integer status) DocumentDAO.findByUserIdAndTag
(long userId, String tag, Integer max) Finds authorized documents for a user having a specified tag.HibernateDocumentDAO.findByUserIdAndTag
(long userId, String tag, Integer max) DocumentDAO.findDeleted
(long userId, Integer max) Finds all deleted docs of a specific user.HibernateDocumentDAO.findDeleted
(long userId, Integer maxHits) DocumentDAO.findDeletedDocs()
Finds the list of deleted documents.HibernateDocumentDAO.findDeletedDocs()
DocumentDAO.findLastDownloadsByUserId
(long userId, int max) Finds the last downloaded documents by the given userHibernateDocumentDAO.findLastDownloadsByUserId
(long userId, int maxResults) DocumentDAO.findLastModifiedByUserId
(long userId, int max) Finds a max number of documents last modified by an user.HibernateDocumentDAO.findLastModifiedByUserId
(long userId, int maxElements) DocumentDAO.findLinkedDocuments
(long docId, String linkType, Integer direction) This method enlists documents linked to the given document.HibernateDocumentDAO.findLinkedDocuments
(long docId, String linkType, Integer direction) Modifier and TypeMethodDescriptionvoid
DocumentInitializer.afterCheckin
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) void
DocumentListener.afterCheckin
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) Called after a document is checked invoid
DocumentValidator.afterCheckin
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) void
DocumentInitializer.afterSaveHistory
(Document document, DocumentHistory event, Map<String, Object> dictionary) void
DocumentListener.afterSaveHistory
(Document document, DocumentHistory event, Map<String, Object> dictionary) Called after an event has been storedvoid
DocumentValidator.afterSaveHistory
(Document document, DocumentHistory event, Map<String, Object> dictionary) void
DocumentInitializer.afterStore
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) void
DocumentListener.afterStore
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) Called after a document is stored in the databasevoid
DocumentValidator.afterStore
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) void
DocumentInitializer.beforeCheckin
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) void
DocumentListener.beforeCheckin
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) Called before a document is checked invoid
DocumentValidator.beforeCheckin
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) void
DocumentInitializer.beforeStore
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) void
DocumentListener.beforeStore
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) Called before a document is stored in the databasevoid
DocumentValidator.beforeStore
(Document document, DocumentHistory transaction, Map<String, Object> dictionary) void
DocumentManager.changeIndexingStatus
(Document doc, int status) Utility method used to declare that: the document must be taken into consideration by the indexer (status =AbstractDocument.INDEX_TO_INDEX
. the document must be taken into consideration by the indexer for the metadata only(status =AbstractDocument.INDEX_TO_INDEX_METADATA
. the document must not be taken into consideration by the indexer (status =AbstractDocument.INDEX_SKIP
).void
DocumentManagerImpl.changeIndexingStatus
(Document doc, int status) DocumentManager.copyToFolder
(Document doc, Folder folder, DocumentHistory transaction, boolean links, boolean notes, boolean security) Copy a document to the specified folder.DocumentManagerImpl.copyToFolder
(Document doc, Folder folder, DocumentHistory transaction, boolean links, boolean notes, boolean security) int
DocumentManager.countPages
(Document doc) Counts the number of pages of a documentint
DocumentManagerImpl.countPages
(Document doc) DocumentManager.create
(File file, Document docVO, DocumentHistory transaction) Creates a new Document.DocumentManager.create
(InputStream content, Document docVO, DocumentHistory transaction) Creates a new Document.DocumentManagerImpl.create
(File file, Document docVO, DocumentHistory transaction) DocumentManagerImpl.create
(InputStream content, Document docVO, DocumentHistory transaction) static Version
Factory method that creates a Version and replicate all given document's properties.
The new version and fileVersion will be set in both Document and Version
Important: The created Version is not persistentDocumentManager.createAlias
(Document doc, Folder folder, String type, DocumentHistory transaction) Create an alias(shortcut) associated to the given doc to the specified folder.DocumentManagerImpl.createAlias
(Document doc, Folder folder, String aliasType, DocumentHistory transaction) void
DocumentManager.deleteFromIndex
(Document doc) Utility method for document removal from index and database update(flag indexed)void
DocumentManagerImpl.deleteFromIndex
(Document doc) Utility method for document removal from indexvoid
DocumentDAO.initialize
(Document doc) Initializes lazy loaded collectionsvoid
HibernateDocumentDAO.initialize
(Document doc) void
DocumentManager.moveToFolder
(Document doc, Folder folder, DocumentHistory transaction) Moves a document to the specified folder.void
DocumentManagerImpl.moveToFolder
(Document doc, Folder folder, DocumentHistory transaction) DocumentManager.parseDocument
(Document doc, String fileVersion) Retrieves the document's content as a stringDocumentManagerImpl.parseDocument
(Document doc, String fileVersion) void
DocumentDAO.saveDocumentHistory
(Document doc, DocumentHistory transaction) Saves a document's historyvoid
HibernateDocumentDAO.saveDocumentHistory
(Document doc, DocumentHistory transaction) void
DocumentLink.setDocument1
(Document document1) void
DocumentLink.setDocument2
(Document document2) void
DocumentDAO.store
(Document doc, DocumentHistory transaction) This method persists the document object and insert a new document history entryvoid
void
HibernateDocumentDAO.store
(Document doc, DocumentHistory transaction) void
DocumentManager.update
(Document doc, Document docVO, DocumentHistory transaction) Updates an existing document and marks it to be re-indexedvoid
DocumentManagerImpl.update
(Document document, Document docVO, DocumentHistory transaction) void
DocumentDAO.updateDigest
(Document doc) Updates the document's digest (SHA-1)void
HibernateDocumentDAO.updateDigest
(Document doc) Modifier and TypeMethodDescriptionvoid
DocumentDAO.deleteAll
(Collection<Document> documents, int delCode, DocumentHistory transaction) Deletes all documents form the database and modifies the custom ids of all documentsvoid
DocumentDAO.deleteAll
(Collection<Document> documents, DocumentHistory transaction) Shortcut for deleteAll(documents, 1, transaction)void
HibernateDocumentDAO.deleteAll
(Collection<Document> documents, int delCode, DocumentHistory transaction) void
HibernateDocumentDAO.deleteAll
(Collection<Document> documents, DocumentHistory transaction) DocumentManager.merge
(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction) Merges a set of documents into a single PDF fileDocumentManagerImpl.merge
(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction) -
Uses of Document in com.logicaldoc.core.document.thumbnail
Modifier and TypeMethodDescriptionvoid
EpubThumbnailBuilder.buildThumbnail
(String sid, Document document, String fileVersion, File src, File dest, int size, int compression) void
ImageThumbnailBuilder.buildThumbnail
(String sid, Document document, String fileVersion, File src, File dest, int size, int quality) void
Mp3ThumbnailBuilder.buildThumbnail
(String sid, Document document, String fileVersion, File src, File dest, int size, int quality) void
PdfThumbnailBuilder.buildThumbnail
(String sid, Document document, String fileVersion, File src, File dest, int size, int compression) void
ThumbnailBuilder.buildThumbnail
(String sid, Document document, String fileVersion, File src, File dest, int size, int quality) Produce the thumbnailvoid
VideoThumbnailBuilder.buildThumbnail
(String sid, Document document, String fileVersion, File src, File dest, int size, int quality) void
ThumbnailManager.createMobile
(Document document, String fileVersion, String sid) Creates the mobile image for the specified document and file version.void
ThumbnailManager.createTile
(Document document, String fileVersion, String sid) Creates the tile for the specified document and file version.void
ThumbnailManager.createTumbnail
(Document document, String sid) Creates the thumbnail for the specified documentvoid
ThumbnailManager.createTumbnail
(Document document, String fileVersion, int size, Integer quality, String sid) Creates the thumbnail for the specified document and file version using given size and quality.void
ThumbnailManager.createTumbnail
(Document document, String fileVersion, String sid) Creates the thumbnail for the specified document and file version. -
Uses of Document in com.logicaldoc.core.parser
Modifier and TypeMethodDescriptionAbstractParser.parse
(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion) Parser.parse
(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion) Same asParser.parse(InputStream, ParseParameters)
, but use this when you have a file rather than a stream.static String
ParserFactory.parse
(InputStream input, String filename, String encoding, Locale locale, long tenantId, Document document, String fileVersion) Gets the proper parser and parse the given contentTXTParser.parse
(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion) ZABWParser.parse
(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion) void
ParseParameters.setDocument
(Document document) -
Uses of Document in com.logicaldoc.core.searchengine
Modifier and TypeMethodDescriptionvoid
SearchEngine.addHit
(Document document, InputStream content) Adds a new hit to the indexvoid
Adds a new Hit into the indexvoid
StandardSearchEngine.addHit
(Document document, InputStream content) void
-
Uses of Document in com.logicaldoc.core.store
Modifier and TypeMethodDescriptionAbstractStorer.getResourceName
(Document doc, String fileVersion, String suffix) Storer.getResourceName
(Document doc, String fileVersion, String suffix) Computes the resource name inside the container -
Uses of Document in com.logicaldoc.core.transfer
-
Uses of Document in com.logicaldoc.core.util
Modifier and TypeMethodDescriptionstatic String
DocUtil.getFileName
(Document document, String fileVersion) static String
DocUtil.getTenantName
(Document document) -
Uses of Document in com.logicaldoc.web.service
Modifier and TypeMethodDescriptionstatic Document
DocumentServiceImpl.toDocument
(GUIDocument guiDocument) Produces a plain new Document from a GUIDocumentModifier and TypeMethodDescriptionDocumentServiceImpl.fromDocument
(Document doc, GUIFolder folder, User sessionUser) -
Uses of Document in com.logicaldoc.webservice.model