om::xml::XMLSAXParser Class Reference

A class that sequentially parses an XML file as a series of document events. More...

#include <omXMLSAXParser.h>

Classes
class	Delegate
	A class that contains callback functions that are used to recieve XML data by the user. More...

Public Member Functions
	XMLSAXParser ()
	Create a new XML parser with the default initial state. More...
Bool	readFile (const UTF8String &pathToFile, const Delegate &delegate) const
	Parse an XML file located at the specified path location in the local file system. More...
Bool	readString (const UTF8String &documentString, const Delegate &delegate) const
	Parse a memory-resident XML document string. More...

Detailed Description

A class that sequentially parses an XML file as a series of document events.

This XML parser allows the user to parse large XML files without being required to store the entire documents in memory as with an XMLDOMParser. It uses an event-based interface that uses callback functions to notify the user that document elements have been parsed.

Constructor & Destructor Documentation

om::xml::XMLSAXParser::XMLSAXParser

(

)

Create a new XML parser with the default initial state.

Member Function Documentation

Bool om::xml::XMLSAXParser::readFile	(	const UTF8String &	pathToFile,
		const Delegate &	delegate
	)		const

Parse an XML file located at the specified path location in the local file system.

The parser parses the specified file and sends the file data to the delegate object's callback functions if they are set.

If the parsing succeeds, the method returns TRUE. Otherwise, the method returns FALSE.

Bool om::xml::XMLSAXParser::readString	(	const UTF8String &	documentString,
		const Delegate &	delegate
	)		const

Parse a memory-resident XML document string.

The parser parses the specified file and sends the file data to the delegate object's callback functions if they are set.

If the parsing succeeds, the method returns TRUE. Otherwise, the method returns FALSE.

---

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

• omXMLSAXParser.h