writer2latex.api
Interface Converter
- BatchConverter
- Converter, Converter, ConverterBase, ConverterPalette
public interface Converter
This is an interface for a converter, which offers conversion of
OpenDocument or OOo 1.x docs into a specific format.
Instances of this interface are created using the
ConverterFactory
ConverterResult | convert(InputStream is, String sTargetFileName) - Convert a document
|
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.
|
void | setConfig(Config config) - Define the configuration to use when converting.
|
void | setGraphicConverter(GraphicConverter gc) - Define a
GraphicConverter implementation to use for
conversion of graphic files.
|
convert
public ConverterResult convert(InputStream is,
String sTargetFileName)
throws IOException
Convert a document
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)
- a
ConverterResult
containing the converted document
readTemplate
public void readTemplate(InputStream is)
throws IOException
Read a template to use as a base for the converted document
The format of the template depends on the
Converter
implementation.
is
- an InputStream
from which to read the template
setConfig
public void setConfig(Config config)
Define the configuration to use when converting. If no configuration
is specified, the converter will use a default configuration.
Note: This method will change in version 0.6
config
- the configuration to use
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.
gc
- the GraphicConverter
to use