Package org.ametys.plugins.flipbook

Class AbstractConvertDocument2ImagesComponent

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.flipbook.AbstractConvertDocument2ImagesComponent

All Implemented Interfaces:

Initializable, Component, LogEnabled, Serviceable, ThreadSafe

Direct Known Subclasses:

ConvertContentAttachment2ImagesComponent, ConvertExternalResource2ImagesComponent, ConvertMetadata2ImagesComponent, ConvertResource2ImagesComponent

public abstract class AbstractConvertDocument2ImagesComponent
extends AbstractLogEnabled
implements ThreadSafe, Initializable, Serviceable, Component

Document to images action: converts the document into one image per page if it is not already done.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_cocoonContext	The cocoon context
protected Document2ImagesConvertor	_documentToImages	The document to images convertor.
protected AmetysObjectResolver	_resolver	The ametys object resolver.

Constructor Summary

Constructors

Constructor	Description
AbstractConvertDocument2ImagesComponent()

Method Summary

Modifier and Type	Method	Description
protected String	cache(String relativeCachePath, String md5sum, InputStream documentInputStream, String documentName, String documentId, String documentMimeType)	Create the images and put it into the cache
protected void	cleanCache(String relativeCachePath)	Clean a cache folder if it exists.
protected void	createImages(InputStream documentInputStream, String documentName, File baseFolder)	Create images for a resource, in a specified folder.
static File	getCacheFile(String relativeCachePath)	Get the cache file
void	initialize()
protected boolean	isMimeTypeSupported(String mimeType)	Test if the mimetype is supported for conversion
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

_documentToImages

protected Document2ImagesConvertor _documentToImages

The document to images convertor.

_cocoonContext

protected Context _cocoonContext

The cocoon context

Constructor Details

AbstractConvertDocument2ImagesComponent

public AbstractConvertDocument2ImagesComponent()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isMimeTypeSupported

protected boolean isMimeTypeSupported(String mimeType)

Test if the mimetype is supported for conversion

Parameters:

mimeType - the mime type

Returns:

true if the mimetype can be transformed

cache

protected String cache(String relativeCachePath,
 String md5sum,
 InputStream documentInputStream,
 String documentName,
 String documentId,
 String documentMimeType)
                throws IOException,
FlipbookException

Create the images and put it into the cache

Parameters:

relativeCachePath - the path of the relative cache

md5sum - the md5 sum

documentInputStream - the input stream of the document

documentName - the document's name

documentId - the id of the document

documentMimeType - the mime type of the document

Returns:

The absolute cache path

Throws:

IOException - if an error occurs while manipulating files

FlipbookException - if an error occurs while manipulating the flipbook

UnsupportedOperationException - If the mime type is not supported

cleanCache

protected void cleanCache(String relativeCachePath)

Clean a cache folder if it exists. This method is intended to invalidate cache created by the cache method

Parameters:

relativeCachePath - the relative cache path

getCacheFile

public static File getCacheFile(String relativeCachePath)

Get the cache file

Parameters:

relativeCachePath - the object path

Returns:

the cache file

createImages

protected void createImages(InputStream documentInputStream,
 String documentName,
 File baseFolder)
                     throws IOException,
FlipbookException

Create images for a resource, in a specified folder.

Parameters:

documentInputStream - the input stream of the document

documentName - the name of the document

baseFolder - the base folder.

Throws:

IOException - if an error occurs while manipulating files

FlipbookException - if an error occurs while manipulating the flipbook