Package org.ametys.plugins.flipbook

Class Document2ImagesConvertor

java.lang.Object

org.ametys.plugins.flipbook.Document2ImagesConvertor

All Implemented Interfaces:

Initializable, Component, Serviceable

public class Document2ImagesConvertor
extends Object
implements Component, Serviceable, Initializable

Converts a document file to PNG images, one image per page. The document images file name must begin with "page".
This component just delegates its behavior to the chosen Document2ImagesConvertorPolicy in configuration flipbook.convertor

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__CONFIGURATION_NAME
protected Document2ImagesConvertorPolicyExtensionPoint	_document2ImagesConvertorPolicies	The ExtensionPoint for Document2ImagesConvertorPolicies
protected Document2ImagesConvertorPolicy	_document2ImagesConvertorPolicyInConf	The Document2ImagesConvertorPolicy chosen in global configuration to use
static String	ROLE	The avalon role.

Constructor Summary

Constructors

Constructor	Description
Document2ImagesConvertor()

Method Summary

Modifier and Type	Method	Description
void	convert(File documentFile, File folder)	Convert the given document file to PNG images, one image per page.
List<String>	getSupportedMimeTypes()	Get the list of mime types the convertor can convert
void	initialize()
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The avalon role.

__CONFIGURATION_NAME

private static final String __CONFIGURATION_NAME

See Also:

Constant Field Values

_document2ImagesConvertorPolicies

protected Document2ImagesConvertorPolicyExtensionPoint _document2ImagesConvertorPolicies

The ExtensionPoint for Document2ImagesConvertorPolicies

_document2ImagesConvertorPolicyInConf

protected Document2ImagesConvertorPolicy _document2ImagesConvertorPolicyInConf

The Document2ImagesConvertorPolicy chosen in global configuration to use

Constructor Detail

Document2ImagesConvertor

public Document2ImagesConvertor()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getSupportedMimeTypes

public List<String> getSupportedMimeTypes()

Get the list of mime types the convertor can convert

Returns:

The list of supported mime-types

convert

public void convert(File documentFile,
                    File folder)
             throws IOException,
                    FlipbookException

Convert the given document file to PNG images, one image per page.

Parameters:

documentFile - the document file to convert.

folder - the destination folder.

Throws:

IOException - if an I/O error occurs.

FlipbookException - if a document error occurs.