zorba::DefaultContentHandler Class Reference

A default content handler class implementing the SAX2_ContentHandler and SAX2_LexicalHandler interfaces with all functions being implemented and doing nothing. More...

#include <zorba/default_content_handler.h>

Inheritance diagram for zorba::DefaultContentHandler:

List of all members.

Public Member Functions

void attributeDecl (const String &eName, const String &aName, const String &type, const String &mode, const String &value)

void characters (const String &text)

Receive notification of character data.

void comment (const String &chars)

void elementDecl (const String &name, const String &model)

void endCDATA ()

void endDocument ()

Receive notification of the end of a document.

void endDTD ()

void endElement (const String &uri, const String &localname, const String &qname)

Receive notification of the end of an element.

void endEntity (const String &name)

void endPrefixMapping (const String &prefix)

Receive notification of the end of an namespace prefix mapping.

void externalEntityDecl (const String &name, const String &publicId, const String &systemId)

void ignorableWhitespace (const String &whitespace)

Receive notification of ignorable whitespace in element content.

void internalEntityDecl (const String &name, const String &value)

void notationDecl (const String &name, const String &publicId, const String &systemId)

void processingInstruction (const String &target, const String &data)

Receive notification of a processing instruction.

void resetDocType ()

void skippedEntity (const String &name)

Receive notification of a skipped entity.

void startCDATA ()

void startDocument ()

Receive notification of the beginning of a document.

void startDTD (const String &name, const String &publicId, const String &systemId)

void startElement (const String &uri, const String &localname, const String &qname, const SAX2_Attributes &aAttrs)

Receive notification of the beginning of an element.

void startEntity (const String &name)

void startPrefixMapping (const String &prefix, const String &uri)

Receive notification of the start of an namespace prefix mapping.

void unparsedEntityDecl (const String &name, const String &publicId, const String &systemId, const String &notationName)

virtual ~DefaultContentHandler ()

Detailed Description

A default content handler class implementing the SAX2_ContentHandler and SAX2_LexicalHandler interfaces with all functions being implemented and doing nothing.

See SAX2_ContentHandler for a documentation.

Examples:: sax2.cpp.

Definition at line 30 of file default_content_handler.h.

Constructor & Destructor Documentation

virtual zorba::DefaultContentHandler::~DefaultContentHandler ( ) [inline, virtual]

Definition at line 35 of file default_content_handler.h.

Member Function Documentation

void zorba::DefaultContentHandler::attributeDecl	(	const String &	eName,
		const String &	aName,
		const String &	type,
		const String &	mode,
		const String &	value
	)			`[inline]`

Definition at line 70 of file default_content_handler.h.

void zorba::DefaultContentHandler::characters ( const String & aText ) [inline, 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.

Implements zorba::SAX2_ContentHandler.

Examples:: sax2.cpp.

Definition at line 51 of file default_content_handler.h.

void zorba::DefaultContentHandler::comment ( const String & chars ) [inline, virtual]

Implements zorba::SAX2_LexicalHandler.

Definition at line 86 of file default_content_handler.h.

void zorba::DefaultContentHandler::elementDecl	(	const String &	name,
		const String &	model
	)			`[inline]`

Definition at line 68 of file default_content_handler.h.

void zorba::DefaultContentHandler::endCDATA ( ) [inline, virtual]

Implements zorba::SAX2_LexicalHandler.

Definition at line 88 of file default_content_handler.h.

void zorba::DefaultContentHandler::endDocument ( ) [inline, virtual]

Receive notification of the end of a document.

Implements zorba::SAX2_ContentHandler.

Examples:: sax2.cpp.

Definition at line 41 of file default_content_handler.h.

void zorba::DefaultContentHandler::endDTD ( ) [inline, virtual]

Implements zorba::SAX2_LexicalHandler.

Definition at line 90 of file default_content_handler.h.

void zorba::DefaultContentHandler::endElement	(	const String &	aURI,
		const String &	aLocalname,
		const String &	aQName
	)			`[inline, 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

Implements zorba::SAX2_ContentHandler.

Examples:: sax2.cpp.

Definition at line 48 of file default_content_handler.h.

void zorba::DefaultContentHandler::endEntity ( const String & name ) [inline, virtual]

Implements zorba::SAX2_LexicalHandler.

Definition at line 92 of file default_content_handler.h.

void zorba::DefaultContentHandler::endPrefixMapping ( const String & aPrefix ) [inline, virtual]

Receive notification of the end of an namespace prefix mapping.

Parameters:

aPrefix

the namespace prefix used.

Implements zorba::SAX2_ContentHandler.

Definition at line 63 of file default_content_handler.h.

void zorba::DefaultContentHandler::externalEntityDecl	(	const String &	name,
		const String &	publicId,
		const String &	systemId
	)			`[inline]`

Definition at line 76 of file default_content_handler.h.

void zorba::DefaultContentHandler::ignorableWhitespace ( const String & aText ) [inline, virtual]

Receive notification of ignorable whitespace in element content.

Parameters:

aText

the characters from the serialized query result.

Implements zorba::SAX2_ContentHandler.

Examples:: sax2.cpp.

Definition at line 57 of file default_content_handler.h.

void zorba::DefaultContentHandler::internalEntityDecl	(	const String &	name,
		const String &	value
	)			`[inline]`

Definition at line 74 of file default_content_handler.h.

void zorba::DefaultContentHandler::notationDecl	(	const String &	name,
		const String &	publicId,
		const String &	systemId
	)			`[inline]`

Definition at line 79 of file default_content_handler.h.

void zorba::DefaultContentHandler::processingInstruction	(	const String &	aTarget,
		const String &	aData
	)			`[inline, 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.

Implements zorba::SAX2_ContentHandler.

Examples:: sax2.cpp.

Definition at line 54 of file default_content_handler.h.

void zorba::DefaultContentHandler::resetDocType ( ) [inline]

Definition at line 84 of file default_content_handler.h.

void zorba::DefaultContentHandler::skippedEntity ( const String & aName ) [inline, virtual]

Receive notification of a skipped entity.

Parameters:

aName

the name of the skipped entity.

Implements zorba::SAX2_ContentHandler.

Definition at line 66 of file default_content_handler.h.

void zorba::DefaultContentHandler::startCDATA ( ) [inline, virtual]

Implements zorba::SAX2_LexicalHandler.

Definition at line 94 of file default_content_handler.h.

void zorba::DefaultContentHandler::startDocument ( ) [inline, virtual]

Receive notification of the beginning of a document.

Implements zorba::SAX2_ContentHandler.

Definition at line 38 of file default_content_handler.h.

void zorba::DefaultContentHandler::startDTD	(	const String &	name,
		const String &	publicId,
		const String &	systemId
	)			`[inline, virtual]`

Implements zorba::SAX2_LexicalHandler.

Definition at line 96 of file default_content_handler.h.

void zorba::DefaultContentHandler::startElement	(	const String &	aURI,
		const String &	aLocalname,
		const String &	aQName,
		const SAX2_Attributes &	aAttrs
	)			`[inline, 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.

Implements zorba::SAX2_ContentHandler.

Examples:: sax2.cpp.

Definition at line 44 of file default_content_handler.h.

void zorba::DefaultContentHandler::startEntity ( const String & name ) [inline, virtual]

Implements zorba::SAX2_LexicalHandler.

Definition at line 99 of file default_content_handler.h.

void zorba::DefaultContentHandler::startPrefixMapping	(	const String &	aPrefix,
		const String &	aURI
	)			`[inline, virtual]`

Receive notification of the start of an namespace prefix mapping.

Parameters:

	aPrefix	the namespace prefix used
	aURI	the namespace URI used.

Implements zorba::SAX2_ContentHandler.

Definition at line 60 of file default_content_handler.h.

void zorba::DefaultContentHandler::unparsedEntityDecl	(	const String &	name,
		const String &	publicId,
		const String &	systemId,
		const String &	notationName
	)			`[inline]`

Definition at line 81 of file default_content_handler.h.

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

default_content_handler.h


Public Member Functions
void	attributeDecl (const String &eName, const String &aName, const String &type, const String &mode, const String &value)
void	characters (const String &text)
	Receive notification of character data.
void	comment (const String &chars)
void	elementDecl (const String &name, const String &model)
void	endCDATA ()
void	endDocument ()
	Receive notification of the end of a document.
void	endDTD ()
void	endElement (const String &uri, const String &localname, const String &qname)
	Receive notification of the end of an element.
void	endEntity (const String &name)
void	endPrefixMapping (const String &prefix)
	Receive notification of the end of an namespace prefix mapping.
void	externalEntityDecl (const String &name, const String &publicId, const String &systemId)
void	ignorableWhitespace (const String &whitespace)
	Receive notification of ignorable whitespace in element content.
void	internalEntityDecl (const String &name, const String &value)
void	notationDecl (const String &name, const String &publicId, const String &systemId)
void	processingInstruction (const String &target, const String &data)
	Receive notification of a processing instruction.
void	resetDocType ()
void	skippedEntity (const String &name)
	Receive notification of a skipped entity.
void	startCDATA ()
void	startDocument ()
	Receive notification of the beginning of a document.
void	startDTD (const String &name, const String &publicId, const String &systemId)
void	startElement (const String &uri, const String &localname, const String &qname, const SAX2_Attributes &aAttrs)
	Receive notification of the beginning of an element.
void	startEntity (const String &name)
void	startPrefixMapping (const String &prefix, const String &uri)
	Receive notification of the start of an namespace prefix mapping.
void	unparsedEntityDecl (const String &name, const String &publicId, const String &systemId, const String &notationName)
virtual	~DefaultContentHandler ()