source: NonGTP/Xerces/xerces/doc/html/apiDocs/classDocumentHandler.html @ 358

Revision 358, 38.2 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>DocumentHandler class Reference</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
2  <A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
7  <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR> 
15  <A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
16  <A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
22  <A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
27  <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
38    <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
44<hr><h1>DocumentHandler  Class Reference</h1>Receive notification of general document events.
45<a href="#_details">More...</a>
46<p>
47Inheritance diagram for DocumentHandler:<p><center><img src="classDocumentHandler__inherit__graph.gif" border="0" usemap="#DocumentHandler__inherit__map" alt="Inheritance graph"></center>
48<map name="DocumentHandler__inherit__map">
49<area href="classHandlerBase.html" shape="rect" coords="23,105,108,87" alt="">
50</map>
51<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDocumentHandler-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
52<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
53<tr><td colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr>
54<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z420_0">DocumentHandler</a> ()</td></tr>
55<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor.</em> <a href="#z420_0">More...</a><em></em></font><br><br></td></tr>
56<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z420_1">~DocumentHandler</a> ()</td></tr>
57<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z420_1">More...</a><em></em></font><br><br></td></tr>
58<tr><td colspan="2"><div class="groupHeader">The virtual document handler interface</div></td></tr>
59<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z421_0">characters</a> (const XMLCh *const chars, const unsigned int length)=0</td></tr>
60<tr><td>&nbsp;</td><td><font size=-1><em>Receive notification of character data.</em> <a href="#z421_0">More...</a><em></em></font><br><br></td></tr>
61<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z421_1">endDocument</a> ()=0</td></tr>
62<tr><td>&nbsp;</td><td><font size=-1><em>Receive notification of the end of a document.</em> <a href="#z421_1">More...</a><em></em></font><br><br></td></tr>
63<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z421_2">endElement</a> (const XMLCh *const name)=0</td></tr>
64<tr><td>&nbsp;</td><td><font size=-1><em>Receive notification of the end of an element.</em> <a href="#z421_2">More...</a><em></em></font><br><br></td></tr>
65<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z421_3">ignorableWhitespace</a> (const XMLCh *const chars, const unsigned int length)=0</td></tr>
66<tr><td>&nbsp;</td><td><font size=-1><em>Receive notification of ignorable whitespace in element content.</em> <a href="#z421_3">More...</a><em></em></font><br><br></td></tr>
67<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z421_4">processingInstruction</a> (const XMLCh *const target, const XMLCh *const data)=0</td></tr>
68<tr><td>&nbsp;</td><td><font size=-1><em>Receive notification of a processing instruction.</em> <a href="#z421_4">More...</a><em></em></font><br><br></td></tr>
69<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z421_5">resetDocument</a> ()=0</td></tr>
70<tr><td>&nbsp;</td><td><font size=-1><em>Reset the Docuemnt object on its reuse.</em> <a href="#z421_5">More...</a><em></em></font><br><br></td></tr>
71<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z421_6">setDocumentLocator</a> (const <a class="el" href="classLocator.html">Locator</a> *const locator)=0</td></tr>
72<tr><td>&nbsp;</td><td><font size=-1><em>Receive an object for locating the origin of SAX document events.</em> <a href="#z421_6">More...</a><em></em></font><br><br></td></tr>
73<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z421_7">startDocument</a> ()=0</td></tr>
74<tr><td>&nbsp;</td><td><font size=-1><em>Receive notification of the beginning of a document.</em> <a href="#z421_7">More...</a><em></em></font><br><br></td></tr>
75<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDocumentHandler.html#z421_8">startElement</a> (const XMLCh *const name, <a class="el" href="classAttributeList.html">AttributeList</a> &amp;attrs)=0</td></tr>
76<tr><td>&nbsp;</td><td><font size=-1><em>Receive notification of the beginning of an element.</em> <a href="#z421_8">More...</a><em></em></font><br><br></td></tr>
77</table>
78<hr><a name="_details"></a><h2>Detailed Description</h2>
79Receive notification of general document events.
80<p>
81
82<p>
83This is the main interface that most SAX applications implement: if the application needs to be informed of basic parsing events, it implements this interface and registers an instance with the SAX parser using the setDocumentHandler method. The parser uses the instance to report basic document-related events like the start and end of elements and character data.
84<p>
85
86<p>
87The order of events in this interface is very important, and mirrors the order of information in the document itself. For example, all of an element's content (character data, processing instructions, and/or subelements) will appear, in order, between the startElement event and the corresponding endElement event.
88<p>
89
90<p>
91Application writers who do not want to implement the entire interface while can derive a class from <a class="el" href="classHandlerBase.html">HandlerBase</a>, which implements the default functionality; parser writers can instantiate <a class="el" href="classHandlerBase.html">HandlerBase</a> to obtain a default handler. The application can find the location of any document event using the <a class="el" href="classLocator.html">Locator</a> interface supplied by the <a class="el" href="classParser.html">Parser</a> through the setDocumentLocator method.
92<p>
93<dl compact><dt><b>
94See also: </b><dd>
95<a class="el" href="classParser.html#z441_2">Parser::setDocumentHandler</a> , <a class="el" href="classLocator.html#z438_0">Locator::Locator</a> , <a class="el" href="classHandlerBase.html#a0">HandlerBase::HandlerBase</a> </dl>
96<p>
97<hr><h2>Constructor &amp; Destructor Documentation</h2>
98<a name="z420_0" doxytag="DocumentHandler::DocumentHandler"></a><p>
99<table width="100%" cellpadding="2" cellspacing="0" border="0">
100  <tr>
101    <td class="md">
102      <table cellpadding="0" cellspacing="0" border="0">
103        <tr>
104          <td class="md" nowrap valign="top"> DocumentHandler::DocumentHandler </td>
105          <td class="md" valign="top">(&nbsp;</td>
106          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
107          <td class="md" valign="top">)&nbsp;</td>
108          <td class="md" nowrap></td>
109        </tr>
110
111      </table>
112    </td>
113  </tr>
114</table>
115<table cellspacing=5 cellpadding=0 border=0>
116  <tr>
117    <td>
118      &nbsp;
119    </td>
120    <td>
121
122<p>
123Default constructor.
124<p>
125    </td>
126  </tr>
127</table>
128<a name="z420_1" doxytag="DocumentHandler::~DocumentHandler"></a><p>
129<table width="100%" cellpadding="2" cellspacing="0" border="0">
130  <tr>
131    <td class="md">
132      <table cellpadding="0" cellspacing="0" border="0">
133        <tr>
134          <td class="md" nowrap valign="top"> virtual DocumentHandler::~DocumentHandler </td>
135          <td class="md" valign="top">(&nbsp;</td>
136          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
137          <td class="md" valign="top">)&nbsp;</td>
138          <td class="md" nowrap><code> [virtual]</code></td>
139        </tr>
140
141      </table>
142    </td>
143  </tr>
144</table>
145<table cellspacing=5 cellpadding=0 border=0>
146  <tr>
147    <td>
148      &nbsp;
149    </td>
150    <td>
151
152<p>
153Destructor.
154<p>
155    </td>
156  </tr>
157</table>
158<hr><h2>Member Function Documentation</h2>
159<a name="z421_0" doxytag="DocumentHandler::characters"></a><p>
160<table width="100%" cellpadding="2" cellspacing="0" border="0">
161  <tr>
162    <td class="md">
163      <table cellpadding="0" cellspacing="0" border="0">
164        <tr>
165          <td class="md" nowrap valign="top"> virtual void DocumentHandler::characters </td>
166          <td class="md" valign="top">(&nbsp;</td>
167          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
168          <td class="mdname" nowrap>&nbsp; <em>chars</em>, </td>
169        </tr>
170        <tr>
171          <td></td>
172          <td></td>
173          <td class="md" nowrap>const unsigned int&nbsp;</td>
174          <td class="mdname" nowrap>&nbsp; <em>length</em></td>
175        </tr>
176        <tr>
177          <td></td>
178          <td class="md">)&nbsp;</td>
179          <td class="md" colspan="2"><code> [pure virtual]</code></td>
180        </tr>
181
182      </table>
183    </td>
184  </tr>
185</table>
186<table cellspacing=5 cellpadding=0 border=0>
187  <tr>
188    <td>
189      &nbsp;
190    </td>
191    <td>
192
193<p>
194Receive notification of character data.
195<p>
196
197<p>
198The <a class="el" href="classParser.html">Parser</a> 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 <a class="el" href="classLocator.html">Locator</a> provides useful information.
199<p>
200
201<p>
202The application must not attempt to read from the array outside of the specified range.
203<p>
204
205<p>
206Note that some parsers will report whitespace using the <a class="el" href="classDocumentHandler.html#z421_3">ignorableWhitespace</a>() method rather than this one (validating parsers must do so).<dl compact><dt><b>
207Parameters: </b><dd>
208<table border=0 cellspacing=2 cellpadding=0>
209<tr><td valign=top><em>chars</em>&nbsp;</td><td>
210The characters from the XML document. </td></tr>
211<tr><td valign=top><em>length</em>&nbsp;</td><td>
212The number of characters to read from the array. </td></tr>
213</table>
214</dl><dl compact><dt><b>
215Exceptions: </b><dd>
216<table border=0 cellspacing=2 cellpadding=0>
217<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
218 Any SAX exception, possibly wrapping another exception. </td></tr>
219</table>
220</dl><dl compact><dt><b>
221See also: </b><dd>
222<a class="el" href="classDocumentHandler.html#z421_3">ignorableWhitespace</a> , <a class="el" href="classLocator.html#z438_0">Locator::Locator</a> </dl>
223<p>
224Implemented in <a class="el" href="classHandlerBase.html#z428_0">HandlerBase</a>.    </td>
225  </tr>
226</table>
227<a name="z421_1" doxytag="DocumentHandler::endDocument"></a><p>
228<table width="100%" cellpadding="2" cellspacing="0" border="0">
229  <tr>
230    <td class="md">
231      <table cellpadding="0" cellspacing="0" border="0">
232        <tr>
233          <td class="md" nowrap valign="top"> virtual void DocumentHandler::endDocument </td>
234          <td class="md" valign="top">(&nbsp;</td>
235          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
236          <td class="md" valign="top">)&nbsp;</td>
237          <td class="md" nowrap><code> [pure virtual]</code></td>
238        </tr>
239
240      </table>
241    </td>
242  </tr>
243</table>
244<table cellspacing=5 cellpadding=0 border=0>
245  <tr>
246    <td>
247      &nbsp;
248    </td>
249    <td>
250
251<p>
252Receive notification of the end of a document.
253<p>
254
255<p>
256The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.<dl compact><dt><b>
257Exceptions: </b><dd>
258<table border=0 cellspacing=2 cellpadding=0>
259<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
260 Any SAX exception, possibly wrapping another exception. </td></tr>
261</table>
262</dl>
263<p>
264Implemented in <a class="el" href="classHandlerBase.html#z428_1">HandlerBase</a>.    </td>
265  </tr>
266</table>
267<a name="z421_2" doxytag="DocumentHandler::endElement"></a><p>
268<table width="100%" cellpadding="2" cellspacing="0" border="0">
269  <tr>
270    <td class="md">
271      <table cellpadding="0" cellspacing="0" border="0">
272        <tr>
273          <td class="md" nowrap valign="top"> virtual void DocumentHandler::endElement </td>
274          <td class="md" valign="top">(&nbsp;</td>
275          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
276          <td class="mdname1" valign="top" nowrap>&nbsp; <em>name</em>          </td>
277          <td class="md" valign="top">)&nbsp;</td>
278          <td class="md" nowrap><code> [pure virtual]</code></td>
279        </tr>
280
281      </table>
282    </td>
283  </tr>
284</table>
285<table cellspacing=5 cellpadding=0 border=0>
286  <tr>
287    <td>
288      &nbsp;
289    </td>
290    <td>
291
292<p>
293Receive notification of the end of an element.
294<p>
295
296<p>
297The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding <a class="el" href="classDocumentHandler.html#z421_8">startElement</a>() event for every <a class="el" href="classDocumentHandler.html#z421_2">endElement</a>() event (even when the element is empty).
298<p>
299
300<p>
301If the element name has a namespace prefix, the prefix will still be attached to the name.<dl compact><dt><b>
302Parameters: </b><dd>
303<table border=0 cellspacing=2 cellpadding=0>
304<tr><td valign=top><em>name</em>&nbsp;</td><td>
305The element type name </td></tr>
306</table>
307</dl><dl compact><dt><b>
308Exceptions: </b><dd>
309<table border=0 cellspacing=2 cellpadding=0>
310<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
311 Any SAX exception, possibly wrapping another exception. </td></tr>
312</table>
313</dl>
314<p>
315Implemented in <a class="el" href="classHandlerBase.html#z428_2">HandlerBase</a>.    </td>
316  </tr>
317</table>
318<a name="z421_3" doxytag="DocumentHandler::ignorableWhitespace"></a><p>
319<table width="100%" cellpadding="2" cellspacing="0" border="0">
320  <tr>
321    <td class="md">
322      <table cellpadding="0" cellspacing="0" border="0">
323        <tr>
324          <td class="md" nowrap valign="top"> virtual void DocumentHandler::ignorableWhitespace </td>
325          <td class="md" valign="top">(&nbsp;</td>
326          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
327          <td class="mdname" nowrap>&nbsp; <em>chars</em>, </td>
328        </tr>
329        <tr>
330          <td></td>
331          <td></td>
332          <td class="md" nowrap>const unsigned int&nbsp;</td>
333          <td class="mdname" nowrap>&nbsp; <em>length</em></td>
334        </tr>
335        <tr>
336          <td></td>
337          <td class="md">)&nbsp;</td>
338          <td class="md" colspan="2"><code> [pure virtual]</code></td>
339        </tr>
340
341      </table>
342    </td>
343  </tr>
344</table>
345<table cellspacing=5 cellpadding=0 border=0>
346  <tr>
347    <td>
348      &nbsp;
349    </td>
350    <td>
351
352<p>
353Receive notification of ignorable whitespace in element content.
354<p>
355
356<p>
357Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.
358<p>
359
360<p>
361SAX parsers may return all contiguous whitespace 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 <a class="el" href="classLocator.html">Locator</a> provides useful information.
362<p>
363
364<p>
365The application must not attempt to read from the array outside of the specified range.<dl compact><dt><b>
366Parameters: </b><dd>
367<table border=0 cellspacing=2 cellpadding=0>
368<tr><td valign=top><em>chars</em>&nbsp;</td><td>
369The characters from the XML document. </td></tr>
370<tr><td valign=top><em>length</em>&nbsp;</td><td>
371The number of characters to read from the array. </td></tr>
372</table>
373</dl><dl compact><dt><b>
374Exceptions: </b><dd>
375<table border=0 cellspacing=2 cellpadding=0>
376<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
377 Any SAX exception, possibly wrapping another exception. </td></tr>
378</table>
379</dl><dl compact><dt><b>
380See also: </b><dd>
381<a class="el" href="classDocumentHandler.html#z421_0">characters</a> </dl>
382<p>
383Implemented in <a class="el" href="classHandlerBase.html#z428_3">HandlerBase</a>.    </td>
384  </tr>
385</table>
386<a name="z421_4" doxytag="DocumentHandler::processingInstruction"></a><p>
387<table width="100%" cellpadding="2" cellspacing="0" border="0">
388  <tr>
389    <td class="md">
390      <table cellpadding="0" cellspacing="0" border="0">
391        <tr>
392          <td class="md" nowrap valign="top"> virtual void DocumentHandler::processingInstruction </td>
393          <td class="md" valign="top">(&nbsp;</td>
394          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
395          <td class="mdname" nowrap>&nbsp; <em>target</em>, </td>
396        </tr>
397        <tr>
398          <td></td>
399          <td></td>
400          <td class="md" nowrap>const XMLCh *const&nbsp;</td>
401          <td class="mdname" nowrap>&nbsp; <em>data</em></td>
402        </tr>
403        <tr>
404          <td></td>
405          <td class="md">)&nbsp;</td>
406          <td class="md" colspan="2"><code> [pure virtual]</code></td>
407        </tr>
408
409      </table>
410    </td>
411  </tr>
412</table>
413<table cellspacing=5 cellpadding=0 border=0>
414  <tr>
415    <td>
416      &nbsp;
417    </td>
418    <td>
419
420<p>
421Receive notification of a processing instruction.
422<p>
423
424<p>
425The <a class="el" href="classParser.html">Parser</a> will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.
426<p>
427
428<p>
429A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.<dl compact><dt><b>
430Parameters: </b><dd>
431<table border=0 cellspacing=2 cellpadding=0>
432<tr><td valign=top><em>target</em>&nbsp;</td><td>
433The processing instruction target. </td></tr>
434<tr><td valign=top><em>data</em>&nbsp;</td><td>
435The processing instruction data, or null if none was supplied. </td></tr>
436</table>
437</dl><dl compact><dt><b>
438Exceptions: </b><dd>
439<table border=0 cellspacing=2 cellpadding=0>
440<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
441 Any SAX exception, possibly wrapping another exception. </td></tr>
442</table>
443</dl>
444<p>
445Implemented in <a class="el" href="classHandlerBase.html#z428_4">HandlerBase</a>.    </td>
446  </tr>
447</table>
448<a name="z421_5" doxytag="DocumentHandler::resetDocument"></a><p>
449<table width="100%" cellpadding="2" cellspacing="0" border="0">
450  <tr>
451    <td class="md">
452      <table cellpadding="0" cellspacing="0" border="0">
453        <tr>
454          <td class="md" nowrap valign="top"> virtual void DocumentHandler::resetDocument </td>
455          <td class="md" valign="top">(&nbsp;</td>
456          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
457          <td class="md" valign="top">)&nbsp;</td>
458          <td class="md" nowrap><code> [pure virtual]</code></td>
459        </tr>
460
461      </table>
462    </td>
463  </tr>
464</table>
465<table cellspacing=5 cellpadding=0 border=0>
466  <tr>
467    <td>
468      &nbsp;
469    </td>
470    <td>
471
472<p>
473Reset the Docuemnt object on its reuse.
474<p>
475
476<p>
477This method helps in reseting the document implementational defaults each time the document is begun.
478<p>
479Implemented in <a class="el" href="classHandlerBase.html#z428_5">HandlerBase</a>.    </td>
480  </tr>
481</table>
482<a name="z421_6" doxytag="DocumentHandler::setDocumentLocator"></a><p>
483<table width="100%" cellpadding="2" cellspacing="0" border="0">
484  <tr>
485    <td class="md">
486      <table cellpadding="0" cellspacing="0" border="0">
487        <tr>
488          <td class="md" nowrap valign="top"> virtual void DocumentHandler::setDocumentLocator </td>
489          <td class="md" valign="top">(&nbsp;</td>
490          <td class="md" nowrap valign="top">const <a class="el" href="classLocator.html">Locator</a> *const&nbsp;</td>
491          <td class="mdname1" valign="top" nowrap>&nbsp; <em>locator</em>          </td>
492          <td class="md" valign="top">)&nbsp;</td>
493          <td class="md" nowrap><code> [pure virtual]</code></td>
494        </tr>
495
496      </table>
497    </td>
498  </tr>
499</table>
500<table cellspacing=5 cellpadding=0 border=0>
501  <tr>
502    <td>
503      &nbsp;
504    </td>
505    <td>
506
507<p>
508Receive an object for locating the origin of SAX document events.
509<p>
510SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.
511<p>
512The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.
513<p>
514Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.<dl compact><dt><b>
515Parameters: </b><dd>
516<table border=0 cellspacing=2 cellpadding=0>
517<tr><td valign=top><em>locator</em>&nbsp;</td><td>
518An object that can return the location of any SAX document event. The object is only 'on loan' to the client code and they are not to attempt to delete or modify it in any way!</td></tr>
519</table>
520</dl><dl compact><dt><b>
521See also: </b><dd>
522<a class="el" href="classLocator.html#z438_0">Locator::Locator</a> </dl>
523<p>
524Implemented in <a class="el" href="classHandlerBase.html#z429_0">HandlerBase</a>.    </td>
525  </tr>
526</table>
527<a name="z421_7" doxytag="DocumentHandler::startDocument"></a><p>
528<table width="100%" cellpadding="2" cellspacing="0" border="0">
529  <tr>
530    <td class="md">
531      <table cellpadding="0" cellspacing="0" border="0">
532        <tr>
533          <td class="md" nowrap valign="top"> virtual void DocumentHandler::startDocument </td>
534          <td class="md" valign="top">(&nbsp;</td>
535          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
536          <td class="md" valign="top">)&nbsp;</td>
537          <td class="md" nowrap><code> [pure virtual]</code></td>
538        </tr>
539
540      </table>
541    </td>
542  </tr>
543</table>
544<table cellspacing=5 cellpadding=0 border=0>
545  <tr>
546    <td>
547      &nbsp;
548    </td>
549    <td>
550
551<p>
552Receive notification of the beginning of a document.
553<p>
554
555<p>
556The SAX parser will invoke this method only once, before any other methods in this interface or in <a class="el" href="classDTDHandler.html">DTDHandler</a> (except for setDocumentLocator).<dl compact><dt><b>
557Exceptions: </b><dd>
558<table border=0 cellspacing=2 cellpadding=0>
559<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
560 Any SAX exception, possibly wrapping another exception. </td></tr>
561</table>
562</dl>
563<p>
564Implemented in <a class="el" href="classHandlerBase.html#z429_1">HandlerBase</a>.    </td>
565  </tr>
566</table>
567<a name="z421_8" doxytag="DocumentHandler::startElement"></a><p>
568<table width="100%" cellpadding="2" cellspacing="0" border="0">
569  <tr>
570    <td class="md">
571      <table cellpadding="0" cellspacing="0" border="0">
572        <tr>
573          <td class="md" nowrap valign="top"> virtual void DocumentHandler::startElement </td>
574          <td class="md" valign="top">(&nbsp;</td>
575          <td class="md" nowrap valign="top">const XMLCh *const&nbsp;</td>
576          <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
577        </tr>
578        <tr>
579          <td></td>
580          <td></td>
581          <td class="md" nowrap><a class="el" href="classAttributeList.html">AttributeList</a> &amp;&nbsp;</td>
582          <td class="mdname" nowrap>&nbsp; <em>attrs</em></td>
583        </tr>
584        <tr>
585          <td></td>
586          <td class="md">)&nbsp;</td>
587          <td class="md" colspan="2"><code> [pure virtual]</code></td>
588        </tr>
589
590      </table>
591    </td>
592  </tr>
593</table>
594<table cellspacing=5 cellpadding=0 border=0>
595  <tr>
596    <td>
597      &nbsp;
598    </td>
599    <td>
600
601<p>
602Receive notification of the beginning of an element.
603<p>
604
605<p>
606The <a class="el" href="classParser.html">Parser</a> will invoke this method at the beginning of every element in the XML document; there will be a corresponding <a class="el" href="classDocumentHandler.html#z421_2">endElement</a>() event for every <a class="el" href="classDocumentHandler.html#z421_8">startElement</a>() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding <a class="el" href="classDocumentHandler.html#z421_2">endElement</a>() event.
607<p>
608
609<p>
610If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): IMPLIED attributes will be omitted.<dl compact><dt><b>
611Parameters: </b><dd>
612<table border=0 cellspacing=2 cellpadding=0>
613<tr><td valign=top><em>name</em>&nbsp;</td><td>
614The element type name. </td></tr>
615<tr><td valign=top><em>attrs</em>&nbsp;</td><td>
616The attributes attached to the element, if any. </td></tr>
617</table>
618</dl><dl compact><dt><b>
619Exceptions: </b><dd>
620<table border=0 cellspacing=2 cellpadding=0>
621<tr><td valign=top><em><a class="el" href="classSAXException.html">SAXException</a></em>&nbsp;</td><td>
622 Any SAX exception, possibly wrapping another exception. </td></tr>
623</table>
624</dl><dl compact><dt><b>
625See also: </b><dd>
626<a class="el" href="classDocumentHandler.html#z421_2">endElement</a> , <a class="el" href="classAttributeList.html#z418_0">AttributeList::AttributeList</a> </dl>
627<p>
628Implemented in <a class="el" href="classHandlerBase.html#z429_2">HandlerBase</a>.    </td>
629  </tr>
630</table>
631<hr>The documentation for this class was generated from the following file:<ul>
632<li><a class="el" href="DocumentHandler_8hpp-source.html">DocumentHandler.hpp</a></ul>
633    </FONT></TD></TR></TABLE><BR>
634</TD></TR></TABLE></TD></TR></TABLE><BR><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD bgcolor="#0086b2"><IMG height="1" src="images/dot.gif" width="1" alt=""></TD></TR><TR><TD align="center"><FONT color="#0086b2" size="-1"><I>
635              Copyright &copy; 1994-2004 The Apache Software Foundation.
636              All Rights Reserved.
637            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.