Package org.xwiki.officeimporter.openoffice

Interface OpenOfficeConverter

@Deprecated
public interface OpenOfficeConverter

Deprecated.

since 5.0M2, use the OfficeConverter instead

Converter interface to be used for performing document conversion tasks.

Since:

2.2M1

Version:

$Id: a69d9aa8b7a2fec71f3ca4bc087aae82238a1688 $

Method Summary

Modifier and Type	Method	Description
Map<String,byte[]>	convert(Map<String,InputStream> inputStreams, String inputFileName, String outputFileName)	Deprecated. Attempts to convert the input document identified by inputStreams and inputFileName arguments into the format identified by outputFileName argument.
boolean	isMediaTypeSupported(String mediaType)	Deprecated. Checks if the office documents with the specified media type can be converted by this converter.

Method Detail

convert

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

Deprecated.

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:

OpenOfficeConverterException - if an error occurs during the conversion.

Since:

2.2M1

isMediaTypeSupported

boolean isMediaTypeSupported(String mediaType)

Deprecated.

Checks if the office documents with the specified media type can be converted by this converter.

Parameters:

mediaType - a media type

Returns:

true if the specified media type is supported, false otherwise

Since:

3.0M1