classIBXMLCALL HandlerDump: public HandlerBase

SAX handler for dumping of XML data in plain text

Inheritance:

HandlerDump - HandlerBase - EntityResolver


Public

[more] Constructors and destructor.
[more] Implementation of the DocumentHandler interface.
[more] Attribute setting methods.


Inherited from HandlerBase:

Public

Default implementation of the DocumentHandler interface.

Default implementation of the EntityResolver interface.

Default implementation of the DTDHandler interface.

Default implementation of the ErrorHandler interface.


Inherited from EntityResolver:

Public

The entity resolver interface.


Inherited from DTDHandler:

Public

The DTD event handler interface.


Inherited from DocumentHandler:

Public

The document event handler interface.


Inherited from ErrorHandler:

Public

The error handler interface.


Documentation

SAX handler for dumping of XML data in plain text.

Only implements the DocumentHandler part of HandlerBase. Users should provide their own implementations of the ErrorHandler part of the handler by extending this class.

o Constructors and destructor.

o HandlerDump()
Default constructor.

ovirtual ~HandlerDump()
Destructor.

o Implementation of the DocumentHandler interface.

ovoid startDocument()
Callback notification of a start of document event.

Outputs the document prolog, i.e. the string '<?xml version="1.0"?>'.

Throws:
SAXException
See Also:
startDocument

ovoid endDocument()
Callback notification of an end of document event.

Ignores the event.

Throws:
SAXException
See Also:
endDocument

ovoid ignorableWhitespace(const ibxmlchar* s, unsigned int start, unsigned int length)
Callback notification of a text fragment of whitespace.

Outputs the fragment of whitespace verbatim.

Throws:
SAXException
Parameters:
ch - A pointer to an array of characters containing the fragment of character text parsed.
start - The index into the array of characters at which the whitespace text fragment parsed begins.
length - The number of whitespace characters passed in the character array which are the subject of this notification. characters at which the whitespace text fragment parsed begins.
See Also:
ignorableWhitespace
characters
characters

ovoid startElement(const ibxmlchar* name, const AttributeList& atts)
Callback notification of a start tag event.

If the attribute list is empty, outputs the string '<tag>', where "tag" is the name of the tag. If the attribute list is not empty, outputs the string '<tag attname1=ättvalue1" attname2=ättvalue2" ...>'

Throws:
SAXException
Parameters:
name - A pointer to a string containing the name of the element. If the element has an explicit namespace prefix, the prefix is part of the name.
atts - A reference to an object of the class AttributeList containing a list of all attributes declared by the element (if any). If no attributes are declared, the getLength() method of the AttributeList object will return 0.
See Also:
startElement
endElement
endElement
AttributeList
endElement

ovoid endElement(const ibxmlchar* name)
Callback notification of an end tag event.

Outputs the string '</tag>' where 'tag' is the name of the tag.

Throws:
SAXException
Parameters:
name - A pointer to a string containing the name of the element. If the element has an explicit namespace prefix, the prefix is part of the name.
See Also:
endElement
startElement
startElement

ovoid characters(const ibxmlchar* s, unsigned int start, unsigned int length)
Callback notification of a character chunk event.

Outputs the character data fragment verbatim.

Throws:
SAXException
Parameters:
ch - A pointer to an array of characters containing the fragment of character text parsed.
start - The index into the array of characters at which the whitespace text fragment parsed begins.
length - The number of whitespace characters passed in the character array which are the subject of this notification. characters at which the whitespace text fragment parsed begins.
See Also:
characters
ignorableWhitespace
ignorableWhitespace

o Attribute setting methods.

ovoid setOutputEncoding(const ibtchar* encoding)
Set the output encoding to be used by the output functions. The default output encoding is 7-bit US-ASCII.

Parameters:
encoding - A pointer to a string containing the name of the encoding to be used by the output functions. May be one of ÜS-ASCII", ÜTF-8", ÜTF-16" and "ISO-8859-1".

oibtchar* getOutputEncoding() const
Get the output encoding to be used by the output functions. The default output encoding is 7-bit US-ASCII.

Returns:
A pointer to a string containing the encoding which is used by the output functions. May be one of ÜS-ASCII", ÜTF-8", ÜTF-16" and "ISO-8859-1".


This class has no child classes.

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.