com.docdoku.server.converters

Interface OnDemandConverter

public interface OnDemandConverter

OnDemandConverter plugin interface Extension point for attached files conversion

Method Summary

Modifier and Type	Method and Description
boolean	canConvert(String outputFormat, BinaryResource binaryResource) Determine if plugin is able to convert given resource in given output format
InputStream	getConvertedResource(String outputFormat, BinaryResource binaryResource, DocumentIteration documentIteration, Locale locale) Get the converted resource in given output format for a document iteration
InputStream	getConvertedResource(String outputFormat, BinaryResource binaryResource, PartIteration partIteration, Locale locale) Get the converted resource in given output format for a part iteration

Method Detail

canConvert

boolean canConvert(String outputFormat,
                   BinaryResource binaryResource)

Determine if plugin is able to convert given resource in given output format

Parameters:

outputFormat - the output format

binaryResource - the resource to convert

Returns:

true if plugin can handle the conversion, false otherwise

getConvertedResource

InputStream getConvertedResource(String outputFormat,
                                 BinaryResource binaryResource,
                                 DocumentIteration documentIteration,
                                 Locale locale)
                          throws ConvertedResourceException

Get the converted resource in given output format for a document iteration

Parameters:

outputFormat - the output format

binaryResource - the resource to convert

documentIteration - the document iteration concerned

locale - the locale to use for conversion

Returns:

the converted resource input stream

Throws:

ConvertedResourceException

getConvertedResource

InputStream getConvertedResource(String outputFormat,
                                 BinaryResource binaryResource,
                                 PartIteration partIteration,
                                 Locale locale)
                          throws ConvertedResourceException

Get the converted resource in given output format for a part iteration

Parameters:

outputFormat - the output format

binaryResource - the resource to convert

partIteration - the part iteration concerned

locale - the locale to use for conversion

Returns:

the converted resource input stream

Throws:

ConvertedResourceException