Class ConfigurationXMLReader

  • All Implemented Interfaces:
    XMLReader
    Direct Known Subclasses:
    BaseConfigurationXMLReader, HierarchicalConfigurationXMLReader

    public abstract class ConfigurationXMLReader
    extends Object
    implements XMLReader

    A base class for "faked" XMLReader classes that transform a configuration object in a set of SAX parsing events.

    This class provides dummy implementations for most of the methods defined in the XMLReader interface that are not used for this special purpose. There will be concrete sub classes that process specific configuration classes.

    • Constructor Detail

      • ConfigurationXMLReader

        protected ConfigurationXMLReader()
        Creates a new instance of ConfigurationXMLReader.
    • Method Detail

      • parse

        public void parse​(String systemId)
                   throws IOException,
                          SAXException
        Parses the current configuration object. The passed system ID will be ignored.
        Specified by:
        parse in interface XMLReader
        Parameters:
        systemId - the system ID (ignored)
        Throws:
        IOException - if no configuration was specified
        SAXException - if an error occurs during parsing
      • getFeature

        public boolean getFeature​(String name)
        Dummy implementation of the interface method.
        Specified by:
        getFeature in interface XMLReader
        Parameters:
        name - the name of the feature
        Returns:
        always false (no features are supported)
      • setFeature

        public void setFeature​(String name,
                               boolean value)
        Dummy implementation of the interface method.
        Specified by:
        setFeature in interface XMLReader
        Parameters:
        name - the name of the feature to be set
        value - the value of the feature
      • getDTDHandler

        public DTDHandler getDTDHandler()
        Gets the DTD handler. This class does not support DTD handlers, so this method always returns null.
        Specified by:
        getDTDHandler in interface XMLReader
        Returns:
        the DTD handler
      • getProperty

        public Object getProperty​(String name)
        Dummy implementation of the interface method. No properties are supported, so this method always returns null.
        Specified by:
        getProperty in interface XMLReader
        Parameters:
        name - the name of the requested property
        Returns:
        the property value
      • setProperty

        public void setProperty​(String name,
                                Object value)
        Dummy implementation of the interface method. No properties are supported, so a call of this method just has no effect.
        Specified by:
        setProperty in interface XMLReader
        Parameters:
        name - the property name
        value - the property value
      • getRootName

        public String getRootName()
        Gets the name to be used for the root element.
        Returns:
        the name for the root element
      • setRootName

        public void setRootName​(String string)
        Sets the name for the root element.
        Parameters:
        string - the name for the root element.
      • fireElementStart

        protected void fireElementStart​(String name,
                                        Attributes attribs)
        Fires a SAX element start event.
        Parameters:
        name - the name of the actual element
        attribs - the attributes of this element (can be null)
      • fireElementEnd

        protected void fireElementEnd​(String name)
        Fires a SAX element end event.
        Parameters:
        name - the name of the affected element
      • fireCharacters

        protected void fireCharacters​(String text)
        Fires a SAX characters event.
        Parameters:
        text - the text
      • getException

        public SAXException getException()
        Gets a reference to an exception that occurred during parsing.
        Returns:
        a SAXExcpetion or null if none occurred
      • getParsedConfiguration

        public abstract Configuration getParsedConfiguration()
        Gets a reference to the configuration that is parsed by this object.
        Returns:
        the parsed configuration
      • processKeys

        protected abstract void processKeys()
                                     throws IOException,
                                            SAXException
        Processes all keys stored in the actual configuration. This method is called by parseConfiguration() to start the main parsing process. parseConfiguration() calls the content handler's startDocument() and endElement() methods and cares for exception handling. The remaining actions are left to this method that must be implemented in a concrete sub class.
        Throws:
        IOException - if an IO error occurs
        SAXException - if a SAX error occurs