oracle.xml.parser.v2
Interface XMLDocumentHandler

All Known Implementing Classes:

DefaultXMLDocumentHandler, XSDParser, CXMLHandlerBase

public interface XMLDocumentHandler

extends DocumentHandler

This interface extends the org.xml.sax.DocumentHandler interface. SAX Applications requiring Namespace support must implement this interface and register with the SAX Parser via Parser.setDocumentHandler().

Method Summary

Type	Method
void	cDATASection(char[] ch, int start, int length) Receive notification of a CDATA Section.
void	comment(java.lang.String data) Receive notification of a comment.
void	endDoctype() Receive notification of end of the DTD.
void	endElement(NSName elem) Receive notification of the end of an element.
XMLDocumentHandler	getHandler() Get the next pipe-line node handler.
void	setDoctype(DTD dtd) Receive notification of a DTD (Document Type node).
void	setError(XMLError he) Receive notification of a XMLError handler.
void	setHandler(XMLDocumentHandler h) Receive notification of a next pipe-line node handler.
void	setTextDecl(java.lang.String version, java.lang.String encoding) Receive notification of a Text XML Declaration.
void	setXMLDecl(java.lang.String version, java.lang.String standalone, java.lang.String encoding) Receive notification of a XML Declaration.
void	setXMLSchema(java.lang.Object s) Receive notification of a XMLSchema object.
void	startElement(NSName elem, SAXAttrList attrlist) Receive notification of the beginning of an element.

Methods inherited from interface org.xml.sax.DocumentHandler

characters, endDocument, endElement, ignorableWhitespace, processingInstruction, setDocumentLocator, startDocument, startElement

Method Detail

startElement

public void startElement(NSName elem,
                         SAXAttrList attrlist)
                  throws SAXException

Receive notification of the beginning of an element. The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, inorder, before the corresponding endElement() event.

By implementing this method instead of org.xml.sax.DocumentHandler.startElement, SAX Applications can get the Namespace support provided by NSName and SAXAttrList.

Parameters:

elem - NSName object

attrlist - SAXAttrList for the element

Throws:

SAXException - A SAXException could be thrown.

See Also:

DocumentHandler.startElement(java.lang.String, org.xml.sax.AttributeList)

endElement

public void endElement(NSName elem)
                throws SAXException

Receive notification of the end of an element. The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

By implementing this method instead of org.xml.sax.DocumentHandler.endElement, SAX Applications can get the Namespace support provided by NSName.

Parameters:

elem - NSName object

Throws:

SAXException - A SAXException could be thrown.

See Also:

DocumentHandler.endElement(java.lang.String)

setXMLDecl

public void setXMLDecl(java.lang.String version,
                       java.lang.String standalone,
                       java.lang.String encoding)
                throws SAXException

Receive notification of a XML Declaration.

The Parser will invoke this method once for XML Decl

Parameters:

version - The version number

standalone - The standalone value (or null, if not specifed)

encoding - The encoding name (or null, if not specifed)

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

setTextDecl

public void setTextDecl(java.lang.String version,
                        java.lang.String encoding)
                 throws SAXException

Receive notification of a Text XML Declaration.

The Parser will invoke this method once for each text XML Decl

Parameters:

version - The version number (or null, if not specified)

encoding - The encoding name

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

comment

public void comment(java.lang.String data)
             throws SAXException

Receive notification of a comment.

The Parser will invoke this method once for each comment found: note that comment may occur before or after the main document element.

Parameters:

data - The comment data, or null if none was supplied.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

cDATASection

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

Receive notification of a CDATA Section.

The Parser will invoke this method once for each CDATA Section found.

Parameters:

ch - The CDATA section characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

setHandler

public void setHandler(XMLDocumentHandler h)
                throws SAXException

Receive notification of a next pipe-line node handler.

Parameters:

h - The XMLDocumentHandler node

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

getHandler

public XMLDocumentHandler getHandler()

Get the next pipe-line node handler.

Returns:

The XMLDocumentHandler node

setError

public void setError(XMLError he)
              throws SAXException

Receive notification of a XMLError handler.

Parameters:

he - The XMLError object

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

setXMLSchema

public void setXMLSchema(java.lang.Object s)
                  throws SAXException

Receive notification of a XMLSchema object.

Parameters:

s - The XMLSchema object

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

setDoctype

public void setDoctype(DTD dtd)
                throws SAXException

Receive notification of a DTD (Document Type node).

The Parser will invoke this method after calling startDocument to register the DTD used.

Parameters:

DTD - The DTD node

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

endDoctype

public void endDoctype()
                throws SAXException

Receive notification of end of the DTD.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.