Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Examples  

ost::XMLStream Class Reference

This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods. XML Stream Parser (SAX). More...

#include <xml.h>

Inheritance diagram for ost::XMLStream::

ost::XMLRPC List of all members.

Public Methods

virtual bool open (const char *resource)
 May perform an open operation on behalf of a parsed resource. More...

virtual void close (void)
 May perform a close operation of an i/o source when the parser has completed operation. More...

virtual Slog::Level getLogging (void)
 Get error logging level. More...

virtual void comment (const unsigned char *text, size_t len)
 Virtual to receive embedded comments in an XML document being parsed. More...

virtual int read (unsigned char *buffer, size_t len)=0
 Read method to aquire data for the parser. More...

virtual void characters (const unsigned char *text, size_t len)=0
 Virtual to receive character text extracted from the document in the current element. More...

virtual void startDocument (void)
 Identify start of document event. More...

virtual void endDocument (void)
 Identify end of document event. More...

virtual void startElement (const unsigned char *name, const unsigned char **attr)=0
 Identify start of an element in the document. More...

virtual void endElement (const unsigned char *name)=0
 Identify end of an element in the document. More...

bool parse (const char *resource=NULL)
 Parse a resource as a stream thru the virtual read method. More...


Protected Methods

virtual ~XMLStream ()

Detailed Description

This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods. XML Stream Parser (SAX).

This class must be derived into one that can impliment the physical I/O required to parse actual data. A mixer class using XMLStream and URLStream would seem a likely combination for this purpose.

Author:
David Sugar <dyfet@ostel.com>


Constructor & Destructor Documentation

ost::XMLStream::~XMLStream ( ) [protected, virtual]
 


Member Function Documentation

void ost::XMLStream::characters ( const unsigned char * text,
size_t len ) [pure virtual]
 

Virtual to receive character text extracted from the document in the current element.

Parameters:
text   received.
len   length of text received.

void ost::XMLStream::close ( void ) [virtual]
 

May perform a close operation of an i/o source when the parser has completed operation.

void ost::XMLStream::comment ( const unsigned char * text,
size_t len ) [virtual]
 

Virtual to receive embedded comments in an XML document being parsed.

Parameters:
text   text comment extracted.
len   length of comment.

void ost::XMLStream::endDocument ( void ) [virtual]
 

Identify end of document event.

void ost::XMLStream::endElement ( const unsigned char * name ) [pure virtual]
 

Identify end of an element in the document.

Parameters:
name   of element found.

Slog::Level ost::XMLStream::getLogging ( void ) [virtual]
 

Get error logging level.

Returns:
error logging level.

bool ost::XMLStream::open ( const char * resource ) [virtual]
 

May perform an open operation on behalf of a parsed resource.

In some cases, the parser may be merged with a class that already has performed some kind of open, and this method can then be ignored.

Returns:
true if open is successful.
Parameters:
resource   passed to Parse methods.

bool ost::XMLStream::parse ( const char * resource = NULL )
 

Parse a resource as a stream thru the virtual read method.

Returns:
true if well formed document has been fully parsed.
Parameters:
resource   optional name of resource.

int ost::XMLStream::read ( unsigned char * buffer,
size_t len ) [pure virtual]
 

Read method to aquire data for the parser.

Returns:
number of bytes actually read.
Parameters:
buffer   to read data into.
len   number of bytes to read.

void ost::XMLStream::startDocument ( void ) [virtual]
 

Identify start of document event.

void ost::XMLStream::startElement ( const unsigned char * name,
const unsigned char ** attr ) [pure virtual]
 

Identify start of an element in the document.

Parameters:
name   of element found.
attr   list of attributes extracted.


The documentation for this class was generated from the following file:
Generated at Fri May 30 14:51:05 2008 for GNU CommonC++ by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001