Package com.inductiveautomation.ignition.common.xmlserialization.simple

Class SimpleXMLReader<T>

  • All Implemented Interfaces:
    org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
    Direct Known Subclasses:
    HistoricalDataXmlReader, TagXMLImporter.TagXMLReader
    public class SimpleXMLReader<T>
extends org.xml.sax.helpers.DefaultHandler

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Map<java.lang.String,​java.lang.Class<? extends Element>> elemTypeDictionary  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected SimpleXMLReader()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void characters​(char[] ch, int start, int length)  
      protected org.apache.log4j.Logger createLogger()  
      void endElement​(java.lang.String uri, java.lang.String localName, java.lang.String name)  
      void error​(org.xml.sax.SAXParseException e)  
      void fatalError​(org.xml.sax.SAXParseException e)  
      protected Element getCurrentElement()  
      protected java.util.Stack<Element> getElementStack()  
      protected LoggerEx getLogger()  
      T getParsedValue()
      Can be called to get the value on the root element.
      protected void initializeMappings()  
      T parseFile​(java.io.File file)  
      T parseString​(java.lang.String xml)
      Works the same as parseFile, but allows a String to be passed instead of a file
      void setDocumentLocator​(org.xml.sax.Locator locator)  
      void startElement​(java.lang.String uri, java.lang.String localName, java.lang.String name, org.xml.sax.Attributes attributes)  
      void warning​(org.xml.sax.SAXParseException e)  

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

        endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • elemTypeDictionary

        protected java.util.Map<java.lang.String,​java.lang.Class<? extends Element>> elemTypeDictionary

    • Constructor Detail

      • SimpleXMLReader

        protected SimpleXMLReader()

    • Method Detail

      • getLogger

        protected final LoggerEx getLogger()

      • createLogger

        protected org.apache.log4j.Logger createLogger()

      • initializeMappings

        protected void initializeMappings()

      • setDocumentLocator

        public void setDocumentLocator​(org.xml.sax.Locator locator)
        Specified by:
        setDocumentLocator in interface org.xml.sax.ContentHandler
        Overrides:
        setDocumentLocator in class org.xml.sax.helpers.DefaultHandler

      • parseFile

        public T parseFile​(java.io.File file)
            throws java.lang.Exception
        Throws:
        java.lang.Exception

      • parseString

        public T parseString​(java.lang.String xml)
              throws java.lang.Exception
        Works the same as parseFile, but allows a String to be passed instead of a file
        Throws:
        java.lang.Exception

      • getParsedValue

        public T getParsedValue()
        Can be called to get the value on the root element. Should only be called after parsing is finished.

      • getElementStack

        protected java.util.Stack<Element> getElementStack()

      • getCurrentElement

        protected Element getCurrentElement()

      • startElement

        public void startElement​(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String name,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException
        Specified by:
        startElement in interface org.xml.sax.ContentHandler
        Overrides:
        startElement in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException

      • endElement

        public void endElement​(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String name)
                throws org.xml.sax.SAXException
        Specified by:
        endElement in interface org.xml.sax.ContentHandler
        Overrides:
        endElement 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
        Specified by:
        characters in interface org.xml.sax.ContentHandler
        Overrides:
        characters 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
        Specified by:
        error in interface org.xml.sax.ErrorHandler
        Overrides:
        error 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
        Specified by:
        warning in interface org.xml.sax.ErrorHandler
        Overrides:
        warning 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
        Specified by:
        fatalError in interface org.xml.sax.ErrorHandler
        Overrides:
        fatalError in class org.xml.sax.helpers.DefaultHandler
        Throws:
        org.xml.sax.SAXException