org.nuxeo.ecm.core.convert.extension
Interface Converter

All Known Subinterfaces:

ExternalConverter

All Known Implementing Classes:

ChainedConverter, CommandLineBasedConverter, CropPictureConverter, FullTextConverter, Html2TextConverter, HtmlPreviewConverter, JODBasedConverter, Md2HtmlConverter, MSOffice2TextConverter, OOo2TextConverter, PDF2HtmlConverter, PDF2ImageConverter, PDF2TextConverter, PPT2TextConverter, ResizePictureConverter, RFC822ToTextConverter, RotationPictureConverter, Word2TextConverter, WordPerfect2TextConverter, XL2TextConverter, XLX2TextConverter, XML2TextConverter, Zip2HtmlConverter

public interface Converter

Interface that must be implemented by any contributer Converter class.

There is only one instance of each contributed converter class: that means that the implementation must be thread-safe.

Author:

tiry

Method Summary

BlobHolder	convert(BlobHolder blobHolder, Map<String,Serializable> parameters) Main method to handle the real Conversion Job.
void	init(ConverterDescriptor descriptor) Initializes the Converter.

Method Detail

init

void init(ConverterDescriptor descriptor)

Initializes the Converter.

This can be used to retrieve some configuration information from the XMap Descriptor.

convert

BlobHolder convert(BlobHolder blobHolder,
                   Map<String,Serializable> parameters)
                   throws ConversionException

Main method to handle the real Conversion Job.

Returned BlobHolder must implement CachableBlobHolder, otherwise result won't be cached.

Throws:

ConversionException