|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=9"/><meta name="generator" content="Doxygen 1.8.9.1"/><title>Xerces-C++: XMLErrorReporter Class Reference</title><link href="tabs.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="jquery.js"></script><script type="text/javascript" src="dynsections.js"></script><link href="doxygen.css" rel="stylesheet" type="text/css" /></head><body><div id="top"><!-- do not remove this div, it is closed by doxygen! --><div id="titlearea"><table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Xerces-C++  <span id="projectnumber">3.1.2</span> </div> </td> </tr> </tbody></table></div><!-- end header part --><!-- Generated by Doxygen 1.8.9.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div></div><!-- top --><div class="header"> <div class="summary"><a href="#pub-types">Public Types</a> |<a href="classXMLErrorReporter-members.html">List of all members</a> </div> <div class="headertitle"><div class="title">XMLErrorReporter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div></div><!--header--><div class="contents">
<p>This abstract class defines a callback mechanism for the scanner. <a href="classXMLErrorReporter.html#details">More...</a></p><div class="dynheader">Inheritance diagram for XMLErrorReporter:</div><div class="dyncontent"> <div class="center"> <img src="classXMLErrorReporter.png" usemap="#XMLErrorReporter_map" alt=""/> <map id="XMLErrorReporter_map" name="XMLErrorReporter_map"><area href="classAbstractDOMParser.html" title="This class implements the Document Object Model (DOM) interface. " alt="AbstractDOMParser" shape="rect" coords="0,56,127,80"/><area href="classSAXParser.html" title="This class implements the SAX 'Parser' interface and should be used by applications wishing to parse ..." alt="SAXParser" shape="rect" coords="137,56,264,80"/><area href="classXercesDOMParser.html" title="This class implements the Document Object Model (DOM) interface. " alt="XercesDOMParser" shape="rect" coords="0,112,127,136"/></map> </div></div><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>Public Types</h2></td></tr><tr class="memitem:adb34298ba3609a10c52328e5050d4434"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLErrorReporter.html#adb34298ba3609a10c52328e5050d4434">ErrTypes</a> { <a class="el" href="classXMLErrorReporter.html#adb34298ba3609a10c52328e5050d4434a8eb5e69f473ddd242da938b5c1241335">ErrType_Warning</a>, <a class="el" href="classXMLErrorReporter.html#adb34298ba3609a10c52328e5050d4434a639aa1a0df503b58ca5db6b0a2f77da1">ErrType_Error</a>, <a class="el" href="classXMLErrorReporter.html#adb34298ba3609a10c52328e5050d4434a9cff22afc60445911df83efe0aef7f6f">ErrType_Fatal</a>, <a class="el" href="classXMLErrorReporter.html#adb34298ba3609a10c52328e5050d4434a2a038894f64cc6c6dbac34f7cb4a4be1">ErrTypes_Unknown</a> }</td></tr><tr class="separator:adb34298ba3609a10c52328e5050d4434"><td class="memSeparator" colspan="2"> </td></tr></table><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>Public Member Functions</h2></td></tr><tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr><tr class="memitem:ad41215add0c2b8026ca1bde74677c9de"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLErrorReporter.html#ad41215add0c2b8026ca1bde74677c9de">~XMLErrorReporter</a> ()</td></tr><tr class="memdesc:ad41215add0c2b8026ca1bde74677c9de"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#ad41215add0c2b8026ca1bde74677c9de">More...</a><br /></td></tr><tr class="separator:ad41215add0c2b8026ca1bde74677c9de"><td class="memSeparator" colspan="2"> </td></tr><tr><td colspan="2"><div class="groupHeader">Error Handler interface</div></td></tr><tr class="memitem:a6eca467a4753ce0dc6222aafe5c19ed0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLErrorReporter.html#a6eca467a4753ce0dc6222aafe5c19ed0">error</a> (const unsigned int errCode, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const errDomain, const <a class="el" href="classXMLErrorReporter.html#adb34298ba3609a10c52328e5050d4434">ErrTypes</a> type, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const errorText, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const systemId, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const publicId, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#add2d542a6583db767febf57446daa50d">XMLFileLoc</a> lineNum, const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#add2d542a6583db767febf57446daa50d">XMLFileLoc</a> colNum)=0</td></tr><tr class="memdesc:a6eca467a4753ce0dc6222aafe5c19ed0"><td class="mdescLeft"> </td><td class="mdescRight">Called to report errors from the scanner or validator. <a href="#a6eca467a4753ce0dc6222aafe5c19ed0">More...</a><br /></td></tr><tr class="separator:a6eca467a4753ce0dc6222aafe5c19ed0"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:aa8364a38a2ac6657448bad08ff6f0091"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLErrorReporter.html#aa8364a38a2ac6657448bad08ff6f0091">resetErrors</a> ()=0</td></tr><tr class="memdesc:aa8364a38a2ac6657448bad08ff6f0091"><td class="mdescLeft"> </td><td class="mdescRight">Called before a new parse event to allow the handler to reset. <a href="#aa8364a38a2ac6657448bad08ff6f0091">More...</a><br /></td></tr><tr class="separator:aa8364a38a2ac6657448bad08ff6f0091"><td class="memSeparator" colspan="2"> </td></tr></table><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>Protected Member Functions</h2></td></tr><tr><td colspan="2"><div class="groupHeader">Constructor</div></td></tr><tr class="memitem:aeb0322eba7a947a4fa89a9682875fe73"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXMLErrorReporter.html#aeb0322eba7a947a4fa89a9682875fe73">XMLErrorReporter</a> ()</td></tr><tr class="memdesc:aeb0322eba7a947a4fa89a9682875fe73"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#aeb0322eba7a947a4fa89a9682875fe73">More...</a><br /></td></tr><tr class="separator:aeb0322eba7a947a4fa89a9682875fe73"><td class="memSeparator" colspan="2"> </td></tr></table><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><p>This abstract class defines a callback mechanism for the scanner. </p><p>By creating a class that implements this interface and plugging an instance of that class into the scanner, the scanner will call back on the object's virtual methods to report error events. This class is also used with the validator, to allow it to report errors.</p><p>This class is primarily for use by those writing their own parser classes. If you use the standard parser classes, DOMParser and <a class="el" href="classSAXParser.html" title="This class implements the SAX 'Parser' interface and should be used by applications wishing to parse ...">SAXParser</a>, you won't use this API. You will instead use a similar mechanism defined by the SAX API, called <a class="el" href="classErrorHandler.html" title="Basic interface for SAX error handlers. ">ErrorHandler</a>. </p></div><h2 class="groupheader">Member Enumeration Documentation</h2><a class="anchor" id="adb34298ba3609a10c52328e5050d4434"></a><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="classXMLErrorReporter.html#adb34298ba3609a10c52328e5050d4434">XMLErrorReporter::ErrTypes</a></td> </tr> </table></div><div class="memdoc"><table class="fieldtable"><tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="adb34298ba3609a10c52328e5050d4434a8eb5e69f473ddd242da938b5c1241335"></a>ErrType_Warning </td><td class="fielddoc"></td></tr><tr><td class="fieldname"><a class="anchor" id="adb34298ba3609a10c52328e5050d4434a639aa1a0df503b58ca5db6b0a2f77da1"></a>ErrType_Error </td><td class="fielddoc"></td></tr><tr><td class="fieldname"><a class="anchor" id="adb34298ba3609a10c52328e5050d4434a9cff22afc60445911df83efe0aef7f6f"></a>ErrType_Fatal </td><td class="fielddoc"></td></tr><tr><td class="fieldname"><a class="anchor" id="adb34298ba3609a10c52328e5050d4434a2a038894f64cc6c6dbac34f7cb4a4be1"></a>ErrTypes_Unknown </td><td class="fielddoc"></td></tr></table>
</div></div><h2 class="groupheader">Constructor & Destructor Documentation</h2><a class="anchor" id="ad41215add0c2b8026ca1bde74677c9de"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual XMLErrorReporter::~XMLErrorReporter </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><span class="mlabel">virtual</span></span> </td> </tr></table></div><div class="memdoc">
<p>Default destructor. </p>
</div></div><a class="anchor" id="aeb0322eba7a947a4fa89a9682875fe73"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">XMLErrorReporter::XMLErrorReporter </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr></table></div><div class="memdoc">
<p>Default constructor. </p>
</div></div><h2 class="groupheader">Member Function Documentation</h2><a class="anchor" id="a6eca467a4753ce0dc6222aafe5c19ed0"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void XMLErrorReporter::error </td> <td>(</td> <td class="paramtype">const unsigned int </td> <td class="paramname"><em>errCode</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td> <td class="paramname"><em>errDomain</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classXMLErrorReporter.html#adb34298ba3609a10c52328e5050d4434">ErrTypes</a> </td> <td class="paramname"><em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td> <td class="paramname"><em>errorText</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td> <td class="paramname"><em>systemId</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#a8cb107980a360c490ad7661f5d27cc0e">XMLCh</a> *const </td> <td class="paramname"><em>publicId</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#add2d542a6583db767febf57446daa50d">XMLFileLoc</a> </td> <td class="paramname"><em>lineNum</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="Xerces__autoconf__config_8borland_8hpp.html#add2d542a6583db767febf57446daa50d">XMLFileLoc</a> </td> <td class="paramname"><em>colNum</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr></table></div><div class="memdoc">
<p>Called to report errors from the scanner or validator. </p><p>This method is called back on by the scanner or validator (or any other internal parser component which might need to report an error in the future.) It contains all the information that the client code might need to report or log the error.</p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">errCode</td><td>The error code of the error being reported. What this means is dependent on the domain it is from.</td></tr> <tr><td class="paramname">errDomain</td><td>The domain from which the error occured. The domain is a means of providing a hierarchical layering to the error system, so that a single set of error id numbers don't have to be split up.</td></tr> <tr><td class="paramname">type</td><td>The error type, which is defined mostly by XML which categorizes errors into warning, errors and validity constraints.</td></tr> <tr><td class="paramname">errorText</td><td>The actual text of the error. This is translatable, so can possibly be in the local language if a translation has been provided.</td></tr> <tr><td class="paramname">systemId</td><td>The system id of the entity where the error occured, fully qualified.</td></tr> <tr><td class="paramname">publicId</td><td>The optional public id of the entity were the error occured. It can be an empty string if non was provided.</td></tr> <tr><td class="paramname">lineNum</td><td>The line number within the source XML of the error.</td></tr> <tr><td class="paramname">colNum</td><td>The column number within the source XML of the error. Because of the parsing style, this is usually just after the actual offending text. </td></tr> </table> </dd></dl>
<p>Implemented in <a class="el" href="classSAXParser.html#a0c76a73233b61cc59a907e1f8fb5c341">SAXParser</a>, and <a class="el" href="classXercesDOMParser.html#aeee45cd34349b4d11948e0f21f5e7d99">XercesDOMParser</a>.</p>
</div></div><a class="anchor" id="aa8364a38a2ac6657448bad08ff6f0091"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void XMLErrorReporter::resetErrors </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr></table></div><div class="memdoc">
<p>Called before a new parse event to allow the handler to reset. </p><p>This method is called by the scanner before a new parse event is about to start. It gives the error handler a chance to reset its internal state. </p>
<p>Implemented in <a class="el" href="classSAXParser.html#a6294c7a4c3f7174e5d2838ec69dae106">SAXParser</a>, and <a class="el" href="classXercesDOMParser.html#a4f1c5100b71727fe4efef8f5c03341dc">XercesDOMParser</a>.</p>
</div></div><hr/>The documentation for this class was generated from the following file:<ul><li><a class="el" href="XMLErrorReporter_8hpp_source.html">XMLErrorReporter.hpp</a></li></ul></div><!-- contents --><!-- start footer part --><hr class="footer"/><address class="footer"><small>Generated on Wed Mar 18 2015 10:43:39 for Xerces-C++ by  <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1</small></address></body></html>
|
