org.xwiki.officeimporter.converter

Interface OfficeConverter

public interface OfficeConverter

Interface used to convert documents between various office formats.

Since:

5.0M2

Version:

$Id: aa7c74248bd92fa103e8ba93bd365dbce402d8af $

Method Summary

Modifier and Type	Method and Description
Map<String,byte[]>	convert(Map<String,InputStream> inputStreams, String inputFileName, String outputFileName) Attempts to convert the input document identified by inputStreams and inputFileName arguments into the format identified by outputFileName argument.
org.artofsolving.jodconverter.document.DocumentFormatRegistry	getFormatRegistry()

Method Detail

convert

Map<String,byte[]> convert(Map<String,InputStream> inputStreams,
                           String inputFileName,
                           String outputFileName)
                    throws OfficeConverterException

Attempts to convert the input document identified by inputStreams and inputFileName arguments into the format identified by outputFileName argument.

Parameters:

inputStreams - input streams corresponding to the input document; it's possible that some document types (e.g. HTML) consists of more than one input stream corresponding to different artifacts embedded within document content

inputFileName - name of the main input file within inputStreams map; this argument is used to determine the format of the input document

outputFileName - name of the main output file; an entry corresponding to this name will be available in the results map if the conversion succeeds; This argument is used to determine the format of the output document

Returns:

map of file names to file contents resulting from the conversion

Throws:

OfficeConverterException - if an error occurs during the conversion

getFormatRegistry

org.artofsolving.jodconverter.document.DocumentFormatRegistry getFormatRegistry()

Returns:

the registry of document formats known by this converter