OSXMLDefaultHandler Class Reference

This class is derived from the SAX class DefaultHandler base class. More...

#include <rtSaxCppParser.h>

Inheritance diagram for OSXMLDefaultHandler:

List of all members.

Public Member Functions
virtual EXTXMLMETHOD int	startElement (const OSUTF8CHAR *const uri, const OSUTF8CHAR *const localname, const OSUTF8CHAR *const qname, const OSUTF8CHAR *const *attrs)
	Receive notification of the beginning of an element.
virtual EXTXMLMETHOD int	characters (const OSUTF8CHAR *const chars, unsigned int length)
	Receive notification of character data.
virtual EXTXMLMETHOD int	endElement (const OSUTF8CHAR *const uri, const OSUTF8CHAR *const localname, const OSUTF8CHAR *const qname)
	Receive notification of the end of an element.
OSINT16	getState ()
	This method returns the current state of the decoding process.

---

Detailed Description

This class is derived from the SAX class DefaultHandler base class.

It contains variables and methods specific to decoding XML messages. It is used to intercept standard SAX parser events, such as startElement, characters, endElement. This class is used as a base class for XBinder generated global element control classes (<elem>_CC).

Definition at line 58 of file rtSaxCppParser.h.

---

Member Function Documentation

virtual EXTXMLMETHOD int OSXMLDefaultHandler::startElement	(	const OSUTF8CHAR *const	uri,
		const OSUTF8CHAR *const	localname,
		const OSUTF8CHAR *const	qname,
		const OSUTF8CHAR *const *	attrs
	)			[virtual]

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, in order, before the corresponding endElement() event.

Parameters:

	uri	The URI of the asscioated namespace for this element
	localname	The local part of the element name
	qname	The QName of this element
	attrs	The attributes name/value pairs attached to the element, if any.

See also:

endElement

Implements OSXMLContentHandler.

virtual EXTXMLMETHOD int OSXMLDefaultHandler::characters	(	const OSUTF8CHAR *const	chars,
		unsigned int	length
	)			[virtual]

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

Parameters:

	chars	The characters from the XML document.
	length	The length of chars.

Implements OSXMLContentHandler.

virtual EXTXMLMETHOD int OSXMLDefaultHandler::endElement	(	const OSUTF8CHAR *const	uri,
		const OSUTF8CHAR *const	localname,
		const OSUTF8CHAR *const	qname
	)			[virtual]

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).

Parameters:

	uri	The URI of the asscioated namespace for this element
	localname	The local part of the element name
	qname	The QName of this element

Implements OSXMLContentHandler.

OSINT16 OSXMLDefaultHandler::getState

(

)

[inline]

This method returns the current state of the decoding process.

Returns:

The state of the decoding process as type OSXMLState. Can be XMLINIT, XMLSTART, XMLDATA, or XMLEND.

Definition at line 124 of file rtSaxCppParser.h.

---

The documentation for this class was generated from the following file:

• rtSaxCppParser.h