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

Class SimpleXMLReader<T>

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.inductiveautomation.ignition.common.xmlserialization.simple.SimpleXMLReader<T>

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

HistoricalDataXmlReader, TagXMLImporter.TagXMLReader

public class SimpleXMLReader<T>
extends DefaultHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Class<? extends Element>>	elemTypeDictionary

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleXMLReader()

Method Summary

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Field Details

elemTypeDictionary

protected Map<String,Class<? extends Element>> elemTypeDictionary

Constructor Details

SimpleXMLReader

protected SimpleXMLReader()

Method Details

getLogger

protected final LoggerEx getLogger()

createLogger

protected org.apache.log4j.Logger createLogger()

initializeMappings

protected void initializeMappings()

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

parseFile

public T parseFile(File file)
            throws Exception

Throws:

Exception

parseString

public T parseString(String xml)
              throws Exception

Works the same as parseFile, but allows a String to be passed instead of a file

Throws:

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 Stack<Element> getElementStack()

getCurrentElement

protected Element getCurrentElement()

startElement

public void startElement(String uri,
 String localName,
 String name,
 Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String name)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

error

public void error(SAXParseException e)
           throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

warning

public void warning(SAXParseException e)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException