com.liferay.portlet.documentlibrary.util
Interface ImageProcessor

All Known Implementing Classes:

ImageProcessorImpl

public interface ImageProcessor

Method Summary

abstract void	cleanUp(FileEntry fileEntry)
abstract void	cleanUp(FileVersion fileVersion)
abstract void	exportGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, Element fileEntryElement)
abstract void	generateImages(FileVersion sourceFileVersion, FileVersion destinationFileVersion)
abstract Set<String>	getImageMimeTypes()
abstract InputStream	getPreviewAsStream(FileVersion fileVersion)
abstract long	getPreviewFileSize(FileVersion fileVersion)
abstract String	getPreviewType(FileVersion fileVersion)
abstract InputStream	getThumbnailAsStream(FileVersion fileVersion, int index)
abstract long	getThumbnailFileSize(FileVersion fileVersion, int index)
abstract String	getThumbnailType(FileVersion fileVersion)
abstract boolean	hasImages(FileVersion fileVersion)
abstract void	importGeneratedFiles(PortletDataContext portletDataContext, FileEntry fileEntry, FileEntry importedFileEntry, Element fileEntryElement)
abstract boolean	isImageSupported(FileVersion fileVersion)
abstract boolean	isImageSupported(String mimeType)
abstract boolean	isSupported(String mimeType)
abstract void	storeThumbnail(long companyId, long groupId, long fileEntryId, long fileVersionId, long custom1ImageId, long custom2ImageId, InputStream is, String type)
abstract void	trigger(FileVersion sourceFileVersion, FileVersion destinationFileVersion)

Method Detail

cleanUp

void cleanUp(FileEntry fileEntry)

cleanUp

void cleanUp(FileVersion fileVersion)

exportGeneratedFiles

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

Throws:

Exception

generateImages

void generateImages(FileVersion sourceFileVersion,
                    FileVersion destinationFileVersion)
                    throws Exception

Throws:

Exception

getImageMimeTypes

Set<String> getImageMimeTypes()

getPreviewAsStream

InputStream getPreviewAsStream(FileVersion fileVersion)
                               throws Exception

Throws:

Exception

getPreviewFileSize

long getPreviewFileSize(FileVersion fileVersion)
                        throws Exception

Throws:

Exception

getPreviewType

String getPreviewType(FileVersion fileVersion)

getThumbnailAsStream

InputStream getThumbnailAsStream(FileVersion fileVersion,
                                 int index)
                                 throws Exception

Throws:

Exception

getThumbnailFileSize

long getThumbnailFileSize(FileVersion fileVersion,
                          int index)
                          throws Exception

Throws:

Exception

getThumbnailType

String getThumbnailType(FileVersion fileVersion)

hasImages

boolean hasImages(FileVersion fileVersion)

importGeneratedFiles

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

Throws:

Exception

isImageSupported

boolean isImageSupported(FileVersion fileVersion)

isImageSupported

boolean isImageSupported(String mimeType)

isSupported

boolean isSupported(String mimeType)

storeThumbnail

void storeThumbnail(long companyId,
                    long groupId,
                    long fileEntryId,
                    long fileVersionId,
                    long custom1ImageId,
                    long custom2ImageId,
                    InputStream is,
                    String type)
                    throws Exception

Throws:

Exception

trigger

void trigger(FileVersion sourceFileVersion,
             FileVersion destinationFileVersion)