Package com.inductiveautomation.rm.archiver

Class RXElementParser

  • All Implemented Interfaces:
    org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler
    public class RXElementParser
extends org.xml.sax.helpers.DefaultHandler
implements org.xml.sax.ext.LexicalHandler
    A class to load an RXElement from aSource using SAX.

    This loader really loads "XML Data", not "XML Documents", making sure only childless elements can have value text (eg, no "HellothereWorld")

    • Constructor Summary

      Constructors 
      Constructor Description
      RXElementParser()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void characters​(char[] ch, int start, int length)
      Characters read callback.
      void comment​(char[] ch, int start, int length)  
      void endCDATA()  
      void endDocument()
      End document callback.
      void endDTD()  
      void endElement​(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
      End element callback.
      void endEntity​(java.lang.String aName)  
      void error​(org.xml.sax.SAXParseException e)
      Error encountered callback.
      void fatalError​(org.xml.sax.SAXParseException e)
      Fatal error encountered callback.
      RXElement parse​(java.lang.Object aSource)
      Kicks off xml parsing from given source and builds on this parser's element.
      org.xml.sax.InputSource resolveEntity​(java.lang.String publicId, java.lang.String systemId)
      Resolve entity callback.
      void startCDATA()  
      void startDocument()
      Start document callback.
      void startDTD​(java.lang.String aName, java.lang.String publicId, java.lang.String systemId)  
      void startElement​(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attr)
      Start element callback.
      void startEntity​(java.lang.String aName)  
      void warning​(org.xml.sax.SAXParseException e)
      Warning encountered callback.

      • Methods inherited from class org.xml.sax.helpers.DefaultHandler

        endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RXElementParser

        public RXElementParser()

    • Method Detail

      • parse

        public RXElement parse​(java.lang.Object aSource)
                throws java.io.IOException,
                       org.xml.sax.SAXException
        Kicks off xml parsing from given source and builds on this parser's element.
        Throws:
        java.io.IOException
        org.xml.sax.SAXException

      • startDocument

        public void startDocument()
                   throws org.xml.sax.SAXException
        Start document callback.
        Specified by:
        startDocument in interface org.xml.sax.ContentHandler
        Overrides:
        startDocument in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • endDocument

        public void endDocument()
                 throws org.xml.sax.SAXException
        End document callback.
        Specified by:
        endDocument in interface org.xml.sax.ContentHandler
        Overrides:
        endDocument in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • startElement

        public void startElement​(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attr)
                  throws org.xml.sax.SAXException
        Start element callback.
        Specified by:
        startElement in interface org.xml.sax.ContentHandler
        Overrides:
        startElement in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • characters

        public void characters​(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
        Characters read callback.
        Specified by:
        characters in interface org.xml.sax.ContentHandler
        Overrides:
        characters in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • endElement

        public void endElement​(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException
        End element callback.
        Specified by:
        endElement in interface org.xml.sax.ContentHandler
        Overrides:
        endElement in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • warning

        public void warning​(org.xml.sax.SAXParseException e)
             throws org.xml.sax.SAXException
        Warning encountered callback.
        Specified by:
        warning in interface org.xml.sax.ErrorHandler
        Overrides:
        warning in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • error

        public void error​(org.xml.sax.SAXParseException e)
           throws org.xml.sax.SAXException
        Error encountered callback.
        Specified by:
        error in interface org.xml.sax.ErrorHandler
        Overrides:
        error in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • fatalError

        public void fatalError​(org.xml.sax.SAXParseException e)
                throws org.xml.sax.SAXException
        Fatal error encountered callback.
        Specified by:
        fatalError in interface org.xml.sax.ErrorHandler
        Overrides:
        fatalError in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • resolveEntity

        public org.xml.sax.InputSource resolveEntity​(java.lang.String publicId,
                                             java.lang.String systemId)
        Resolve entity callback.
        Specified by:
        resolveEntity in interface org.xml.sax.EntityResolver
        Overrides:
        resolveEntity in class org.xml.sax.helpers.DefaultHandler

      • comment

        public void comment​(char[] ch,
                    int start,
                    int length)
        Specified by:
        comment in interface org.xml.sax.ext.LexicalHandler

      • endCDATA

        public void endCDATA()
        Specified by:
        endCDATA in interface org.xml.sax.ext.LexicalHandler

      • endDTD

        public void endDTD()
        Specified by:
        endDTD in interface org.xml.sax.ext.LexicalHandler

      • endEntity

        public void endEntity​(java.lang.String aName)
        Specified by:
        endEntity in interface org.xml.sax.ext.LexicalHandler

      • startCDATA

        public void startCDATA()
        Specified by:
        startCDATA in interface org.xml.sax.ext.LexicalHandler

      • startDTD

        public void startDTD​(java.lang.String aName,
                     java.lang.String publicId,
                     java.lang.String systemId)
        Specified by:
        startDTD in interface org.xml.sax.ext.LexicalHandler

      • startEntity

        public void startEntity​(java.lang.String aName)
        Specified by:
        startEntity in interface org.xml.sax.ext.LexicalHandler