StructureHandler Class Reference

Abstract class used by StructureDocumentHandler to parse the XML document. More...

#include <structurehandler.h>

Inheritance diagram for StructureHandler:

StructureHandlerBase AddContactAnswerHandler AnswerHandler BambooHandler ContactHandler ContactListHandler ContentHandler ErrorHandler EventHandler HeaderHandler MessageHandler RequestHandler StateChangedEventHandler List of all members.

Public Member Functions

 StructureHandler ()
 Constructor.
virtual ~StructureHandler ()
 Destructor.
virtual StructureHandler * startChild (const XMLCh *const lname, const Attributes &attrs)=0
 This method is called when a new element (Child) is met.
virtual void endDirectChild (const XMLCh *const lname, const std::string &content)=0
 This method is called when a closed element (Child) is met.
virtual void endElement (const XMLCh *const lname, const XMLCh *const content)=0
 This method is called when the element which "makes" this StructureHandler is closed. (Not used).
virtual void endStructureChild (const XMLCh *const lname, const StructureHandler *pHandler)=0
 This method is called when a element which causes a StructureHandler switch, is closed.
virtual void startElement (const XMLCh *const localname, const Attributes &atts)=0
 This method is called when this StrucutreHandler is created.
virtual void * getData ()
 Returns the object build.
virtual const void * getData () const
 Returns the object build. (const version).
virtual void setData (void *data)
 Sets the object object build.

Detailed Description

Abstract class used by StructureDocumentHandler to parse the XML document.

Author:
Sylvain Archenault <sylvain.archenault@laposte.net>

Yves Houpert <yves.houpert@insa-rouen.fr>

Member Function Documentation

virtual void StructureHandler::endDirectChild (  const XMLCh *const   lname,
const std::string &  content
)  [pure virtual]
 

This method is called when a closed element (Child) is met.

This method is used to process an element handled by this Structure Handler.

Parameters:
lname Element name.
name Content of the element.

Implemented in AddContactAnswerHandler, AnswerHandler, ContactHandler, ContactListHandler, ContentHandler, ErrorHandler, HeaderHandler, StateChangedEventHandler, and StructureHandlerBase.

virtual void StructureHandler::endElement (  const XMLCh *const   lname,
const XMLCh *const   content
)  [pure virtual]
 

This method is called when the element which "makes" this StructureHandler is closed. (Not used).

Parameters:
content Element content.
lname Element name.

Implemented in StructureHandlerBase.

virtual void StructureHandler::endStructureChild (  const XMLCh *const   lname,
const StructureHandler *  pHandler
)  [pure virtual]
 

This method is called when a element which causes a StructureHandler switch, is closed.

Parameters:
lname name of element closed.
pHandler StructureHandler used to parse this element.

Implemented in AddContactAnswerHandler, AnswerHandler, BambooHandler, ContactListHandler, and StructureHandlerBase.

virtual const void* StructureHandler::getData (   )  const [inline, virtual]
 

Returns the object build. (const version).

Returns:
Const BaseMessageObject.

virtual void* StructureHandler::getData (   )  [inline, virtual]
 

Returns the object build.

Returns:
BaseMessage object.

virtual void StructureHandler::setData (  void *  data  )  [inline, virtual]
 

Sets the object object build.

Parameters:
data Object build.

virtual StructureHandler* StructureHandler::startChild (  const XMLCh *const   lname,
const Attributes &  attrs
)  [pure virtual]
 

This method is called when a new element (Child) is met.

It returns a StructureHandler object able to parse the element structure. It returns null (0), if this handler is able to parse this structure.

Parameters:
lname Element name.
attrs The specified or defaulted attributes.
Returns:
A StructureHandler object, if the new element have to be process by another StructureHandler, null otherwise.

Implemented in AddContactAnswerHandler, AnswerHandler, BambooHandler, ContactListHandler, EventHandler, RequestHandler, StateChangedEventHandler, and StructureHandlerBase.

virtual void StructureHandler::startElement (  const XMLCh *const   localname,
const Attributes &  atts
)  [pure virtual]
 

This method is called when this StrucutreHandler is created.

Parameters:
localname Element name.
atts The specified or defaulted attributes.

Implemented in AddContactAnswerHandler, AnswerHandler, BambooHandler, ContactHandler, ContactListHandler, ContentHandler, ErrorHandler, EventHandler, HeaderHandler, StateChangedEventHandler, and StructureHandlerBase.

The documentation for this class was generated from the following files:
Generated on Fri May 19 12:15:55 2006 for Bamboo Ch@t by  doxygen 1.4.6