44f4c68801
git-svn-id: svn://svn.code.sf.net/p/writer2latex/code/trunk@272 f0f2a975-2e09-46c8-9428-3b39399b9f3c
153 lines
6.7 KiB
Java
153 lines
6.7 KiB
Java
/************************************************************************
|
|
*
|
|
* Converter.java
|
|
*
|
|
* Copyright: 2002-2014 by Henrik Just
|
|
*
|
|
* This file is part of Writer2LaTeX.
|
|
*
|
|
* Writer2LaTeX is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Writer2LaTeX is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Writer2LaTeX. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Version 1.4 (2014-08-28)
|
|
*
|
|
*/
|
|
|
|
package writer2latex.api;
|
|
|
|
import java.io.File;
|
|
import java.io.FileNotFoundException;
|
|
import java.io.InputStream;
|
|
import java.io.IOException;
|
|
|
|
/** 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
|
|
* <code>ConverterFactory</code>
|
|
*/
|
|
public interface Converter {
|
|
|
|
/** Get the interface for the configuration of this converter
|
|
*
|
|
* @return the configuration
|
|
*/
|
|
public Config getConfig();
|
|
|
|
/** Define a <code>GraphicConverter</code> implementation to use for
|
|
* conversion of graphic files. If no converter is specified, graphic
|
|
* files will not be converted into other formats.
|
|
*
|
|
* @param gc the <code>GraphicConverter</code> to use
|
|
*/
|
|
public void setGraphicConverter(GraphicConverter gc);
|
|
|
|
/** Read a template to use as a base for the converted document.
|
|
* The format of the template depends on the <code>Converter</code>
|
|
* implementation.
|
|
*
|
|
* @param is an <code>InputStream</code> from which to read the template
|
|
* @throws IOException if some exception occurs while reading the template
|
|
*/
|
|
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 <code>Converter</code>
|
|
* implementation.
|
|
*
|
|
* @param 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
|
|
*/
|
|
public void readTemplate(File file) throws IOException;
|
|
|
|
/** Read a style sheet to <em>include</em> with the converted document.
|
|
* The format of the style sheet depends on the <code>Converter</code>
|
|
* implementation.
|
|
*
|
|
* @param is an <code>InputStream</code> from which to read the style sheet
|
|
* @throws IOException if some exception occurs while reading the style sheet
|
|
*/
|
|
public void readStyleSheet(InputStream is) throws IOException;
|
|
|
|
/** Read a style sheet to <em>include</em> with the converted document.
|
|
* The format of the style sheet depends on the <code>Converter</code>
|
|
* implementation.
|
|
*
|
|
* @param file a file from which to read the style sheet
|
|
* @throws IOException if the file does not exist or some exception occurs
|
|
* while reading the style sheet
|
|
*/
|
|
public void readStyleSheet(File file) throws IOException;
|
|
|
|
/** Read a resource to <em>include</em> with the converted document.
|
|
* A resource can be any (binary) file and will be placed in the same directory as
|
|
* the style sheet
|
|
*
|
|
* @param is an <code>InputStream</code> from which to read the resource
|
|
* @param sFileName the file name to use for the resource
|
|
* @param sMediaType the media type of the resource, if null the media type will be guessed from the file name
|
|
* @throws IOException if some exception occurs while reading the resource
|
|
*/
|
|
public void readResource(InputStream is, String sFileName, String sMediaType) throws IOException;
|
|
|
|
/** Read a style sheet to <em>include</em> with the converted document.
|
|
* A resource can be any (binary) file and will be placed in the same directory as
|
|
* the style sheet
|
|
*
|
|
* @param file a file from which to read the style sheet
|
|
* @param sFileName the file name to use for the resource
|
|
* @param sMediaType the media type of the resource, if null the media type will be guessed from the file name
|
|
* @throws IOException if the file does not exist or some exception occurs
|
|
* while reading the resource
|
|
*/
|
|
public void readResource(File file, String sFileName, String sMediaType) throws IOException;
|
|
|
|
/** Convert a document
|
|
*
|
|
* @param is an <code>InputStream</code> from which to read the source document.
|
|
* @param 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)
|
|
* @return a <code>ConverterResult</code> containing the converted document
|
|
* @throws IOException if some exception occurs while reading the document
|
|
*/
|
|
public ConverterResult convert(InputStream is, String sTargetFileName)
|
|
throws IOException;
|
|
|
|
/** Convert a document
|
|
*
|
|
* @param source a <code>File</code> from which to read the source document.
|
|
* @param 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)
|
|
* @return a <code>ConverterResult</code> containing the converted document
|
|
* @throws FileNotFoundException if the file does not exist
|
|
* @throws IOException if some exception occurs while reading the document
|
|
*/
|
|
public ConverterResult convert(File source, String sTargetFileName)
|
|
throws FileNotFoundException, IOException;
|
|
|
|
/** Convert a document
|
|
*
|
|
* @param dom a DOM tree representing the document as flat XML
|
|
* @param 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)
|
|
* @param bDestructive set to true if the converter is allowed to remove contents from the DOM tree (to save memory)
|
|
* @return a <code>ConverterResult</code> containing the converted document
|
|
* @throws IOException if some exception occurs while reading the document
|
|
*/
|
|
public ConverterResult convert(org.w3c.dom.Document dom, String sTargetFileName, boolean bDestructive)
|
|
throws IOException;
|
|
|
|
}
|