te::xerces::ReaderHandler Class Reference

This class implements Xerces interface for a handler that receives general document events. More...

#include <ReaderHandler.h>

Inheritance diagram for te::xerces::ReaderHandler:

Public Member Functions

void characters (const XMLCh *const chars, const XMLSize_t length)
 It receives notification of character data. More...
 
void endDocument ()
 It receives notification of the end of a document. More...
 
void endElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname)
 It receives notification of the end of an element. More...
 
void endPrefixMapping (const XMLCh *const prefix)
 It receives notification of the end of an namespace prefix mapping. More...
 
XMLSize_t getDataLen () const
 
const xercesc::Attributes * getElementAttrs () const
 TODO. More...
 
const XMLCh * getElementLocalName () const
 TODO. More...
 
const XMLCh * getElementQName () const
 TODO. More...
 
const XMLCh * getElementURI () const
 TODO. More...
 
const XMLCh * getElementValue () const
 
const std::pair< const XMLCh *, const XMLCh * > & getNamespace (std::size_t i) const
 
te::xml::NodeType getNodeType () const
 It return the type of node read by the handler. More...
 
std::size_t getNumberOfNamespaces () const
 
void ignorableWhitespace (const XMLCh *const chars, const XMLSize_t length)
 It receives notification of ignorable whitespace in element content. More...
 
bool isInContractedForm () const
 
void processingInstruction (const XMLCh *const target, const XMLCh *const data)
 It receives notification of a processing instruction. More...
 
 ReaderHandler ()
 Default constructor. More...
 
void reset ()
 
void setDocumentLocator (const xercesc::Locator *const locator)
 It receives an object for locating the origin of SAX document events. More...
 
void setInContractedForm (bool d)
 
void setNodeType (te::xml::NodeType type)
 
void skippedEntity (const XMLCh *const name)
 It receives notification of a skipped entity. More...
 
void startDocument ()
 It receives notification of the beginning of a document. More...
 
void startElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname, const xercesc::Attributes &attrs)
 It receives notification of the beginning of an element. More...
 
void startPrefixMapping (const XMLCh *const prefix, const XMLCh *const uri)
 It receives notification of the start of an namespace prefix mapping. More...
 
 ~ReaderHandler ()
 Destructor. More...
 

Protected Attributes

const xercesc::Attributes * m_attrs
 The attributes attached to the current element, if any. More...
 
bool m_isInContractedForm
 A flag that indicates if the reader handler is on an contracted form element. More...
 
XMLSize_t m_len
 The number of characters in the m_value array. More...
 
const XMLCh * m_localname
 The local part of the current element name. More...
 
te::xml::NodeType m_nodeType
 The type of node read by the parser. More...
 
std::vector< std::pair< const XMLCh *, const XMLCh * > > m_nspaces
 A vector of namespaces (prefix, uri). More...
 
const XMLCh * m_qname
 The QName of the current element. More...
 
const XMLCh * m_uri
 URI of the associated namespace for the current element. More...
 
const XMLCh * m_value
 May be characters from the XML document, ignorable white spaces, CDATA or any other string. More...
 

Detailed Description

This class implements Xerces interface for a handler that receives general document events.

See also
Reader, ErrorHandler

Definition at line 52 of file ReaderHandler.h.

Constructor & Destructor Documentation

te::xerces::ReaderHandler::ReaderHandler ( )

Default constructor.

te::xerces::ReaderHandler::~ReaderHandler ( )
inline

Destructor.

Definition at line 60 of file ReaderHandler.h.

Member Function Documentation

void te::xerces::ReaderHandler::characters ( const XMLCh *const  chars,
const XMLSize_t  length 
)

It receives notification of character data.

Parameters
charsThe characters from the XML document.
lengthThe number of characters to read from the array.
Exceptions
SAXExceptionIt may throws an exception.
void te::xerces::ReaderHandler::endDocument ( )

It receives notification of the end of a document.

Exceptions
SAXExceptionIt may throws an exception.
void te::xerces::ReaderHandler::endElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname 
)

It receives notification of the end of an element.

Parameters
uriThe URI of the associated namespace for this element.
localnameThe local part of the element name.
qnameThe QName of this element.
Exceptions
SAXExceptionIt may throws an exception.
void te::xerces::ReaderHandler::endPrefixMapping ( const XMLCh *const  prefix)

It receives notification of the end of an namespace prefix mapping.

Parameters
prefixThe namespace prefix used.
Exceptions
SAXExceptionIt may throws an exception.
XMLSize_t te::xerces::ReaderHandler::getDataLen ( ) const
inline

Definition at line 205 of file ReaderHandler.h.

const xercesc::Attributes* te::xerces::ReaderHandler::getElementAttrs ( ) const
inline

TODO.

Returns
TODO

Definition at line 199 of file ReaderHandler.h.

const XMLCh* te::xerces::ReaderHandler::getElementLocalName ( ) const
inline

TODO.

Returns
TODO

Definition at line 185 of file ReaderHandler.h.

const XMLCh* te::xerces::ReaderHandler::getElementQName ( ) const
inline

TODO.

Returns
TODO

Definition at line 192 of file ReaderHandler.h.

const XMLCh* te::xerces::ReaderHandler::getElementURI ( ) const
inline

TODO.

Returns
TODO

Definition at line 178 of file ReaderHandler.h.

const XMLCh* te::xerces::ReaderHandler::getElementValue ( ) const
inline

Definition at line 201 of file ReaderHandler.h.

const std::pair<const XMLCh*, const XMLCh*>& te::xerces::ReaderHandler::getNamespace ( std::size_t  i) const
inline

Definition at line 209 of file ReaderHandler.h.

te::xml::NodeType te::xerces::ReaderHandler::getNodeType ( ) const

It return the type of node read by the handler.

Returns
The type of node read by the handler.
std::size_t te::xerces::ReaderHandler::getNumberOfNamespaces ( ) const
inline

Definition at line 207 of file ReaderHandler.h.

void te::xerces::ReaderHandler::ignorableWhitespace ( const XMLCh *const  chars,
const XMLSize_t  length 
)

It receives notification of ignorable whitespace in element content.

Parameters
charsThe characters from the XML document.
lengthThe number of characters to read from the array.
Exceptions
SAXExceptionIt may throws an exception.
bool te::xerces::ReaderHandler::isInContractedForm ( ) const
void te::xerces::ReaderHandler::processingInstruction ( const XMLCh *const  target,
const XMLCh *const  data 
)

It receives notification of a processing instruction.

Parameters
targetThe processing instruction target.
dataThe processing instruction data, or null if none was supplied.
Exceptions
SAXExceptionIt may throws an exception.
void te::xerces::ReaderHandler::reset ( )
void te::xerces::ReaderHandler::setDocumentLocator ( const xercesc::Locator *const  locator)

It receives an object for locating the origin of SAX document events.

Parameters
locatorAn object that can return the location of any SAX document event.
void te::xerces::ReaderHandler::setInContractedForm ( bool  d)
void te::xerces::ReaderHandler::setNodeType ( te::xml::NodeType  type)
void te::xerces::ReaderHandler::skippedEntity ( const XMLCh *const  name)

It receives notification of a skipped entity.

Parameters
nameThe name of the skipped entity.
Exceptions
SAXExceptionIt may throws an exception.
void te::xerces::ReaderHandler::startDocument ( )

It receives notification of the beginning of a document.

Exceptions
SAXExceptionIt may throws an exception.
void te::xerces::ReaderHandler::startElement ( const XMLCh *const  uri,
const XMLCh *const  localname,
const XMLCh *const  qname,
const xercesc::Attributes &  attrs 
)

It receives notification of the beginning of an element.

Parameters
uriThe URI of the associated namespace for this element.
localnameThe local part of the element name
qnameThe QName of this element.
attrsThe attributes attached to the element, if any.
Exceptions
SAXExceptionIt may throws an exception.
void te::xerces::ReaderHandler::startPrefixMapping ( const XMLCh *const  prefix,
const XMLCh *const  uri 
)

It receives notification of the start of an namespace prefix mapping.

Parameters
prefixThe namespace prefix used.
uriThe namespace URI used.
Exceptions
SAXExceptionIt may throws an exception.

Member Data Documentation

const xercesc::Attributes* te::xerces::ReaderHandler::m_attrs
protected

The attributes attached to the current element, if any.

Definition at line 222 of file ReaderHandler.h.

bool te::xerces::ReaderHandler::m_isInContractedForm
protected

A flag that indicates if the reader handler is on an contracted form element.

Definition at line 227 of file ReaderHandler.h.

XMLSize_t te::xerces::ReaderHandler::m_len
protected

The number of characters in the m_value array.

Definition at line 224 of file ReaderHandler.h.

const XMLCh* te::xerces::ReaderHandler::m_localname
protected

The local part of the current element name.

Definition at line 220 of file ReaderHandler.h.

te::xml::NodeType te::xerces::ReaderHandler::m_nodeType
protected

The type of node read by the parser.

Definition at line 226 of file ReaderHandler.h.

std::vector<std::pair<const XMLCh*, const XMLCh*> > te::xerces::ReaderHandler::m_nspaces
protected

A vector of namespaces (prefix, uri).

Definition at line 225 of file ReaderHandler.h.

const XMLCh* te::xerces::ReaderHandler::m_qname
protected

The QName of the current element.

Definition at line 221 of file ReaderHandler.h.

const XMLCh* te::xerces::ReaderHandler::m_uri
protected

URI of the associated namespace for the current element.

Definition at line 219 of file ReaderHandler.h.

const XMLCh* te::xerces::ReaderHandler::m_value
protected

May be characters from the XML document, ignorable white spaces, CDATA or any other string.

Definition at line 223 of file ReaderHandler.h.


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