Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

writer2latex.api

Interface Converter

Known Implementing Classes:
Converter, Converter, ConverterBase, ConverterPalette, Xhtml10Converter, XhtmlMathMLConverter, XhtmlMathMLXSLConverter
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

ConverterResult
convert(File source, String sTargetFileName)
Convert a document
ConverterResult
convert(InputStream is, String sTargetFileName)
Convert a document
Config
getConfig()
Get the interface for the configuration of this converter
void
readTemplate(File file)
Read a template to use as a base for the converted document.
void
readTemplate(InputStream is)
Read a template to use as a base for the converted document.
void
setGraphicConverter(GraphicConverter gc)
Define a GraphicConverter implementation to use for conversion of graphic files.

Method Details

convert

public ConverterResult convert(File source,
                               String sTargetFileName)
            throws FileNotFoundException,
                   IOException
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

convert

public ConverterResult convert(InputStream is,
                               String sTargetFileName)
            throws IOException
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

getConfig

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

readTemplate

public void readTemplate(File file)
            throws IOException
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

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.
Parameters:
is - an InputStream from which to read 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

Overview Package Class Use Tree Index Deprecated About