com.aspc.Batch

Class XmlLoadParser

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.aspc.Batch.XmlLoadParser

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class XmlLoadParser
extends org.xml.sax.helpers.DefaultHandler

THREAD MODE: SINGLE-THREADED

Since:

March 4, 2002, 17:15

Author:

Jason McGrath

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlLoadParser.Builder Builder factory for creating a parser.

Method Summary

Modifier and Type	Method and Description
static XmlLoadParser.Builder	builder(DataBase dataBase, java.io.File inFile) Create a builder
void	characters(char[] ch, int start, int length) Called when character data is found in document If we are recording add a text node to DOM tree
void	endDocument() Called when there are no more nodes in the current document.
void	endElement(java.lang.String uri, java.lang.String namespc, java.lang.String name) Called when the SAX parser reaches a new XML closing tag.
void	fatalError(org.xml.sax.SAXParseException e)
protected void	processDOMTree(org.w3c.dom.Document doc) Called when we have a new DOM tree
void	startDocument() Called before process begins on current document.
void	startElement(java.lang.String uri, java.lang.String namespc, java.lang.String name, org.xml.sax.Attributes attr) Called when the SAX parser reaches a new XML tag.

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

endPrefixMapping, error, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Method Detail

builder

@CheckReturnValue
 @Nonnull
public static XmlLoadParser.Builder builder(@Nonnull
                                                                        DataBase dataBase,
                                                                        @Nonnull
                                                                        java.io.File inFile)

Create a builder

Parameters:

dataBase - the database.

inFile - the file to process.

Returns:

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Called before process begins on current document. Creates a DOM document builder so that we can build DOM structures as we parse the document.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException - a problem

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Called when there are no more nodes in the current document.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException - a problem

startElement

public void startElement(java.lang.String uri,
                         java.lang.String namespc,
                         java.lang.String name,
                         org.xml.sax.Attributes attr)
                  throws org.xml.sax.SAXException

Called when the SAX parser reaches a new XML tag. The state variable is used to keep track of where we are in the node tree. This allows us to validate the document to make sure that the structure is correct. At certain tags we begin storing the received information in a DOM tree. The endElement event will send this DOM tree to a method when the end tag is reached.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Parameters:

uri - URL

namespc - the name space

name - the name

attr - the attribute

Throws:

org.xml.sax.SAXException - a problem

endElement

public void endElement(java.lang.String uri,
                       java.lang.String namespc,
                       java.lang.String name)
                throws org.xml.sax.SAXException

Called when the SAX parser reaches a new XML closing tag. Simply updates the state to the parent node If we have reached the end of our DOM tree then process

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Parameters:

uri - the URI

namespc - the name space

name - the name

Throws:

org.xml.sax.SAXException - a problem

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Called when character data is found in document If we are recording add a text node to DOM tree

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Parameters:

ch - the characters

start - the start

length - the length

Throws:

org.xml.sax.SAXException - a problem

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

Parameters:

e - the error

Throws:

org.xml.sax.SAXException - a problem

processDOMTree

protected void processDOMTree(@Nonnull
                              org.w3c.dom.Document doc)
                       throws java.lang.Exception

Called when we have a new DOM tree

Parameters:

doc - the document

Throws:

java.lang.Exception - a serious problem