Uses of Class
com.logicaldoc.core.document.Document

Packages that use Document

Package	Description
com.logicaldoc.core	Core plug-in that contains the most important domain objects
com.logicaldoc.core.automation	Automation subsystem that allows you to program your own logic inside the platform. 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.
com.logicaldoc.core.conversion	Machinery for converting documents to different formats.
com.logicaldoc.core.document	Contains the definitions of Document and Version as well as other related objects
com.logicaldoc.core.document.dao
com.logicaldoc.core.document.thumbnail	Machinery for building thumbnails of the first page of the documents.
com.logicaldoc.core.parser	Machinery for parsing different file formats.
com.logicaldoc.core.searchengine	The core of the search engine.
com.logicaldoc.core.store	The store sub-system responsible for persisting the binaries of the documents.
com.logicaldoc.core.transfer
com.logicaldoc.core.util
com.logicaldoc.web.service	GWT services implementations.
com.logicaldoc.webservice.model

Uses of Document in com.logicaldoc.core

Methods in com.logicaldoc.core that return Document

Modifier and Type	Method	Description
Document	History.getDocument()

Methods in com.logicaldoc.core with parameters of type Document

Modifier and Type	Method	Description
void	History.setDocument(Document document)

Uses of Document in com.logicaldoc.core.automation

Methods in com.logicaldoc.core.automation that return Document

Modifier and Type	Method	Description
Document	DocTool.convert(Document doc, String format, String username)	Convert a document in another format and saves the result in another file in the same folder
Document	DocTool.copy(Document doc, String targetPath, String username)	Copies a document into a target folder
Document	DocTool.copyResource(Document doc, String fileVersion, String suffix, String newFileName, String username)	Copies a resource in a file in the same folder of the original document
Document	DocTool.createAlias(Document originalDoc, Folder targetFolder, String type, String username)	Creates an alias to a document
Document	DocTool.createAlias(Document originalDoc, String targetPath, String type, String username)	Creates an alias to a document
Document	DocTool.findById(long docId)	Retrieves a document by it's identifier
Document	DocTool.findByPath(String path)	Retrieves a document by it's path
Document	DocTool.findByPath(String path, Long tenantId)	Retrieves a document by it's path
Document	DocTool.merge(Collection<Document> documents, long targetFolderId, String fileName, String username)	Merges a set of documents into a single PDF file

Methods in com.logicaldoc.core.automation that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	MailTool.extractAttachments(Document doc, String filterFileName, String username)	Extracts attachments of email files (.eml, .msg) in the current folder

Methods in com.logicaldoc.core.automation with parameters of type Document

Modifier and Type	Method	Description
void	DocTool.addNote(Document doc, String text, String username)	Creates a new note for the whole document
Document	DocTool.convert(Document doc, String format, String username)	Convert a document in another format and saves the result in another file in the same folder
void	DocTool.convertPDF(Document doc)	Converts a document in PDF format and saves it as ancillary resource of the document with suffix FormatConverterManager.PDF_CONVERSION_SUFFIX.
Document	DocTool.copy(Document doc, String targetPath, String username)	Copies a document into a target folder
Document	DocTool.copyResource(Document doc, String fileVersion, String suffix, String newFileName, String username)	Copies a resource in a file in the same folder of the original document
int	DocTool.countPages(Document document)	Counts the number of pages of a document
Document	DocTool.createAlias(Document originalDoc, Folder targetFolder, String type, String username)	Creates an alias to a document
Document	DocTool.createAlias(Document originalDoc, String targetPath, String type, String username)	Creates an alias to a document
Folder	DocTool.createPath(Document doc, String targetPath, String username)	Creates a path, all existing nodes in the specified path will be reused
String	DocTool.displayUrl(Document doc)	Builds the display url of a document(display permalink)
EMail	MailTool.documentToEMail(Document document, boolean extractAttachments)	Creates an EMail object given the document that stores an email message.
String	DocTool.downloadUrl(Document doc)	Builds the download url of a document(download permalink)
List<Document>	MailTool.extractAttachments(Document doc, String filterFileName, String username)	Extracts attachments of email files (.eml, .msg) in the current folder
String	DocTool.getPath(Document doc)	Calculates the full path of a document
void	DocTool.initialize(Document doc)	Initializes lazy loaded collections
DocumentLink	DocTool.link(Document doc1, Document doc2, String type)	Links two documents
void	DocTool.move(Document doc, String targetPath, String username)	Moves a document into a target folder
String	DocTool.parse(Document document, String fileVersion)	Extracts the texts from a document, using the same analyzer used for the full-text processing.
void	MailTool.sendDocument(Document document, String from, String to, String subject, String message)	Sends a document by email to a recipient
void	MailTool.sendDocument(Document document, String from, Collection<String> to, String subject, String message)	Sends a document by email to a selection of recipients
void	DocTool.store(Document doc)	Saves / updates a document into the database
void	DocTool.store(Document doc, DocumentHistory transaction)	Saves / updates a document into the database
void	DocTool.store(Document doc, String username)	Saves / updates a document into the database

Method parameters in com.logicaldoc.core.automation with type arguments of type Document

Modifier and Type	Method	Description
List<Long>	DocTool.getIds(Collection<Document> docs)	Converts a collection of documents in a collection of identifiers
Document	DocTool.merge(Collection<Document> documents, long targetFolderId, String fileName, String username)	Merges a set of documents into a single PDF file
void	MailTool.sendDocuments(Collection<Document> documents, String from, String to, String subject, String message)	Sends some documents to a recipient
void	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

Methods in com.logicaldoc.core.conversion that return Document

Modifier and Type	Method	Description
Document	FormatConverterManager.convert(Document document, String fileVersion, String format, DocumentHistory transaction)	Converts a document into another format and saves the resulting file in the same folder

Methods in com.logicaldoc.core.conversion with parameters of type Document

Modifier and Type	Method	Description
final void	AbstractFormatConverter.convert(String sid, Document document, File src, File dest)	If the converter is enabled it invokes the AbstractFormatConverter.internalConvert(String, Document, File, File)
void	FormatConverter.convert(String sid, Document document, File src, File dest)	Performs the conversion
Document	FormatConverterManager.convert(Document document, String fileVersion, String format, DocumentHistory transaction)	Converts a document into another format and saves the resulting file in the same folder
void	NotAvailableConverter.convert(String sid, Document document, File src, File dest)
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

Methods in com.logicaldoc.core.document that return Document

Modifier and Type	Method	Description
Document	DocumentManager.copyToFolder(Document doc, Folder folder, DocumentHistory transaction)	Copy a document to the specified folder.
Document	DocumentManagerImpl.copyToFolder(Document doc, Folder folder, DocumentHistory transaction)
Document	DocumentManager.create(File file, Document docVO, DocumentHistory transaction)	Creates a new Document.
Document	DocumentManager.create(InputStream content, Document docVO, DocumentHistory transaction)	Creates a new Document.
Document	DocumentManagerImpl.create(File file, Document docVO, DocumentHistory transaction)
Document	DocumentManagerImpl.create(InputStream content, Document docVO, DocumentHistory transaction)
Document	DocumentManager.createAlias(Document doc, Folder folder, String type, DocumentHistory transaction)	Create an alias(shortcut) associated to the given doc to the specified folder.
Document	DocumentManagerImpl.createAlias(Document doc, Folder folder, String aliasType, DocumentHistory transaction)
Document	DocumentLink.getDocument1()
Document	DocumentLink.getDocument2()
Document	DocumentManager.merge(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction)	Merges a set of documents into a single PDF file
Document	DocumentManagerImpl.merge(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction)
Document	DocumentManager.replaceAlias(long aliasId, DocumentHistory transaction)	Replaces an alias with a copy of the original file
Document	DocumentManagerImpl.replaceAlias(long aliasId, DocumentHistory transaction)

Methods in com.logicaldoc.core.document with parameters of type Document

Modifier and Type	Method	Description
void	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 in
void	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 stored
void	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 database
void	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 in
void	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 database
void	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)
Document	DocumentManager.copyToFolder(Document doc, Folder folder, DocumentHistory transaction)	Copy a document to the specified folder.
Document	DocumentManagerImpl.copyToFolder(Document doc, Folder folder, DocumentHistory transaction)
int	DocumentManager.countPages(Document doc)	Counts the number of pages of a document
int	DocumentManagerImpl.countPages(Document doc)
Document	DocumentManager.create(File file, Document docVO, DocumentHistory transaction)	Creates a new Document.
Document	DocumentManager.create(InputStream content, Document docVO, DocumentHistory transaction)	Creates a new Document.
Document	DocumentManagerImpl.create(File file, Document docVO, DocumentHistory transaction)
Document	DocumentManagerImpl.create(InputStream content, Document docVO, DocumentHistory transaction)
static Version	Version.create(Document document, User user, String comment, String event, boolean release)	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 persistent
Document	DocumentManager.createAlias(Document doc, Folder folder, String type, DocumentHistory transaction)	Create an alias(shortcut) associated to the given doc to the specified folder.
Document	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 index
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)
String	DocumentManager.parseDocument(Document doc, String fileVersion)	Retrieves the document's content as a string
String	DocumentManagerImpl.parseDocument(Document doc, String fileVersion)
void	DocumentLink.setDocument1(Document document1)
void	DocumentLink.setDocument2(Document document2)
void	DocumentManager.update(Document doc, Document docVO, DocumentHistory transaction)	Updates an existing document and marks it to be re-indexed
void	DocumentManagerImpl.update(Document document, Document docVO, DocumentHistory transaction)

Method parameters in com.logicaldoc.core.document with type arguments of type Document

Modifier and Type	Method	Description
Document	DocumentManager.merge(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction)	Merges a set of documents into a single PDF file
Document	DocumentManagerImpl.merge(Collection<Document> documents, long targetFolderId, String fileName, DocumentHistory transaction)

Constructors in com.logicaldoc.core.document with parameters of type Document

Modifier	Constructor	Description
	Document(Document source)

Uses of Document in com.logicaldoc.core.document.dao

Methods in com.logicaldoc.core.document.dao that return Document

Modifier and Type	Method	Description
Document	DocumentDAO.findByCustomId(String customId, long tenantId)	This method finds a document by the custom ID.
Document	HibernateDocumentDAO.findByCustomId(String customId, long tenantId)
Document	DocumentDAO.findByPath(String path, long tenantId)	Finds a document by it's full path
Document	HibernateDocumentDAO.findByPath(String path, long tenantId)
Document	DocumentDAO.findDocument(long docId)	This method finds a document by the ID and if it is an alias the referenced document is returned instead.
Document	HibernateDocumentDAO.findDocument(long docId)

Methods in com.logicaldoc.core.document.dao that return types with arguments of type Document

Modifier and Type	Method	Description
List<Document>	DocumentDAO.findArchivedByFolder(long folderId)	Finds archived documents in a folder (direct childeren only)
List<Document>	HibernateDocumentDAO.findArchivedByFolder(long folderId)
List<Document>	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)
List<Document>	HibernateDocumentDAO.findByFileNameAndParentFolderId(Long folderId, String fileName, Long excludeId, Long tenantId, Integer max)
List<Document>	DocumentDAO.findByFolder(long folderId, Integer max)	Finds all documents direct children of the given folder.
List<Document>	HibernateDocumentDAO.findByFolder(long folderId, Integer max)
List<Document>	DocumentDAO.findByIds(Long[] ids, Integer max)	Finds all documents whose id is included in the given pool of ids
List<Document>	HibernateDocumentDAO.findByIds(Long[] ids, Integer max)
List<Document>	DocumentDAO.findByIndexed(int indexed)	Finds all documents by the indexed state.
List<Document>	HibernateDocumentDAO.findByIndexed(int indexed)
List<Document>	DocumentDAO.findByLockUserAndStatus(Long userId, Integer status)	Finds all document of0 the specified status and locked by the specified user
List<Document>	HibernateDocumentDAO.findByLockUserAndStatus(Long userId, Integer status)
List<Document>	DocumentDAO.findByUserIdAndTag(long userId, String tag, Integer max)	Finds authorized documents for a user having a specified tag.
List<Document>	HibernateDocumentDAO.findByUserIdAndTag(long userId, String tag, Integer max)
List<Document>	DocumentDAO.findDeleted(long userId, Integer max)	Finds all deleted docs of a specific user.
List<Document>	HibernateDocumentDAO.findDeleted(long userId, Integer maxHits)
List<Document>	DocumentDAO.findDeletedDocs()	Finds the list of deleted documents.
List<Document>	HibernateDocumentDAO.findDeletedDocs()
List<Document>	DocumentDAO.findLastDownloadsByUserId(long userId, int max)	Finds the last downloaded documents by the given user
List<Document>	HibernateDocumentDAO.findLastDownloadsByUserId(long userId, int maxResults)
List<Document>	DocumentDAO.findLastModifiedByUserId(long userId, int max)	Finds a max number of documents last modified by an user.
List<Document>	HibernateDocumentDAO.findLastModifiedByUserId(long userId, int maxElements)
List<Document>	DocumentDAO.findLinkedDocuments(long docId, String linkType, Integer direction)	This method enlists documents linked to the given document.
List<Document>	HibernateDocumentDAO.findLinkedDocuments(long docId, String linkType, Integer direction)

Methods in com.logicaldoc.core.document.dao with parameters of type Document

Modifier and Type	Method	Description
void	DocumentDAO.initialize(Document doc)	Initializes lazy loaded collections
void	HibernateDocumentDAO.initialize(Document doc)
void	DocumentDAO.saveDocumentHistory(Document doc, DocumentHistory transaction)	Saves a document's history
void	HibernateDocumentDAO.saveDocumentHistory(Document doc, DocumentHistory transaction)
void	DocumentDAO.store(Document doc, DocumentHistory transaction)	This method persists the document object and insert a new document history entry
void	HibernateDocumentDAO.store(Document doc)
void	HibernateDocumentDAO.store(Document doc, DocumentHistory transaction)
void	DocumentDAO.updateDigest(Document doc)	Updates the document's digest (SHA-1)
void	HibernateDocumentDAO.updateDigest(Document doc)

Method parameters in com.logicaldoc.core.document.dao with type arguments of type Document

Modifier and Type	Method	Description
void	DocumentDAO.deleteAll(Collection<Document> documents, int delCode, DocumentHistory transaction)	Deletes all documents form the database and modifies the custom ids of all documents
void	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)

Uses of Document in com.logicaldoc.core.document.thumbnail

Methods in com.logicaldoc.core.document.thumbnail with parameters of type Document

Modifier and Type	Method	Description
void	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 thumbnail
void	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 document
void	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

Methods in com.logicaldoc.core.parser that return Document

Modifier and Type	Method	Description
Document	ParseParameters.getDocument()

Methods in com.logicaldoc.core.parser with parameters of type Document

Modifier and Type	Method	Description
String	AbstractParser.parse(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion)
String	Parser.parse(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion)	Same as Parser.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 content
String	TXTParser.parse(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion)
String	ZABWParser.parse(File file, String filename, String encoding, Locale locale, String tenant, Document document, String fileVersion)
void	ParseParameters.setDocument(Document document)

Constructors in com.logicaldoc.core.parser with parameters of type Document

Modifier	Constructor	Description
	ParseParameters(Document document, String filename, String fileVersion, String encoding, Locale locale, String tenant)

Uses of Document in com.logicaldoc.core.searchengine

Subclasses of Document in com.logicaldoc.core.searchengine

Modifier and Type	Class	Description
class	Hit	Search result

Methods in com.logicaldoc.core.searchengine with parameters of type Document

Modifier and Type	Method	Description
void	SearchEngine.addHit(Document document, InputStream content)	Adds a new hit to the index
void	SearchEngine.addHit(Document document, String content)	Adds a new Hit into the index
void	StandardSearchEngine.addHit(Document document, InputStream content)
void	StandardSearchEngine.addHit(Document document, String content)

Uses of Document in com.logicaldoc.core.store

Methods in com.logicaldoc.core.store with parameters of type Document

Modifier and Type	Method	Description
String	AbstractStorer.getResourceName(Document doc, String fileVersion, String suffix)
String	Storer.getResourceName(Document doc, String fileVersion, String suffix)	Computes the resource name inside the container

Uses of Document in com.logicaldoc.core.transfer

Constructors in com.logicaldoc.core.transfer with parameters of type Document

Modifier	Constructor	Description
	InMemoryZipImport(Document docVo, String charset)
	ZipImport(Document docVo, String fileNameCharset)	Constructor.

Uses of Document in com.logicaldoc.core.util

Methods in com.logicaldoc.core.util with parameters of type Document

Modifier and Type	Method	Description
static String	DocUtil.getFileName(Document document, String fileVersion)
static String	DocUtil.getTenantName(Document document)

Uses of Document in com.logicaldoc.web.service

Methods in com.logicaldoc.web.service that return Document

Modifier and Type	Method	Description
static Document	DocumentServiceImpl.toDocument(GUIDocument guiDocument)	Produces a plain new Document from a GUIDocument

Methods in com.logicaldoc.web.service with parameters of type Document

Modifier and Type	Method	Description
GUIDocument	DocumentServiceImpl.fromDocument(Document doc, GUIFolder folder, User sessionUser)

Uses of Document in com.logicaldoc.webservice.model

Methods in com.logicaldoc.webservice.model that return Document

Modifier and Type	Method	Description
static Document	WSUtil.toDocument(WSDocument wsDoc)