writer2latex.api

Interface Converter

public interface Converter

This is an interface for a converter, which offers conversion of OpenDocument (or OpenOffice.org 1.x) documents into a specific format. Instances of this interface are created using the ConverterFactory
Method Summary
ConverterResultconvert(InputStream is, String sTargetFileName)
Convert a document
ConverterResultconvert(File source, String sTargetFileName)
Convert a document
ConfiggetConfig()
Get the interface for the configuration of this converter
voidreadTemplate(InputStream is)
Read a template to use as a base for the converted document.
voidreadTemplate(File file)
Read a template to use as a base for the converted document.
voidsetGraphicConverter(GraphicConverter gc)
Define a GraphicConverter implementation to use for conversion of graphic files.

Method Detail

convert

public ConverterResult convert(InputStream is, String sTargetFileName)
Convert a document

Parameters: is an InputStream from which to read the source document. sTargetFileName the file name to use for the converted document (if the converted document is a compound document consisting consisting of several files, this name will be used for the master document)

Returns: a ConverterResult containing the converted document

Throws: IOException if some exception occurs while reading the document

convert

public ConverterResult convert(File source, String sTargetFileName)
Convert a document

Parameters: source a File from which to read the source document. sTargetFileName the file name to use for the converted document (if the converted document is a compound document consisting consisting of several files, this name will be used for the master document)

Returns: a ConverterResult containing the converted document

Throws: FileNotFoundException if the file does not exist IOException if some exception occurs while reading the document

getConfig

public Config getConfig()
Get the interface for the configuration of this converter

Returns: the configuration

readTemplate

public void readTemplate(InputStream is)
Read a template to use as a base for the converted document. The format of the template depends on the Converter implementation.

Parameters: is an InputStream from which to read the template

Throws: IOException if some exception occurs while reading the template

readTemplate

public void readTemplate(File file)
Read a template to use as a base for the converted document. The format of the template depends on the Converter implementation.

Parameters: file a file from which to read the template

Throws: IOException if the file does not exist or some exception occurs while reading the template

setGraphicConverter

public void setGraphicConverter(GraphicConverter gc)
Define a GraphicConverter implementation to use for conversion of graphic files. If no converter is specified, graphic files will not be converted into other formats.

Parameters: gc the GraphicConverter to use