Class RootXmlReadHandler

    • Constructor Detail

    • Method Detail

      • addManualMapping

        protected void addManualMapping​(java.lang.Class classToRead,
                                        java.lang.Class handler)
        Adds a mapping between a class and the handler for the class.
        Parameters:
        classToRead - the class.
        handler - the handler class.
      • addMultiplexMapping

        protected void addMultiplexMapping​(java.lang.Class baseClass,
                                           java.lang.String typeAttr,
                                           MultiplexMappingEntry[] mdef)
        Adds a multiplex mapping.
        Parameters:
        baseClass - the base class.
        typeAttr - the type attribute.
        mdef - the mapping entry.
      • setHelperObject

        public void setHelperObject​(java.lang.String key,
                                    java.lang.Object value)
        Adds an object to the registry.
        Parameters:
        key - the key.
        value - the object.
      • getHelperObject

        public java.lang.Object getHelperObject​(java.lang.String key)
        Returns an object from the registry.
        Parameters:
        key - the key.
        Returns:
        The object.
      • createHandler

        public XmlReadHandler createHandler​(java.lang.Class classToRead,
                                            java.lang.String tagName,
                                            org.xml.sax.Attributes atts)
                                     throws XmlReaderException
        Creates a SAX handler for the specified class.
        Parameters:
        classToRead - the class.
        tagName - the tag name.
        atts - the attributes.
        Returns:
        a SAX handler.
        Throws:
        XmlReaderException - if there is a problem with the reader.
      • setRootHandler

        protected void setRootHandler​(XmlReadHandler handler)
        Sets the root SAX handler.
        Parameters:
        handler - the SAX handler.
      • recurse

        public void recurse​(XmlReadHandler handler,
                            java.lang.String tagName,
                            org.xml.sax.Attributes attrs)
                     throws XmlReaderException,
                            org.xml.sax.SAXException
        Start a new handler stack and delegate to another handler.
        Parameters:
        handler - the handler.
        tagName - the tag name.
        attrs - the attributes.
        Throws:
        XmlReaderException - if there is a problem with the reader.
        org.xml.sax.SAXException - if there is a problem with the parser.
      • delegate

        public void delegate​(XmlReadHandler handler,
                             java.lang.String tagName,
                             org.xml.sax.Attributes attrs)
                      throws XmlReaderException,
                             org.xml.sax.SAXException
        Delegate to another handler.
        Parameters:
        handler - the new handler.
        tagName - the tag name.
        attrs - the attributes.
        Throws:
        XmlReaderException - if there is a problem with the reader.
        org.xml.sax.SAXException - if there is a problem with the parser.
      • unwind

        public void unwind​(java.lang.String tagName)
                    throws org.xml.sax.SAXException,
                           XmlReaderException
        Hand control back to the previous handler.
        Parameters:
        tagName - the tagname.
        Throws:
        org.xml.sax.SAXException - if there is a problem with the parser.
        XmlReaderException - if there is a problem with the reader.
      • startDocument

        public void startDocument()
                           throws org.xml.sax.SAXException
        Starts processing a document.
        Specified by:
        startDocument in interface org.xml.sax.ContentHandler
        Overrides:
        startDocument in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException - not in this implementation.
      • startElement

        public void startElement​(java.lang.String uri,
                                 java.lang.String localName,
                                 java.lang.String qName,
                                 org.xml.sax.Attributes attributes)
                          throws org.xml.sax.SAXException
        Starts processing an element.
        Specified by:
        startElement in interface org.xml.sax.ContentHandler
        Overrides:
        startElement in class org.xml.sax.helpers.DefaultHandler
        Parameters:
        uri - the URI.
        localName - the local name.
        qName - the qName.
        attributes - the attributes.
        Throws:
        org.xml.sax.SAXException - if there is a parsing problem.
      • characters

        public void characters​(char[] ch,
                               int start,
                               int length)
                        throws org.xml.sax.SAXException
        Process character data.
        Specified by:
        characters in interface org.xml.sax.ContentHandler
        Overrides:
        characters in class org.xml.sax.helpers.DefaultHandler
        Parameters:
        ch - the character buffer.
        start - the start index.
        length - the length of the character data.
        Throws:
        org.xml.sax.SAXException - if there is a parsing error.
      • endElement

        public void endElement​(java.lang.String uri,
                               java.lang.String localName,
                               java.lang.String qName)
                        throws org.xml.sax.SAXException
        Finish processing an element.
        Specified by:
        endElement in interface org.xml.sax.ContentHandler
        Overrides:
        endElement in class org.xml.sax.helpers.DefaultHandler
        Parameters:
        uri - the URI.
        localName - the local name.
        qName - the qName.
        Throws:
        org.xml.sax.SAXException - if there is a parsing error.
      • loadHandlerClass

        protected XmlReadHandler loadHandlerClass​(java.lang.String className)
                                           throws XmlReaderException
        Loads the given class, and ignores all exceptions which may occur during the loading. If the class was invalid, null is returned instead.
        Parameters:
        className - the name of the class to be loaded.
        Returns:
        the class or null.
        Throws:
        XmlReaderException - if there is a reader error.
      • loadClass

        protected java.lang.Class loadClass​(java.lang.String className)
                                     throws XmlReaderException
        Loads the given class, and ignores all exceptions which may occur during the loading. If the class was invalid, null is returned instead.
        Parameters:
        className - the name of the class to be loaded.
        Returns:
        the class or null.
        Throws:
        XmlReaderException - if there is a reader error.
      • getResult

        public java.lang.Object getResult()
                                   throws org.xml.sax.SAXException
        Description copied from class: FrontendDefaultHandler
        Returns the parse result. This method is called at the end of the parsing process and expects the generated object.
        Specified by:
        getResult in class FrontendDefaultHandler
        Returns:
        the object.
        Throws:
        org.xml.sax.SAXException - if something went wrong.