Class ConfigurationReader

  • All Implemented Interfaces:
    javax.xml.transform.Result, Receiver
    Direct Known Subclasses:
    ConfigurationReaderPE

    public class ConfigurationReader
    extends java.lang.Object
    implements Receiver
    Class used to read a config.xml file and transfer all settings from the file to the Configuration
    • Constructor Detail

      • ConfigurationReader

        public ConfigurationReader()
    • Method Detail

      • setSystemId

        public void setSystemId​(java.lang.String systemId)
        Specified by:
        setSystemId in interface javax.xml.transform.Result
      • startDocument

        public void startDocument​(int properties)
                           throws XPathException
        Description copied from interface: Receiver
        Notify the start of a document node
        Specified by:
        startDocument in interface Receiver
        Parameters:
        properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOption
        Throws:
        XPathException - if an error occurs
      • setUnparsedEntity

        public void setUnparsedEntity​(java.lang.String name,
                                      java.lang.String systemID,
                                      java.lang.String publicID)
                               throws XPathException
        Description copied from interface: Receiver
        Notify an unparsed entity URI.
        Specified by:
        setUnparsedEntity in interface Receiver
        Parameters:
        name - The name of the unparsed entity
        systemID - The system identifier of the unparsed entity
        publicID - The identifier of the unparsed entity
        Throws:
        XPathException - if an error occurs
      • processingInstruction

        public void processingInstruction​(java.lang.String name,
                                          UnicodeString data,
                                          Location location,
                                          int properties)
                                   throws XPathException
        Description copied from interface: Receiver
        Output a processing instruction
        Specified by:
        processingInstruction in interface Receiver
        Parameters:
        name - The PI name. This must be a legal name (it will not be checked).
        data - The data portion of the processing instruction
        location - provides information such as line number and system ID.
        properties - Additional information about the PI.
        Throws:
        XPathException - if an error occurs
      • comment

        public void comment​(UnicodeString content,
                            Location location,
                            int properties)
                     throws XPathException
        Description copied from interface: Receiver
        Notify a comment. Comments are only notified if they are outside the DTD.
        Specified by:
        comment in interface Receiver
        Parameters:
        content - The content of the comment
        location - provides information such as line number and system ID.
        properties - Additional information about the comment.
        Throws:
        XPathException - if an error occurs
      • getSystemId

        public java.lang.String getSystemId()
        Specified by:
        getSystemId in interface javax.xml.transform.Result
      • setClassLoader

        public void setClassLoader​(java.lang.ClassLoader classLoader)
        Set the ClassLoader to be used for dynamic loading of the configuration, and for dynamic loading of other classes used within the configuration. By default the class loader of this class is used.
        Parameters:
        classLoader - the ClassLoader to be used
      • setBaseConfiguration

        public void setBaseConfiguration​(Configuration base)
        Set a base Configuration to be used by the new Configuration. The new Configuration shares a NamePool and document number allocator with the base Configuration
        Parameters:
        base - the base configuration to be used
      • makeConfiguration

        public Configuration makeConfiguration​(javax.xml.transform.Source source)
                                        throws XPathException
        Create a Configuration based on the contents of this configuration file
        Parameters:
        source - the Source of the configuration file
        Returns:
        the constructed Configuration
        Throws:
        XPathException - if a failure occurs, typically an invalid configuration file
      • endDocument

        public void endDocument()
        Description copied from interface: Receiver
        Notify the end of a document node
        Specified by:
        endDocument in interface Receiver
      • startElement

        public void startElement​(NodeName elemName,
                                 SchemaType type,
                                 AttributeMap atts,
                                 NamespaceMap namespaces,
                                 Location location,
                                 int properties)
                          throws XPathException
        Description copied from interface: Receiver
        Notify the start of an element
        Specified by:
        startElement in interface Receiver
        Parameters:
        elemName - the name of the element.
        type - the type annotation of the element.
        atts - the attributes of this element
        namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements
        location - an object providing information about the module, line, and column where the node originated
        properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption
        Throws:
        XPathException - if an error occurs
      • readExtensionElement

        protected void readExtensionElement​(AttributeMap atts)
        Process details of XSLT extension elements. Overridden in Saxon-PE configuration reader
        Parameters:
        atts - the attributes of the extensionElement element in the configuration file
      • readXsltPackage

        protected void readXsltPackage​(AttributeMap atts)
      • errorClass

        protected void errorClass​(java.lang.String element,
                                  java.lang.String attribute,
                                  java.lang.String actual,
                                  java.lang.Class required,
                                  java.lang.Exception cause)
      • endElement

        public void endElement()
                        throws XPathException
        Description copied from interface: Receiver
        Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.
        Specified by:
        endElement in interface Receiver
        Throws:
        XPathException - if an error occurs
      • characters

        public void characters​(UnicodeString chars,
                               Location location,
                               int properties)
                        throws XPathException
        Description copied from interface: Receiver
        Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.
        Specified by:
        characters in interface Receiver
        Parameters:
        chars - The characters
        location - provides information such as line number and system ID.
        properties - Bit significant value. The following bits are defined:
        DISABLE_ESCAPING
        Disable escaping for this text node
        USE_CDATA
        Output as a CDATA section
        Throws:
        XPathException - if an error occurs