PageRenderTime 44ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/www/tags/NOV_07_2009/htdocs/api/com/microstar/xml/XmlHandler.html

#
HTML | 606 lines | 542 code | 54 blank | 10 comment | 0 complexity | 2ca704ffe151cd0479e8985c7d798cf7 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0 
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!--NewPage-->
    3. 

  3. <HTML>
    4. 

  4. <HEAD>
    5. 

  5. <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:13:42 GMT-08:00 2008 -->
    6. 

  6. <TITLE>
    7. 

  7. XmlHandler (jEdit API)
    8. 

  8. </TITLE>
    9. 

  9. 

  10. <META NAME="keywords" CONTENT="com.microstar.xml.XmlHandler interface">
    11. 

  11. 

  12. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
    13. 

  13. 

  14. 

  15. <NOSCRIPT>
    16. 

  16. </NOSCRIPT>
    17. 

  17. 

  18. </HEAD>
    19. 

  19. 

  20. <BODY BGCOLOR="white" >
    21. 

  21. 

  22. 

  23. <!-- ========= START OF TOP NAVBAR ======= -->
    24. 

  24. <A NAME="navbar_top"><!-- --></A>
    25. 

  25. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
    26. 

  26. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    27. 

  27. <TR>
    28. 

  28. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    29. 

  29. <A NAME="navbar_top_firstrow"><!-- --></A>
    30. 

  30. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    31. 

  31.   <TR ALIGN="center" VALIGN="top">
    32. 

  32.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    33. 

  33.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    34. 

  34.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    35. 

  35.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/XmlHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    36. 

  36.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    37. 

  37.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    38. 

  38.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    39. 

  39.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    40. 

  40.   </TR>
    41. 

  41. </TABLE>
    42. 

  42. </TD>
    43. 

  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    44. 

  44. </EM>
    45. 

  45. </TD>
    46. 

  46. </TR>
    47. 

  47. 

  48. <TR>
    49. 

  49. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    50. 

  50. &nbsp;<A HREF="../../../com/microstar/xml/XmlException.html" title="class in com.microstar.xml"><B>PREV CLASS</B></A>&nbsp;
    51. 

  51. &nbsp;<A HREF="../../../com/microstar/xml/XmlParser.html" title="class in com.microstar.xml"><B>NEXT CLASS</B></A></FONT></TD>
    52. 

  52. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    53. 

  53.   <A HREF="../../../index.html?com/microstar/xml/XmlHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    54. 

  54. &nbsp;<A HREF="XmlHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    55. 

  55. &nbsp;
    56. 

  56. <NOSCRIPT>
    57. 

  57.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
    58. 

  58. </NOSCRIPT>
    59. 

  59. 

  60. 

  61. </FONT></TD>
    62. 

  62. </TR>
    63. 

  63. <TR>
    64. 

  64. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    65. 

  65.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    66. 

  66. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    67. 

  67. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    68. 

  68. </TR>
    69. 

  69. </TABLE>
    70. 

  70. <A NAME="skip-navbar_top"></A>
    71. 

  71. <!-- ========= END OF TOP NAVBAR ========= -->
    72. 

  72. 

  73. <HR>
    74. 

  74. <!-- ======== START OF CLASS DATA ======== -->
    75. 

  75. <H2>
    76. 

  76. <FONT SIZE="-1">
    77. 

  77. com.microstar.xml</FONT>
    78. 

  78. <BR>
    79. 

  79. Interface XmlHandler</H2>
    80. 

  80. <DL>
    81. 

  81. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/microstar/xml/HandlerBase.html" title="class in com.microstar.xml">HandlerBase</A></DD>
    82. 

  82. </DL>
    83. 

  83. <HR>
    84. 

  84. <B>Deprecated.</B>
    85. 

  85. <P>
    86. 

  86. <DL>
    87. 

  87. <DT><PRE>public interface <B>XmlHandler</B></DL>
    88. 

  88. </PRE>
    89. 

  89. 

  90. <P>
    91. 

  91. XML Processing Interface.
    92. 

  92.  <p>Whenever you parse an XML document, you must provide an object
    93. 

  93.  from a class that implements this interface to receive the parsing 
    94. 

  94.  events.
    95. 

  95.  <p>If you do not want to implement this entire interface, you
    96. 

  96.  can extend the <code>HandlerBase</code> convenience class and
    97. 

  97.  then implement only what you need.
    98. 

  98.  <p>If you are using SAX, you should implement the SAX handler
    99. 

  99.  interfaces rather than this one.
    100. 

  100. <P>
    101. 

  101. 

  102. <P>
    103. 

  103. <DL>
    104. 

  104. <DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlParser.html" title="class in com.microstar.xml"><CODE>XmlParser</CODE></A>, 
    105. 

  105. <A HREF="../../../com/microstar/xml/HandlerBase.html" title="class in com.microstar.xml"><CODE>HandlerBase</CODE></A>, 
    106. 

  106. <CODE>org.xml.sax.EntityHandler</CODE>, 
    107. 

  107. <CODE>DocumentHandler</CODE>, 
    108. 

  108. <CODE>ErrorHandler</CODE></DL>
    109. 

  109. <HR>
    110. 

  110. 

  111. <P>
    112. 

  112. 

  113. <!-- ========== METHOD SUMMARY =========== -->
    114. 

  114. 

  115. <A NAME="method_summary"><!-- --></A>
    116. 

  116. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    117. 

  117. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    118. 

  118. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    119. 

  119. <B>Method Summary</B></FONT></TH>
    120. 

  120. </TR>
    121. 

  121. <TR BGCOLOR="white" CLASS="TableRowColor">
    122. 

  122. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    123. 

  123. <CODE>&nbsp;void</CODE></FONT></TD>
    124. 

  124. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#attribute(java.lang.String, java.lang.String, boolean)">attribute</A></B>(java.lang.String&nbsp;aname,
    125. 

  125.           java.lang.String&nbsp;value,
    126. 

  126.           boolean&nbsp;isSpecified)</CODE>
    127. 

  127. 

  128. <BR>
    129. 

  129. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Attribute.</TD>
    130. 

  130. </TR>
    131. 

  131. <TR BGCOLOR="white" CLASS="TableRowColor">
    132. 

  132. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    133. 

  133. <CODE>&nbsp;void</CODE></FONT></TD>
    134. 

  134. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#charData(char[], int, int)">charData</A></B>(char[]&nbsp;ch,
    135. 

  135.          int&nbsp;start,
    136. 

  136.          int&nbsp;length)</CODE>
    137. 

  137. 

  138. <BR>
    139. 

  139. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Character data.</TD>
    140. 

  140. </TR>
    141. 

  141. <TR BGCOLOR="white" CLASS="TableRowColor">
    142. 

  142. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    143. 

  143. <CODE>&nbsp;void</CODE></FONT></TD>
    144. 

  144. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#doctypeDecl(java.lang.String, java.lang.String, java.lang.String)">doctypeDecl</A></B>(java.lang.String&nbsp;name,
    145. 

  145.             java.lang.String&nbsp;publicId,
    146. 

  146.             java.lang.String&nbsp;systemId)</CODE>
    147. 

  147. 

  148. <BR>
    149. 

  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Document type declaration.</TD>
    150. 

  150. </TR>
    151. 

  151. <TR BGCOLOR="white" CLASS="TableRowColor">
    152. 

  152. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    153. 

  153. <CODE>&nbsp;void</CODE></FONT></TD>
    154. 

  154. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#endDocument()">endDocument</A></B>()</CODE>
    155. 

  155. 

  156. <BR>
    157. 

  157. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;End the document.</TD>
    158. 

  158. </TR>
    159. 

  159. <TR BGCOLOR="white" CLASS="TableRowColor">
    160. 

  160. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    161. 

  161. <CODE>&nbsp;void</CODE></FONT></TD>
    162. 

  162. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#endElement(java.lang.String)">endElement</A></B>(java.lang.String&nbsp;elname)</CODE>
    163. 

  163. 

  164. <BR>
    165. 

  165. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;End an element.</TD>
    166. 

  166. </TR>
    167. 

  167. <TR BGCOLOR="white" CLASS="TableRowColor">
    168. 

  168. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    169. 

  169. <CODE>&nbsp;void</CODE></FONT></TD>
    170. 

  170. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#endExternalEntity(java.lang.String)">endExternalEntity</A></B>(java.lang.String&nbsp;systemId)</CODE>
    171. 

  171. 

  172. <BR>
    173. 

  173. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;End an external entity.</TD>
    174. 

  174. </TR>
    175. 

  175. <TR BGCOLOR="white" CLASS="TableRowColor">
    176. 

  176. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    177. 

  177. <CODE>&nbsp;void</CODE></FONT></TD>
    178. 

  178. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#error(java.lang.String, java.lang.String, int, int)">error</A></B>(java.lang.String&nbsp;message,
    179. 

  179.       java.lang.String&nbsp;systemId,
    180. 

  180.       int&nbsp;line,
    181. 

  181.       int&nbsp;column)</CODE>
    182. 

  182. 

  183. <BR>
    184. 

  184. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Fatal XML parsing error.</TD>
    185. 

  185. </TR>
    186. 

  186. <TR BGCOLOR="white" CLASS="TableRowColor">
    187. 

  187. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    188. 

  188. <CODE>&nbsp;void</CODE></FONT></TD>
    189. 

  189. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#ignorableWhitespace(char[], int, int)">ignorableWhitespace</A></B>(char[]&nbsp;ch,
    190. 

  190.                     int&nbsp;start,
    191. 

  191.                     int&nbsp;length)</CODE>
    192. 

  192. 

  193. <BR>
    194. 

  194. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Ignorable whitespace.</TD>
    195. 

  195. </TR>
    196. 

  196. <TR BGCOLOR="white" CLASS="TableRowColor">
    197. 

  197. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    198. 

  198. <CODE>&nbsp;void</CODE></FONT></TD>
    199. 

  199. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#processingInstruction(java.lang.String, java.lang.String)">processingInstruction</A></B>(java.lang.String&nbsp;target,
    200. 

  200.                       java.lang.String&nbsp;data)</CODE>
    201. 

  201. 

  202. <BR>
    203. 

  203. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Processing instruction.</TD>
    204. 

  204. </TR>
    205. 

  205. <TR BGCOLOR="white" CLASS="TableRowColor">
    206. 

  206. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    207. 

  207. <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
    208. 

  208. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#resolveEntity(java.lang.String, java.lang.String)">resolveEntity</A></B>(java.lang.String&nbsp;publicId,
    209. 

  209.               java.lang.String&nbsp;systemId)</CODE>
    210. 

  210. 

  211. <BR>
    212. 

  212. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Resolve an External Entity.</TD>
    213. 

  213. </TR>
    214. 

  214. <TR BGCOLOR="white" CLASS="TableRowColor">
    215. 

  215. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    216. 

  216. <CODE>&nbsp;void</CODE></FONT></TD>
    217. 

  217. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#startDocument()">startDocument</A></B>()</CODE>
    218. 

  218. 

  219. <BR>
    220. 

  220. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Start the document.</TD>
    221. 

  221. </TR>
    222. 

  222. <TR BGCOLOR="white" CLASS="TableRowColor">
    223. 

  223. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    224. 

  224. <CODE>&nbsp;void</CODE></FONT></TD>
    225. 

  225. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#startElement(java.lang.String)">startElement</A></B>(java.lang.String&nbsp;elname)</CODE>
    226. 

  226. 

  227. <BR>
    228. 

  228. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Start an element.</TD>
    229. 

  229. </TR>
    230. 

  230. <TR BGCOLOR="white" CLASS="TableRowColor">
    231. 

  231. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    232. 

  232. <CODE>&nbsp;void</CODE></FONT></TD>
    233. 

  233. <TD><CODE><B><A HREF="../../../com/microstar/xml/XmlHandler.html#startExternalEntity(java.lang.String)">startExternalEntity</A></B>(java.lang.String&nbsp;systemId)</CODE>
    234. 

  234. 

  235. <BR>
    236. 

  236. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;Begin an external entity.</TD>
    237. 

  237. </TR>
    238. 

  238. </TABLE>
    239. 

  239. &nbsp;
    240. 

  240. <P>
    241. 

  241. 

  242. <!-- ============ METHOD DETAIL ========== -->
    243. 

  243. 

  244. <A NAME="method_detail"><!-- --></A>
    245. 

  245. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    246. 

  246. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    247. 

  247. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    248. 

  248. <B>Method Detail</B></FONT></TH>
    249. 

  249. </TR>
    250. 

  250. </TABLE>
    251. 

  251. 

  252. <A NAME="startDocument()"><!-- --></A><H3>
    253. 

  253. startDocument</H3>
    254. 

  254. <PRE>
    255. 

  255. void <B>startDocument</B>()
    256. 

  256.                    throws java.lang.Exception</PRE>
    257. 

  257. <DL>
    258. 

  258. <DD><B>Deprecated.</B>&nbsp;<DD>Start the document.
    259. 

  259.  <p>&AElig;lfred will call this method just before it
    260. 

  260.  attempts to read the first entity (the root of the document).
    261. 

  261.  It is guaranteed that this will be the first method called.
    262. 

  262. <P>
    263. 

  263. <DD><DL>
    264. 

  264. 

  265. <DT><B>Throws:</B>
    266. 

  266. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.<DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlHandler.html#endDocument()"><CODE>endDocument()</CODE></A></DL>
    267. 

  267. </DD>
    268. 

  268. </DL>
    269. 

  269. <HR>
    270. 

  270. 

  271. <A NAME="endDocument()"><!-- --></A><H3>
    272. 

  272. endDocument</H3>
    273. 

  273. <PRE>
    274. 

  274. void <B>endDocument</B>()
    275. 

  275.                  throws java.lang.Exception</PRE>
    276. 

  276. <DL>
    277. 

  277. <DD><B>Deprecated.</B>&nbsp;<DD>End the document.
    278. 

  278.  <p>&AElig;lfred will call this method once, when it has
    279. 

  279.  finished parsing the XML document.
    280. 

  280.  It is guaranteed that this will be the last method called.
    281. 

  281. <P>
    282. 

  282. <DD><DL>
    283. 

  283. 

  284. <DT><B>Throws:</B>
    285. 

  285. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.<DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlHandler.html#startDocument()"><CODE>startDocument()</CODE></A></DL>
    286. 

  286. </DD>
    287. 

  287. </DL>
    288. 

  288. <HR>
    289. 

  289. 

  290. <A NAME="resolveEntity(java.lang.String, java.lang.String)"><!-- --></A><H3>
    291. 

  291. resolveEntity</H3>
    292. 

  292. <PRE>
    293. 

  293. java.lang.Object <B>resolveEntity</B>(java.lang.String&nbsp;publicId,
    294. 

  294.                                java.lang.String&nbsp;systemId)
    295. 

  295.                                throws java.lang.Exception</PRE>
    296. 

  296. <DL>
    297. 

  297. <DD><B>Deprecated.</B>&nbsp;<DD>Resolve an External Entity.
    298. 

  298.  <p>Give the handler a chance to redirect external entities
    299. 

  299.  to different URIs.  &AElig;lfred will call this method for the
    300. 

  300.  top-level document entity, for external text (XML) entities, 
    301. 

  301.  and the external DTD subset (if any).
    302. 

  302. <P>
    303. 

  303. <DD><DL>
    304. 

  304. <DT><B>Parameters:</B><DD><CODE>publicId</CODE> - The public identifier, or null if none was supplied.<DD><CODE>systemId</CODE> - The system identifier.
    305. 

  305. <DT><B>Returns:</B><DD>The replacement system identifier, or null to use
    306. 

  306.          the default.
    307. 

  307. <DT><B>Throws:</B>
    308. 

  308. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.<DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlHandler.html#startExternalEntity(java.lang.String)"><CODE>startExternalEntity(java.lang.String)</CODE></A>, 
    309. 

  309. <A HREF="../../../com/microstar/xml/XmlHandler.html#endExternalEntity(java.lang.String)"><CODE>endExternalEntity(java.lang.String)</CODE></A></DL>
    310. 

  310. </DD>
    311. 

  311. </DL>
    312. 

  312. <HR>
    313. 

  313. 

  314. <A NAME="startExternalEntity(java.lang.String)"><!-- --></A><H3>
    315. 

  315. startExternalEntity</H3>
    316. 

  316. <PRE>
    317. 

  317. void <B>startExternalEntity</B>(java.lang.String&nbsp;systemId)
    318. 

  318.                          throws java.lang.Exception</PRE>
    319. 

  319. <DL>
    320. 

  320. <DD><B>Deprecated.</B>&nbsp;<DD>Begin an external entity.
    321. 

  321.  <p>&AElig;lfred will call this method at the beginning of
    322. 

  322.  each external entity, including the top-level document entity
    323. 

  323.  and the external DTD subset (if any).
    324. 

  324.  <p>If necessary, you can use this method to track the location
    325. 

  325.  of the current entity so that you can resolve relative URIs
    326. 

  326.  correctly.
    327. 

  327. <P>
    328. 

  328. <DD><DL>
    329. 

  329. <DT><B>Parameters:</B><DD><CODE>systemId</CODE> - The URI of the external entity that is starting.
    330. 

  330. <DT><B>Throws:</B>
    331. 

  331. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.<DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlHandler.html#endExternalEntity(java.lang.String)"><CODE>endExternalEntity(java.lang.String)</CODE></A>, 
    332. 

  332. <A HREF="../../../com/microstar/xml/XmlHandler.html#resolveEntity(java.lang.String, java.lang.String)"><CODE>resolveEntity(java.lang.String, java.lang.String)</CODE></A></DL>
    333. 

  333. </DD>
    334. 

  334. </DL>
    335. 

  335. <HR>
    336. 

  336. 

  337. <A NAME="endExternalEntity(java.lang.String)"><!-- --></A><H3>
    338. 

  338. endExternalEntity</H3>
    339. 

  339. <PRE>
    340. 

  340. void <B>endExternalEntity</B>(java.lang.String&nbsp;systemId)
    341. 

  341.                        throws java.lang.Exception</PRE>
    342. 

  342. <DL>
    343. 

  343. <DD><B>Deprecated.</B>&nbsp;<DD>End an external entity.
    344. 

  344.  <p>&AElig;lfred will call this method at the end of
    345. 

  345.  each external entity, including the top-level document entity
    346. 

  346.  and the external DTD subset.
    347. 

  347.  <p>If necessary, you can use this method to track the location
    348. 

  348.  of the current entity so that you can resolve relative URIs
    349. 

  349.  correctly.
    350. 

  350. <P>
    351. 

  351. <DD><DL>
    352. 

  352. <DT><B>Parameters:</B><DD><CODE>systemId</CODE> - The URI of the external entity that is ending.
    353. 

  353. <DT><B>Throws:</B>
    354. 

  354. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.<DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlHandler.html#startExternalEntity(java.lang.String)"><CODE>startExternalEntity(java.lang.String)</CODE></A>, 
    355. 

  355. <A HREF="../../../com/microstar/xml/XmlHandler.html#resolveEntity(java.lang.String, java.lang.String)"><CODE>resolveEntity(java.lang.String, java.lang.String)</CODE></A></DL>
    356. 

  356. </DD>
    357. 

  357. </DL>
    358. 

  358. <HR>
    359. 

  359. 

  360. <A NAME="doctypeDecl(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
    361. 

  361. doctypeDecl</H3>
    362. 

  362. <PRE>
    363. 

  363. void <B>doctypeDecl</B>(java.lang.String&nbsp;name,
    364. 

  364.                  java.lang.String&nbsp;publicId,
    365. 

  365.                  java.lang.String&nbsp;systemId)
    366. 

  366.                  throws java.lang.Exception</PRE>
    367. 

  367. <DL>
    368. 

  368. <DD><B>Deprecated.</B>&nbsp;<DD>Document type declaration.
    369. 

  369.  <p>&AElig;lfred will call this method when or if it encounters
    370. 

  370.  the document type (DOCTYPE) declaration.
    371. 

  371.  <p>Please note that the public and system identifiers will
    372. 

  372.  not always be a reliable indication of the DTD in use.
    373. 

  373. <P>
    374. 

  374. <DD><DL>
    375. 

  375. <DT><B>Parameters:</B><DD><CODE>name</CODE> - The document type name.<DD><CODE>publicId</CODE> - The public identifier, or null if unspecified.<DD><CODE>systemId</CODE> - The system identifier, or null if unspecified.
    376. 

  376. <DT><B>Throws:</B>
    377. 

  377. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.</DL>
    378. 

  378. </DD>
    379. 

  379. </DL>
    380. 

  380. <HR>
    381. 

  381. 

  382. <A NAME="attribute(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
    383. 

  383. attribute</H3>
    384. 

  384. <PRE>
    385. 

  385. void <B>attribute</B>(java.lang.String&nbsp;aname,
    386. 

  386.                java.lang.String&nbsp;value,
    387. 

  387.                boolean&nbsp;isSpecified)
    388. 

  388.                throws java.lang.Exception</PRE>
    389. 

  389. <DL>
    390. 

  390. <DD><B>Deprecated.</B>&nbsp;<DD>Attribute.
    391. 

  391.  <p>&AElig;lfred will call this method once for each attribute 
    392. 

  392.  (specified or defaulted) before reporting a startElement event.
    393. 

  393.  It is up to your handler to collect the attributes, if
    394. 

  394.  necessary.
    395. 

  395.  <p>You may use XmlParser.getAttributeType() to find the attribute's
    396. 

  396.  declared type.
    397. 

  397. <P>
    398. 

  398. <DD><DL>
    399. 

  399. <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the attribute.<DD><CODE>type</CODE> - The type of the attribute (see below).<DD><CODE>value</CODE> - The value of the attribute, or null if the attribute
    400. 

  400.         is <code>#IMPLIED</code>.<DD><CODE>isSpecified</CODE> - True if the value was specified, false if it
    401. 

  401.        was defaulted from the DTD.
    402. 

  402. <DT><B>Throws:</B>
    403. 

  403. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.<DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlHandler.html#startElement(java.lang.String)"><CODE>startElement(java.lang.String)</CODE></A>, 
    404. 

  404. <A HREF="../../../com/microstar/xml/XmlParser.html#declaredAttributes(java.lang.String)"><CODE>XmlParser.declaredAttributes(java.lang.String)</CODE></A>, 
    405. 

  405. <A HREF="../../../com/microstar/xml/XmlParser.html#getAttributeType(java.lang.String, java.lang.String)"><CODE>XmlParser.getAttributeType(java.lang.String, java.lang.String)</CODE></A>, 
    406. 

  406. <A HREF="../../../com/microstar/xml/XmlParser.html#getAttributeDefaultValue(java.lang.String, java.lang.String)"><CODE>XmlParser.getAttributeDefaultValue(java.lang.String, java.lang.String)</CODE></A></DL>
    407. 

  407. </DD>
    408. 

  408. </DL>
    409. 

  409. <HR>
    410. 

  410. 

  411. <A NAME="startElement(java.lang.String)"><!-- --></A><H3>
    412. 

  412. startElement</H3>
    413. 

  413. <PRE>
    414. 

  414. void <B>startElement</B>(java.lang.String&nbsp;elname)
    415. 

  415.                   throws java.lang.Exception</PRE>
    416. 

  416. <DL>
    417. 

  417. <DD><B>Deprecated.</B>&nbsp;<DD>Start an element.
    418. 

  418.  <p>&AElig;lfred will call this method at the beginning of each
    419. 

  419.  element.  By the time this is called, all of the attributes
    420. 

  420.  for the element will already have been reported using the
    421. 

  421.  <code>attribute</code> method.
    422. 

  422. <P>
    423. 

  423. <DD><DL>
    424. 

  424. <DT><B>Parameters:</B><DD><CODE>elname</CODE> - The element type name.
    425. 

  425. <DT><B>Throws:</B>
    426. 

  426. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.<DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlHandler.html#attribute(java.lang.String, java.lang.String, boolean)"><CODE>attribute(java.lang.String, java.lang.String, boolean)</CODE></A>, 
    427. 

  427. <A HREF="../../../com/microstar/xml/XmlHandler.html#endElement(java.lang.String)"><CODE>endElement(java.lang.String)</CODE></A>, 
    428. 

  428. <A HREF="../../../com/microstar/xml/XmlParser.html#declaredElements()"><CODE>XmlParser.declaredElements()</CODE></A>, 
    429. 

  429. <A HREF="../../../com/microstar/xml/XmlParser.html#getElementContentType(java.lang.String)"><CODE>XmlParser.getElementContentType(java.lang.String)</CODE></A></DL>
    430. 

  430. </DD>
    431. 

  431. </DL>
    432. 

  432. <HR>
    433. 

  433. 

  434. <A NAME="endElement(java.lang.String)"><!-- --></A><H3>
    435. 

  435. endElement</H3>
    436. 

  436. <PRE>
    437. 

  437. void <B>endElement</B>(java.lang.String&nbsp;elname)
    438. 

  438.                 throws java.lang.Exception</PRE>
    439. 

  439. <DL>
    440. 

  440. <DD><B>Deprecated.</B>&nbsp;<DD>End an element.
    441. 

  441.  <p>&AElig;lfred will call this method at the end of each element
    442. 

  442.  (including EMPTY elements).
    443. 

  443. <P>
    444. 

  444. <DD><DL>
    445. 

  445. <DT><B>Parameters:</B><DD><CODE>elname</CODE> - The element type name.
    446. 

  446. <DT><B>Throws:</B>
    447. 

  447. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.<DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlHandler.html#startElement(java.lang.String)"><CODE>startElement(java.lang.String)</CODE></A>, 
    448. 

  448. <A HREF="../../../com/microstar/xml/XmlParser.html#declaredElements()"><CODE>XmlParser.declaredElements()</CODE></A>, 
    449. 

  449. <A HREF="../../../com/microstar/xml/XmlParser.html#getElementContentType(java.lang.String)"><CODE>XmlParser.getElementContentType(java.lang.String)</CODE></A></DL>
    450. 

  450. </DD>
    451. 

  451. </DL>
    452. 

  452. <HR>
    453. 

  453. 

  454. <A NAME="charData(char[], int, int)"><!-- --></A><H3>
    455. 

  455. charData</H3>
    456. 

  456. <PRE>
    457. 

  457. void <B>charData</B>(char[]&nbsp;ch,
    458. 

  458.               int&nbsp;start,
    459. 

  459.               int&nbsp;length)
    460. 

  460.               throws java.lang.Exception</PRE>
    461. 

  461. <DL>
    462. 

  462. <DD><B>Deprecated.</B>&nbsp;<DD>Character data.
    463. 

  463.  <p>&AElig;lfred will call this method once for each chunk of
    464. 

  464.  character data found in the contents of elements.  Note that
    465. 

  465.  the parser may break up a long sequence of characters into
    466. 

  466.  smaller chunks and call this method once for each chunk.
    467. 

  467.  <p>Do <em>not</em> attempt to read more than <var>length</var>
    468. 

  468.  characters from the array, or to read before the 
    469. 

  469.  <var>start</var> position.
    470. 

  470. <P>
    471. 

  471. <DD><DL>
    472. 

  472. <DT><B>Parameters:</B><DD><CODE>ch</CODE> - The character data.<DD><CODE>start</CODE> - The starting position in the array.<DD><CODE>length</CODE> - The number of characters available.
    473. 

  473. <DT><B>Throws:</B>
    474. 

  474. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.</DL>
    475. 

  475. </DD>
    476. 

  476. </DL>
    477. 

  477. <HR>
    478. 

  478. 

  479. <A NAME="ignorableWhitespace(char[], int, int)"><!-- --></A><H3>
    480. 

  480. ignorableWhitespace</H3>
    481. 

  481. <PRE>
    482. 

  482. void <B>ignorableWhitespace</B>(char[]&nbsp;ch,
    483. 

  483.                          int&nbsp;start,
    484. 

  484.                          int&nbsp;length)
    485. 

  485.                          throws java.lang.Exception</PRE>
    486. 

  486. <DL>
    487. 

  487. <DD><B>Deprecated.</B>&nbsp;<DD>Ignorable whitespace.
    488. 

  488.  <p>&AElig;lfred will call this method once for each sequence
    489. 

  489.  of ignorable whitespace in element content (never in mixed content).
    490. 

  490.  <p>For details, see section 2.10 of the XML 1.0 recommendation.
    491. 

  491.  <p>Do <em>not</em> attempt to read more than <var>length</var>
    492. 

  492.  characters from the array or to read before the <var>start</var>
    493. 

  493.  position.
    494. 

  494. <P>
    495. 

  495. <DD><DL>
    496. 

  496. <DT><B>Parameters:</B><DD><CODE>ch</CODE> - The literal whitespace characters.<DD><CODE>start</CODE> - The starting position in the array.<DD><CODE>length</CODE> - The number of whitespace characters available.
    497. 

  497. <DT><B>Throws:</B>
    498. 

  498. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.</DL>
    499. 

  499. </DD>
    500. 

  500. </DL>
    501. 

  501. <HR>
    502. 

  502. 

  503. <A NAME="processingInstruction(java.lang.String, java.lang.String)"><!-- --></A><H3>
    504. 

  504. processingInstruction</H3>
    505. 

  505. <PRE>
    506. 

  506. void <B>processingInstruction</B>(java.lang.String&nbsp;target,
    507. 

  507.                            java.lang.String&nbsp;data)
    508. 

  508.                            throws java.lang.Exception</PRE>
    509. 

  509. <DL>
    510. 

  510. <DD><B>Deprecated.</B>&nbsp;<DD>Processing instruction.
    511. 

  511.  <p>&AElig;lfred will call this method once for each
    512. 

  512.  processing instruction.  Note that processing instructions may
    513. 

  513.  appear outside of the top-level element.  The
    514. 

  514. <P>
    515. 

  515. <DD><DL>
    516. 

  516. <DT><B>Parameters:</B><DD><CODE>target</CODE> - The target (the name at the start of the PI).<DD><CODE>data</CODE> - The data, if any (the rest of the PI).
    517. 

  517. <DT><B>Throws:</B>
    518. 

  518. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.</DL>
    519. 

  519. </DD>
    520. 

  520. </DL>
    521. 

  521. <HR>
    522. 

  522. 

  523. <A NAME="error(java.lang.String, java.lang.String, int, int)"><!-- --></A><H3>
    524. 

  524. error</H3>
    525. 

  525. <PRE>
    526. 

  526. void <B>error</B>(java.lang.String&nbsp;message,
    527. 

  527.            java.lang.String&nbsp;systemId,
    528. 

  528.            int&nbsp;line,
    529. 

  529.            int&nbsp;column)
    530. 

  530.            throws java.lang.Exception</PRE>
    531. 

  531. <DL>
    532. 

  532. <DD><B>Deprecated.</B>&nbsp;<DD>Fatal XML parsing error.
    533. 

  533.  <p>&AElig;lfred will call this method whenever it encounters
    534. 

  534.  a serious error.  The parser will attempt to continue past this 
    535. 

  535.  point so that you can find more possible error points, but if
    536. 

  536.  this method is called you should assume that the document is
    537. 

  537.  corrupt and you should not try to use its contents.
    538. 

  538.  <p>Note that you can use the <code>XmlException</code> class
    539. 

  539.  to encapsulate all of the information provided, though the
    540. 

  540.  use of the class is not mandatory.
    541. 

  541. <P>
    542. 

  542. <DD><DL>
    543. 

  543. <DT><B>Parameters:</B><DD><CODE>message</CODE> - The error message.<DD><CODE>systemId</CODE> - The system identifier of the entity that 
    544. 

  544.         contains the error.<DD><CODE>line</CODE> - The approximate line number of the error.<DD><CODE>column</CODE> - The approximate column number of the error.
    545. 

  545. <DT><B>Throws:</B>
    546. 

  546. <DD><CODE>java.lang.Exception</CODE> - The handler may throw any exception.<DT><B>See Also:</B><DD><A HREF="../../../com/microstar/xml/XmlException.html" title="class in com.microstar.xml"><CODE>XmlException</CODE></A></DL>
    547. 

  547. </DD>
    548. 

  548. </DL>
    549. 

  549. <!-- ========= END OF CLASS DATA ========= -->
    550. 

  550. <HR>
    551. 

  551. 

  552. 

  553. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    554. 

  554. <A NAME="navbar_bottom"><!-- --></A>
    555. 

  555. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    556. 

  556. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    557. 

  557. <TR>
    558. 

  558. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    559. 

  559. <A NAME="navbar_bottom_firstrow"><!-- --></A>
    560. 

  560. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    561. 

  561.   <TR ALIGN="center" VALIGN="top">
    562. 

  562.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    563. 

  563.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    564. 

  564.   <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    565. 

  565.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/XmlHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    566. 

  566.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    567. 

  567.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    568. 

  568.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    569. 

  569.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
    570. 

  570.   </TR>
    571. 

  571. </TABLE>
    572. 

  572. </TD>
    573. 

  573. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    574. 

  574. </EM>
    575. 

  575. </TD>
    576. 

  576. </TR>
    577. 

  577. 

  578. <TR>
    579. 

  579. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    580. 

  580. &nbsp;<A HREF="../../../com/microstar/xml/XmlException.html" title="class in com.microstar.xml"><B>PREV CLASS</B></A>&nbsp;
    581. 

  581. &nbsp;<A HREF="../../../com/microstar/xml/XmlParser.html" title="class in com.microstar.xml"><B>NEXT CLASS</B></A></FONT></TD>
    582. 

  582. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    583. 

  583.   <A HREF="../../../index.html?com/microstar/xml/XmlHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    584. 

  584. &nbsp;<A HREF="XmlHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    585. 

  585. &nbsp;
    586. 

  586. <NOSCRIPT>
    587. 

  587.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
    588. 

  588. </NOSCRIPT>
    589. 

  589. 

  590. 

  591. </FONT></TD>
    592. 

  592. </TR>
    593. 

  593. <TR>
    594. 

  594. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    595. 

  595.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
    596. 

  596. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    597. 

  597. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    598. 

  598. </TR>
    599. 

  599. </TABLE>
    600. 

  600. <A NAME="skip-navbar_bottom"></A>
    601. 

  601. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    602. 

  602. 

  603. <HR>
    604. 

  604. 

  605. </BODY>
    606. 

  606. </HTML>
    607. 

  607.