Interface Converter

    • Method Detail

      • getConfig

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

        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
      • readTemplate

        void readTemplate​(java.io.InputStream is)
                   throws java.io.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
        Throws:
        java.io.IOException - if some exception occurs while reading the template
      • readTemplate

        void readTemplate​(java.io.File file)
                   throws java.io.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
        Throws:
        java.io.IOException - if the file does not exist or some exception occurs while reading the template
      • convert

        ConverterResult convert​(java.io.InputStream is,
                                java.lang.String sTargetFileName)
                         throws java.io.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
        Throws:
        java.io.IOException - if some exception occurs while reading the document
      • convert

        ConverterResult convert​(java.io.File source,
                                java.lang.String sTargetFileName)
                         throws java.io.FileNotFoundException,
                                java.io.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
        Throws:
        java.io.FileNotFoundException - if the file does not exist
        java.io.IOException - if some exception occurs while reading the document