Public Member Functions | List of all members
zorba::SAX2_ContentHandler Class Referenceabstract

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

#include <zorba/sax2.h>

Inheritance diagram for zorba::SAX2_ContentHandler:
Inheritance graph
[legend]

Public Member Functions

virtual void characters (const String &aText)=0
 Receive notification of character data. More...
 
virtual void endDocument ()=0
 Receive notification of the end of a document. More...
 
virtual void endElement (const String &aURI, const String &aLocalname, const String &aQName)=0
 Receive notification of the end of an element. More...
 
virtual void endPrefixMapping (const String &aPrefix)=0
 Receive notification of the end of an namespace prefix mapping. More...
 
virtual void ignorableWhitespace (const String &aText)=0
 Receive notification of ignorable whitespace in element content. More...
 
virtual void processingInstruction (const String &aTarget, const String &aData)=0
 Receive notification of a processing instruction. More...
 
virtual void skippedEntity (const String &aName)=0
 Receive notification of a skipped entity. More...
 
virtual void startDocument ()=0
 Receive notification of the beginning of a document. More...
 
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. More...
 
virtual void startPrefixMapping (const String &aPrefix, const String &aURI)=0
 Receive notification of the start of an namespace prefix mapping. More...
 
virtual ~SAX2_ContentHandler ()
 Destructor. More...
 

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 ( )
inlinevirtual

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
aTextthe 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
aURIthe URI of the asscioated namespace for this element
aLocalnamethe local part of the element name
aQNamethe 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
aPrefixthe 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
aTextthe 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
aTargetthe processing instruction target.
aDatathe 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
aNamethe 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
aURIthe URI of the associated namespace for this element.
aLocalnamethee local part of the element name.
aQNamethe QName of this element.
aAttrsthe 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
aPrefixthe namespace prefix used
aURIthe namespace URI used.

Implemented in zorba::DefaultContentHandler.


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