fr.opensagres.xdocreport.converter

Interface IConverter

All Known Implementing Classes:

AbstractConverterEntriesSupport, AbstractConverterNoEntriesSupport

public interface IConverter

Converter API to convert source stream (docx, odt...) to another format (PDF, FO...)

Method Summary

Modifier and Type	Method and Description
boolean	canSupportEntries() Returns true if converter can support input stream entry provider and false otherwise.
void	convert(IEntryInputStreamProvider inProvider, java.io.OutputStream out, Options options) Convert the given entry input stream provider document to another format.
void	convert(java.io.InputStream in, java.io.OutputStream out, Options options) Convert the given entry input stream document zipped (odt, docx...) to another format.
MimeMapping	getMimeMapping() Returns mime mapping switch the kind of the converter (pdf, fo...).
boolean	isDefault() Returns true if the converter is the default converter to use when there is several converters with same from/to and false otherwise.

Method Detail

convert

void convert(IEntryInputStreamProvider inProvider,
             java.io.OutputStream out,
             Options options)
      throws XDocConverterException

Convert the given entry input stream provider document to another format.

Parameters:

inProvider -

out -

options -

Throws:

XDocConverterException

convert

void convert(java.io.InputStream in,
             java.io.OutputStream out,
             Options options)
      throws XDocConverterException

Convert the given entry input stream document zipped (odt, docx...) to another format.

Parameters:

inProvider -

out -

options -

Throws:

XDocConverterException

getMimeMapping

MimeMapping getMimeMapping()

Returns mime mapping switch the kind of the converter (pdf, fo...).

Returns:

canSupportEntries

boolean canSupportEntries()

Returns true if converter can support input stream entry provider and false otherwise.

Returns:

isDefault

boolean isDefault()

Returns true if the converter is the default converter to use when there is several converters with same from/to and false otherwise.

Returns: