Package com.xmlmind.assembly

Class Processor

  • public class Processor
extends Object
    Assembly processor: processes a DocBook 5.1+ assembly file and creates the equivalent DocBook 5.1+ "flat" document (for example a book; called the "realized" document).

    • Constructor Detail

      • Processor

        public Processor​(Console c)
        Constructs a Processor using specified console to display its progress, warning, error, etc, messages.
        Parameters:
        c - the console. May be null.
        See Also:
        setConsole(com.xmlmind.util.Console)

    • Method Detail

      • setConsole

        public void setConsole​(Console c)

      • setResolver

        public void setResolver​(XMLResolver resolver)
        Specifies which entity and URI resolver to use when loading or transforming an XML document.
        Parameters:
        resolver - which resolver to use. May be null.
        See Also:
        getResolver()

      • setDocumentLoader

        public void setDocumentLoader​(Loader loader)
        Specifies which document loader to use to load XML documents.

        This loader is expected to process XInclude elements.

        Parameters:
        loader - which loader to use. May be null, in which case an instance of LoaderImpl is used.
        See Also:
        getDocumentLoader()

      • setTransclusionProcessor

        public void setTransclusionProcessor​(Processor proc)
        Specifies which processor to use to process transcluded documents.
        Parameters:
        proc - which transclusion processor to use. May be null, in which case an instance of Processor is used.
        See Also:
        getTransclusionProcessor()

      • setProcessedStructId

        public void setProcessedStructId​(String id)
        Specifies the value of the ID of the structure to be processed. This may be needed in case the assembly contains several structures.
        Parameters:
        id - the value of the xml:id attribute of the structure to be processed. May be null, in which case, the first structure in document order is processed.
        See Also:
        getProcessedStructId()

      • setOutputFormats

        public void setOutputFormats​(String[] formats)
        Specifies the output formats (generally only one) which are to be considered by this processor.
        Parameters:
        formats - the output formats which are to be considered by this processor. May be null, in which case:
        • If the structure to be processed has a outputformat attribute, then the value of this attribute is the output format considered by this processor.
        • Otherwise, the "implicit format" is used. The "implicit format" matches output, filterin, filterout elements without any outputformat attribute.
        See Also:
        setProcessedStructId(java.lang.String), getOutputFormats()

      • setCheckRealizedDocument

        public void setCheckRealizedDocument​(boolean check)
        Specifies whether realized document is to be checked for cross-reference errors, missing image resources, etc. Default option is false.
        See Also:
        getCheckRealizedDocument()

      • getCheckRealizedDocument

        public boolean getCheckRealizedDocument()
        Returns true if realized document is to be checked for cross-reference errors, missing image resources, etc.
        See Also:
        setCheckRealizedDocument(boolean)

      • setProfile

        public void setProfile​(String[] profile)
        Specifies the profile applied to the realized document.

        This may be needed if you want the diagnostics reported by the realized document checker to be accurate.

        Parameters:
        profile - a list of profiling attribute name/value pairs. May be null.
        See Also:
        getProfile(), setCheckRealizedDocument(boolean)

      • configure

        public int configure​(String[] args)
              throws IllegalArgumentException
        Allows to configure this processor using the options of command-line utility assembly (that is, -struct, -format, etc).
        Parameters:
        args - command-line options
        Returns:
        index in array args of first unknown option. This may be the index of an unknown option or the index of the assembly input file.
        Throws:
        IllegalArgumentException - if an usage error is found in args

      • process

        public Document process​(URL inURL,
                        URL realizedDocURL)
                 throws IOException
        Processes specified assembly and returns the realized document.

        Warning, errors and fatal errors (other than IOExceptions) are reported using the console.

        Parameters:
        inURL - URL of the assembly input document
        realizedDocURL - URL of the realized document. May be null if unimportant or unknown.
        Returns:
        realized document; null if a fatal error has been reported
        Throws:
        IOException - if, for any reason, an I/O exception is raised during the processing.
        See Also:
        process(URL, File)

      • process

        public boolean process​(URL inURL,
                       File outFile)
                throws IOException
        Processes specified assembly and saves the realized document to specified file.

        Warning, errors and fatal errors (other than IOExceptions) are reported using the console.

        Parameters:
        inURL - URL of the assembly input document
        outFile - save file of the realized document
        Returns:
        true if realized document has been saved; false if a fatal error has been reported
        Throws:
        IOException - if, for any reason, an I/O exception is raised during the processing.
        See Also:
        process(URL, URL)

      • main

        public static void main​(String[] args)
        Implementation of the assembly command-line utility.