com.liferay.portlet.documentlibrary.util
Interface DLProcessor

All Known Implementing Classes:

DLPreviewableProcessor

public interface DLProcessor

Common interface for all the processors of the document library. All document library processors must implement this interface.

See Also:

AudioProcessor, DLPreviewableProcessor, ImageProcessor, PDFProcessor, RawMetadataProcessor, VideoProcessor

Method Summary

void	afterPropertiesSet()
void	cleanUp(FileEntry fileEntry)
void	cleanUp(FileVersion fileVersion)
void	copy(FileVersion sourceFileVersion, FileVersion destinationFileVersion)
void	exportGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement)
void	importGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, FileEntry importedFileEntry, Element fileEntryElement)
boolean	isSupported(FileVersion fileVersion)
boolean	isSupported(String mimeType)
void	trigger(FileVersion sourceFileVersion, FileVersion destinationFileVersion) Launches the processor's work with respect to the given file version.

Method Detail

afterPropertiesSet

void afterPropertiesSet()
                        throws Exception

Throws:

Exception

cleanUp

void cleanUp(FileEntry fileEntry)

cleanUp

void cleanUp(FileVersion fileVersion)

copy

void copy(FileVersion sourceFileVersion,
          FileVersion destinationFileVersion)

exportGeneratedFiles

void exportGeneratedFiles(PortletDataContext portletDataContext,
                          FileEntry fileEntry,
                          Element fileEntryElement)
                          throws Exception

Throws:

Exception

importGeneratedFiles

void importGeneratedFiles(PortletDataContext portletDataContext,
                          FileEntry fileEntry,
                          FileEntry importedFileEntry,
                          Element fileEntryElement)
                          throws Exception

Throws:

Exception

isSupported

boolean isSupported(FileVersion fileVersion)

isSupported

boolean isSupported(String mimeType)

trigger

void trigger(FileVersion sourceFileVersion,
             FileVersion destinationFileVersion)

Launches the processor's work with respect to the given file version.

Parameters:

sourceFileVersion - the file version to copy previews and thumbnails from (optionally null)

destinationFileVersion - the latest file version to process