XBinder XML Runtime  XBinder Version 3.0.x
Classes | Public Member Functions | Protected Attributes | List of all members
OSXMLDefaultHandler Class Reference

This class is derived from the SAX class DefaultHandler base class. More...

#include <rtSaxCppParser.h>

Inheritance diagram for OSXMLDefaultHandler:
OSXMLDefaultHandlerIF OSXMLContentHandler OSXMLErrorInfo OSXMLAnyHandler OSXMLAnyTypeHandler OSXMLSimpleTypeHandler OSXMLSoapHandler

Classes

struct  ErrorInfo
 

Public Member Functions

 OSXMLDefaultHandler (OSRTContext *pContext, const OSUTF8CHAR *elemName=0, OSINT32 level=0)
 
virtual EXTXMLMETHOD int startElement (const OSUTF8CHAR *const uri, const OSUTF8CHAR *const localname, const OSUTF8CHAR *const qname, const OSUTF8CHAR *const *attrs)
 Receive notification of the beginning of an element. More...
 
virtual EXTXMLMETHOD int characters (const OSUTF8CHAR *const chars, unsigned int length)
 Receive notification of character data. More...
 
virtual EXTXMLMETHOD int endElement (const OSUTF8CHAR *const uri, const OSUTF8CHAR *const localname, const OSUTF8CHAR *const qname)
 Receive notification of the end of an element. More...
 
virtual EXTXMLMETHOD void startDocument ()
 
virtual EXTXMLMETHOD void endDocument ()
 
virtual EXTXMLMETHOD int finalize ()
 
virtual EXTXMLMETHOD void resetErrorInfo ()
 
virtual EXTXMLMETHOD void setErrorInfo (int status, const char *file=0, int line=0)
 
virtual EXTXMLMETHOD int getErrorInfo (int *status, const char **file, int *line)
 
OSINT16 getState ()
 This method returns the current state of the decoding process. More...
 
virtual void init (int level=0)
 
void setElemName (const OSUTF8CHAR *elemName)
 
OSBOOL isComplete ()
 
EXTXMLMETHOD void traceStartElement (const char *funcName, const OSUTF8CHAR *localName)
 
EXTXMLMETHOD void traceEndElement (const char *funcName, const OSUTF8CHAR *localName)
 
The virtual document handler interface

Protected Attributes

OSRTCtxtPtr mpContext
 
const OSUTF8CHAR * mpElemName
 
OSINT32 mLevel
 
OSINT16 mStartLevel
 
OSINT16 mReqElemCnt
 
OSINT16 mCurrElemIdx
 
OSINT16 mState
 
struct EXTXMLCLASS OSXMLDefaultHandler::ErrorInfo errorInfo
 

Detailed Description

This class is derived from the SAX class DefaultHandler base class.

It contains variables and methods specific to decoding XML messages. It is used to intercept standard SAX parser events, such as startElement, characters, endElement. This class is used as a base class for XBinder generated global element control classes (<elem>_CC).

Definition at line 58 of file rtSaxCppParser.h.

Member Function Documentation

◆ characters()

virtual EXTXMLMETHOD int OSXMLDefaultHandler::characters ( const OSUTF8CHAR *const  chars,
unsigned int  length 
)
virtual

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

Parameters
charsThe characters from the XML document.
lengthThe length of chars.

Implements OSXMLContentHandler.

Reimplemented in OSXMLSoapHandler, and OSXMLSimpleTypeHandler.

◆ endElement()

virtual EXTXMLMETHOD int OSXMLDefaultHandler::endElement ( const OSUTF8CHAR *const  uri,
const OSUTF8CHAR *const  localname,
const OSUTF8CHAR *const  qname 
)
virtual

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

Parameters
uriThe URI of the asscioated namespace for this element
localnameThe local part of the element name
qnameThe QName of this element

Implements OSXMLContentHandler.

Reimplemented in OSXMLAnyHandler, OSXMLSoapHandler, OSXMLAnyTypeHandler, and OSXMLSimpleTypeHandler.

◆ getState()

OSINT16 OSXMLDefaultHandler::getState ( )
inline

This method returns the current state of the decoding process.

Returns
The state of the decoding process as type OSXMLState. Can be XMLINIT, XMLSTART, XMLDATA, or XMLEND.

Definition at line 124 of file rtSaxCppParser.h.

◆ startElement()

virtual EXTXMLMETHOD int OSXMLDefaultHandler::startElement ( const OSUTF8CHAR *const  uri,
const OSUTF8CHAR *const  localname,
const OSUTF8CHAR *const  qname,
const OSUTF8CHAR *const *  attrs 
)
virtual

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; 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
uriThe URI of the asscioated namespace for this element
localnameThe local part of the element name
qnameThe QName of this element
attrsThe attributes name/value pairs attached to the element, if any.
See also
endElement

Implements OSXMLContentHandler.

Reimplemented in OSXMLAnyHandler, OSXMLSoapHandler, OSXMLAnyTypeHandler, and OSXMLSimpleTypeHandler.


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