Zorba

> The XQuery Processor

 

zorba::SAX2_ContentHandler Class Reference

Receive notification of events that result from serializing a query result as XML. More...

#include <zorba/sax2.h>

Inheritance diagram for zorba::SAX2_ContentHandler:

List of all members.

Public Member Functions
virtual void	characters (const String &aText)=0
	Receive notification of character data.
virtual void	endDocument ()=0
	Receive notification of the end of a document.
virtual void	endElement (const String &aURI, const String &aLocalname, const String &aQName)=0
	Receive notification of the end of an element.
virtual void	endPrefixMapping (const String &aPrefix)=0
	Receive notification of the end of an namespace prefix mapping.
virtual void	ignorableWhitespace (const String &aText)=0
	Receive notification of ignorable whitespace in element content.
virtual void	processingInstruction (const String &aTarget, const String &aData)=0
	Receive notification of a processing instruction.
virtual void	skippedEntity (const String &aName)=0
	Receive notification of a skipped entity.
virtual void	startDocument ()=0
	Receive notification of the beginning of a document.
virtual void	startElement (const String &aURI, const String &aLocalname, const String &aQName, const SAX2_Attributes &aAttrs)=0
	Receive notification of the beginning of an element.
virtual void	startPrefixMapping (const String &aPrefix, const String &aURI)=0
	Receive notification of the start of an namespace prefix mapping.
virtual	~SAX2_ContentHandler ()
	Destructor.

---

Detailed Description

Receive notification of events that result from serializing a query result as XML.

This is an interface that is used to receive notifications resulting from parsing a query result that was serialized as XML.

Instances of classes that implement this interface can be registered for a query by calling the XQuery::registerSAXHandler or XQuery::executeSAX function.

Definition at line 36 of file sax2.h.

---

Constructor & Destructor Documentation

virtual zorba::SAX2_ContentHandler::~SAX2_ContentHandler

(

)

[inline, virtual]

Destructor.

Definition at line 43 of file sax2.h.

---

Member Function Documentation

virtual void zorba::SAX2_ContentHandler::characters

(

const String &

aText

)

[pure virtual]

Receive notification of character data.

The serializer will call this method to report each chunk of character data.

Parameters:

aText

the characters from the serialized result.

Implemented in zorba::DefaultContentHandler.

virtual void zorba::SAX2_ContentHandler::endDocument

(

)

[pure virtual]

Receive notification of the end of a document.

Implemented in zorba::DefaultContentHandler.

virtual void zorba::SAX2_ContentHandler::endElement	(	const String &	aURI,
		const String &	aLocalname,
		const String &	aQName
	)			[pure virtual]

Receive notification of the end of an element.

Zorba's serializerwill invoke this method at the end of every element in the serialized query result document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

Parameters:

	aURI	the URI of the asscioated namespace for this element
	aLocalname	the local part of the element name
	aQName	the QName of this element

Implemented in zorba::DefaultContentHandler.

virtual void zorba::SAX2_ContentHandler::endPrefixMapping

(

const String &

aPrefix

)

[pure virtual]

Receive notification of the end of an namespace prefix mapping.

Parameters:

aPrefix

the namespace prefix used.

Implemented in zorba::DefaultContentHandler.

virtual void zorba::SAX2_ContentHandler::ignorableWhitespace

(

const String &

aText

)

[pure virtual]

Receive notification of ignorable whitespace in element content.

Parameters:

aText

the characters from the serialized query result.

Implemented in zorba::DefaultContentHandler.

virtual void zorba::SAX2_ContentHandler::processingInstruction	(	const String &	aTarget,
		const String &	aData
	)			[pure virtual]

Receive notification of a processing instruction.

The serializer will invoke this method once for each processing instruction found.

Parameters:

	aTarget	the processing instruction target.
	aData	the processing instruction data, or null if none was supplied.

Implemented in zorba::DefaultContentHandler.

virtual void zorba::SAX2_ContentHandler::skippedEntity

(

const String &

aName

)

[pure virtual]

Receive notification of a skipped entity.

Parameters:

aName

the name of the skipped entity.

Implemented in zorba::DefaultContentHandler.

virtual void zorba::SAX2_ContentHandler::startDocument

(

)

[pure virtual]

Receive notification of the beginning of a document.

Implemented in zorba::DefaultContentHandler.

virtual void zorba::SAX2_ContentHandler::startElement	(	const String &	aURI,
		const String &	aLocalname,
		const String &	aQName,
		const SAX2_Attributes &	aAttrs
	)			[pure virtual]

Receive notification of the beginning of an element.

Zorba's serializer will invoke this method at the beginning of every element of the serialized query result; 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:

	aURI	the URI of the associated namespace for this element.
	aLocalname	thee local part of the element name.
	aQName	the QName of this element.
	aAttrs	the attributes attached to the element, if any.

Implemented in zorba::DefaultContentHandler.

virtual void zorba::SAX2_ContentHandler::startPrefixMapping	(	const String &	aPrefix,
		const String &	aURI
	)			[pure virtual]

Receive notification of the start of an namespace prefix mapping.

Parameters:

	aPrefix	the namespace prefix used
	aURI	the namespace URI used.

Implemented in zorba::DefaultContentHandler.

---

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

• sax2.h

---