third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EventDescription.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.5.0_22) on Thu Apr 10 14:54:57 PDT 2014 -->\r
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">\r
   7 <TITLE>\r
   8 EventDescription\r
   9 </TITLE>\r
  10 \r
  11 <META NAME="keywords" CONTENT="org.openexi.proc.common.EventDescription interface">\r
  12 \r
  13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">\r
  14 \r
  15 <SCRIPT type="text/javascript">\r
  16 function windowTitle()\r
  17 {\r
  18     parent.document.title="EventDescription";\r
  19 }\r
  20 </SCRIPT>\r
  21 <NOSCRIPT>\r
  22 </NOSCRIPT>\r
  23 \r
  24 </HEAD>\r
  25 \r
  26 <BODY BGCOLOR="white" onload="windowTitle();">\r
  27 \r
  28 \r
  29 <!-- ========= START OF TOP NAVBAR ======= -->\r
  30 <A NAME="navbar_top"><!-- --></A>\r
  31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
  32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  33 <TR>\r
  34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  35 <A NAME="navbar_top_firstrow"><!-- --></A>\r
  36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  37   <TR ALIGN="center" VALIGN="top">\r
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  40   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  45   </TR>\r
  46 </TABLE>\r
  47 </TD>\r
  48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  49 </EM>\r
  50 </TD>\r
  51 </TR>\r
  52 \r
  53 <TR>\r
  54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  55 &nbsp;<A HREF="../../../../org/openexi/proc/common/BinaryDataSource.html" title="class in org.openexi.proc.common"><B>PREV CLASS</B></A>&nbsp;\r
  56 &nbsp;<A HREF="../../../../org/openexi/proc/common/EventType.html" title="class in org.openexi.proc.common"><B>NEXT CLASS</B></A></FONT></TD>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58   <A HREF="../../../../index.html?org/openexi/proc/common/EventDescription.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="EventDescription.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  60 &nbsp;<SCRIPT type="text/javascript">\r
  61   <!--\r
  62   if(window==top) {\r
  63     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  64   }\r
  65   //-->\r
  66 </SCRIPT>\r
  67 <NOSCRIPT>\r
  68   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
  69 </NOSCRIPT>\r
  70 \r
  71 \r
  72 </FONT></TD>\r
  73 </TR>\r
  74 <TR>\r
  75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  76   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  78 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  79 </TR>\r
  80 </TABLE>\r
  81 <A NAME="skip-navbar_top"></A>\r
  82 <!-- ========= END OF TOP NAVBAR ========= -->\r
  83 \r
  84 <HR>\r
  85 <!-- ======== START OF CLASS DATA ======== -->\r
  86 <H2>\r
  87 <FONT SIZE="-1">\r
  88 org.openexi.proc.common</FONT>\r
  89 <BR>\r
  90 Interface EventDescription</H2>\r
  91 <DL>\r
  92 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/openexi/proc/common/EventType.html" title="class in org.openexi.proc.common">EventType</A></DD>\r
  93 </DL>\r
  94 <HR>\r
  95 <DL>\r
  96 <DT><PRE>public interface <B>EventDescription</B></DL>\r
  97 </PRE>\r
  98 \r
  99 <P>\r
 100 <p>EventDescription provides accessors to the current EXI event data
 101  during the decode process.</p>
 102
 103  <p>Note that the content of EventDescription is transient, which means
 104  its content may change when the decoder is asked for access to the
 105  next EXI event data.</p>\r
 106 <P>\r
 107 \r
 108 <P>\r
 109 <DL>\r
 110 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
 111 </DL>\r
 112 <HR>\r
 113 \r
 114 <P>\r
 115 <!-- =========== FIELD SUMMARY =========== -->\r
 116 \r
 117 <A NAME="field_summary"><!-- --></A>\r
 118 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 119 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 120 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 121 <B>Field Summary</B></FONT></TH>\r
 122 </TR>\r
 123 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 124 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 125 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 126 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_AT">EVENT_AT</A></B></CODE>\r
 127 \r
 128 <BR>\r
 129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attribute event.</TD>\r
 130 </TR>\r
 131 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 132 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 133 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 134 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_BLOB">EVENT_BLOB</A></B></CODE>\r
 135 \r
 136 <BR>\r
 137 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;BLOB event (content of an element).</TD>\r
 138 </TR>\r
 139 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 140 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 141 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 142 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_CH">EVENT_CH</A></B></CODE>\r
 143 \r
 144 <BR>\r
 145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Character event (content of an element).</TD>\r
 146 </TR>\r
 147 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 149 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 150 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_CM">EVENT_CM</A></B></CODE>\r
 151 \r
 152 <BR>\r
 153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Comment event.</TD>\r
 154 </TR>\r
 155 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 157 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 158 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_DTD">EVENT_DTD</A></B></CODE>\r
 159 \r
 160 <BR>\r
 161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Document Type Definition event.</TD>\r
 162 </TR>\r
 163 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 165 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 166 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_ED">EVENT_ED</A></B></CODE>\r
 167 \r
 168 <BR>\r
 169 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;End Document event.</TD>\r
 170 </TR>\r
 171 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 173 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 174 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_EE">EVENT_EE</A></B></CODE>\r
 175 \r
 176 <BR>\r
 177 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;End Element event.</TD>\r
 178 </TR>\r
 179 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 181 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 182 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_ER">EVENT_ER</A></B></CODE>\r
 183 \r
 184 <BR>\r
 185 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Entity Reference event.</TD>\r
 186 </TR>\r
 187 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 189 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 190 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_NL">EVENT_NL</A></B></CODE>\r
 191 \r
 192 <BR>\r
 193 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attribute <i>xsi:nil</i>.</TD>\r
 194 </TR>\r
 195 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 197 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 198 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_NS">EVENT_NS</A></B></CODE>\r
 199 \r
 200 <BR>\r
 201 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Namespace declaration event.</TD>\r
 202 </TR>\r
 203 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 205 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 206 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_PI">EVENT_PI</A></B></CODE>\r
 207 \r
 208 <BR>\r
 209 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Processing Instruction event.</TD>\r
 210 </TR>\r
 211 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 213 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 214 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_SD">EVENT_SD</A></B></CODE>\r
 215 \r
 216 <BR>\r
 217 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Start Document event.</TD>\r
 218 </TR>\r
 219 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 221 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 222 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_SE">EVENT_SE</A></B></CODE>\r
 223 \r
 224 <BR>\r
 225 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Start Element event.</TD>\r
 226 </TR>\r
 227 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 229 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 230 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#EVENT_TP">EVENT_TP</A></B></CODE>\r
 231 \r
 232 <BR>\r
 233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attribute <i>xsi:type</i>.</TD>\r
 234 </TR>\r
 235 </TABLE>\r
 236 &nbsp;\r
 237 <!-- ========== METHOD SUMMARY =========== -->\r
 238 \r
 239 <A NAME="method_summary"><!-- --></A>\r
 240 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 241 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 242 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 243 <B>Method Summary</B></FONT></TH>\r
 244 </TR>\r
 245 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 246 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 247 <CODE>&nbsp;<A HREF="../../../../org/openexi/proc/common/BinaryDataSource.html" title="class in org.openexi.proc.common">BinaryDataSource</A></CODE></FONT></TD>\r
 248 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#getBinaryDataSource()">getBinaryDataSource</A></B>()</CODE>\r
 249 \r
 250 <BR>\r
 251 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the value of an EVENT_BLOB.</TD>\r
 252 </TR>\r
 253 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 255 <CODE>&nbsp;<A HREF="../../../../org/openexi/schema/Characters.html" title="class in org.openexi.schema">Characters</A></CODE></FONT></TD>\r
 256 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#getCharacters()">getCharacters</A></B>()</CODE>\r
 257 \r
 258 <BR>\r
 259 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the value of an EVENT_CH,
 260  Attribute (EVENT_AT, EVENT_NL, EVENT_TP), EVENT_CM,
 261  EVENT_DTD or EVENT_PI event.</TD>\r
 262 </TR>\r
 263 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 264 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 265 <CODE>&nbsp;byte</CODE></FONT></TD>\r
 266 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#getEventKind()">getEventKind</A></B>()</CODE>\r
 267 \r
 268 <BR>\r
 269 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the event kind of which instance data this EventDescription is describing.</TD>\r
 270 </TR>\r
 271 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 272 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 273 <CODE>&nbsp;<A HREF="../../../../org/openexi/proc/common/EventType.html" title="class in org.openexi.proc.common">EventType</A></CODE></FONT></TD>\r
 274 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#getEventType()">getEventType</A></B>()</CODE>\r
 275 \r
 276 <BR>\r
 277 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the EventType from which this event is derived.</TD>\r
 278 </TR>\r
 279 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 280 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 281 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 282 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#getName()">getName</A></B>()</CODE>\r
 283 \r
 284 <BR>\r
 285 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the name of the EXI event.</TD>\r
 286 </TR>\r
 287 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 288 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 289 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 290 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#getPrefix()">getPrefix</A></B>()</CODE>\r
 291 \r
 292 <BR>\r
 293 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the namespace prefix of the event.</TD>\r
 294 </TR>\r
 295 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 296 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 297 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 298 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EventDescription.html#getURI()">getURI</A></B>()</CODE>\r
 299 \r
 300 <BR>\r
 301 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the URI of the EXI event.</TD>\r
 302 </TR>\r
 303 </TABLE>\r
 304 &nbsp;\r
 305 <P>\r
 306 \r
 307 <!-- ============ FIELD DETAIL =========== -->\r
 308 \r
 309 <A NAME="field_detail"><!-- --></A>\r
 310 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 311 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 312 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 313 <B>Field Detail</B></FONT></TH>\r
 314 </TR>\r
 315 </TABLE>\r
 316 \r
 317 <A NAME="EVENT_SD"><!-- --></A><H3>\r
 318 EVENT_SD</H3>\r
 319 <PRE>\r
 320 static final byte <B>EVENT_SD</B></PRE>\r
 321 <DL>\r
 322 <DD>Start Document event.\r
 323 <P>\r
 324 <DL>\r
 325 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_SD">Constant Field Values</A></DL>\r
 326 </DL>\r
 327 <HR>\r
 328 \r
 329 <A NAME="EVENT_ED"><!-- --></A><H3>\r
 330 EVENT_ED</H3>\r
 331 <PRE>\r
 332 static final byte <B>EVENT_ED</B></PRE>\r
 333 <DL>\r
 334 <DD>End Document event.\r
 335 <P>\r
 336 <DL>\r
 337 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_ED">Constant Field Values</A></DL>\r
 338 </DL>\r
 339 <HR>\r
 340 \r
 341 <A NAME="EVENT_SE"><!-- --></A><H3>\r
 342 EVENT_SE</H3>\r
 343 <PRE>\r
 344 static final byte <B>EVENT_SE</B></PRE>\r
 345 <DL>\r
 346 <DD>Start Element event.\r
 347 <P>\r
 348 <DL>\r
 349 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_SE">Constant Field Values</A></DL>\r
 350 </DL>\r
 351 <HR>\r
 352 \r
 353 <A NAME="EVENT_AT"><!-- --></A><H3>\r
 354 EVENT_AT</H3>\r
 355 <PRE>\r
 356 static final byte <B>EVENT_AT</B></PRE>\r
 357 <DL>\r
 358 <DD>Attribute event.\r
 359 <P>\r
 360 <DL>\r
 361 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_AT">Constant Field Values</A></DL>\r
 362 </DL>\r
 363 <HR>\r
 364 \r
 365 <A NAME="EVENT_TP"><!-- --></A><H3>\r
 366 EVENT_TP</H3>\r
 367 <PRE>\r
 368 static final byte <B>EVENT_TP</B></PRE>\r
 369 <DL>\r
 370 <DD>Attribute <i>xsi:type</i>.\r
 371 <P>\r
 372 <DL>\r
 373 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_TP">Constant Field Values</A></DL>\r
 374 </DL>\r
 375 <HR>\r
 376 \r
 377 <A NAME="EVENT_NL"><!-- --></A><H3>\r
 378 EVENT_NL</H3>\r
 379 <PRE>\r
 380 static final byte <B>EVENT_NL</B></PRE>\r
 381 <DL>\r
 382 <DD>Attribute <i>xsi:nil</i>.\r
 383 <P>\r
 384 <DL>\r
 385 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_NL">Constant Field Values</A></DL>\r
 386 </DL>\r
 387 <HR>\r
 388 \r
 389 <A NAME="EVENT_CH"><!-- --></A><H3>\r
 390 EVENT_CH</H3>\r
 391 <PRE>\r
 392 static final byte <B>EVENT_CH</B></PRE>\r
 393 <DL>\r
 394 <DD>Character event (content of an element).\r
 395 <P>\r
 396 <DL>\r
 397 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_CH">Constant Field Values</A></DL>\r
 398 </DL>\r
 399 <HR>\r
 400 \r
 401 <A NAME="EVENT_EE"><!-- --></A><H3>\r
 402 EVENT_EE</H3>\r
 403 <PRE>\r
 404 static final byte <B>EVENT_EE</B></PRE>\r
 405 <DL>\r
 406 <DD>End Element event.\r
 407 <P>\r
 408 <DL>\r
 409 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_EE">Constant Field Values</A></DL>\r
 410 </DL>\r
 411 <HR>\r
 412 \r
 413 <A NAME="EVENT_NS"><!-- --></A><H3>\r
 414 EVENT_NS</H3>\r
 415 <PRE>\r
 416 static final byte <B>EVENT_NS</B></PRE>\r
 417 <DL>\r
 418 <DD>Namespace declaration event.\r
 419 <P>\r
 420 <DL>\r
 421 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_NS">Constant Field Values</A></DL>\r
 422 </DL>\r
 423 <HR>\r
 424 \r
 425 <A NAME="EVENT_PI"><!-- --></A><H3>\r
 426 EVENT_PI</H3>\r
 427 <PRE>\r
 428 static final byte <B>EVENT_PI</B></PRE>\r
 429 <DL>\r
 430 <DD>Processing Instruction event.\r
 431 <P>\r
 432 <DL>\r
 433 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_PI">Constant Field Values</A></DL>\r
 434 </DL>\r
 435 <HR>\r
 436 \r
 437 <A NAME="EVENT_CM"><!-- --></A><H3>\r
 438 EVENT_CM</H3>\r
 439 <PRE>\r
 440 static final byte <B>EVENT_CM</B></PRE>\r
 441 <DL>\r
 442 <DD>Comment event.\r
 443 <P>\r
 444 <DL>\r
 445 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_CM">Constant Field Values</A></DL>\r
 446 </DL>\r
 447 <HR>\r
 448 \r
 449 <A NAME="EVENT_ER"><!-- --></A><H3>\r
 450 EVENT_ER</H3>\r
 451 <PRE>\r
 452 static final byte <B>EVENT_ER</B></PRE>\r
 453 <DL>\r
 454 <DD>Entity Reference event.\r
 455 <P>\r
 456 <DL>\r
 457 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_ER">Constant Field Values</A></DL>\r
 458 </DL>\r
 459 <HR>\r
 460 \r
 461 <A NAME="EVENT_DTD"><!-- --></A><H3>\r
 462 EVENT_DTD</H3>\r
 463 <PRE>\r
 464 static final byte <B>EVENT_DTD</B></PRE>\r
 465 <DL>\r
 466 <DD>Document Type Definition event.\r
 467 <P>\r
 468 <DL>\r
 469 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_DTD">Constant Field Values</A></DL>\r
 470 </DL>\r
 471 <HR>\r
 472 \r
 473 <A NAME="EVENT_BLOB"><!-- --></A><H3>\r
 474 EVENT_BLOB</H3>\r
 475 <PRE>\r
 476 static final byte <B>EVENT_BLOB</B></PRE>\r
 477 <DL>\r
 478 <DD>BLOB event (content of an element).\r
 479 <P>\r
 480 <DL>\r
 481 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.EventDescription.EVENT_BLOB">Constant Field Values</A></DL>\r
 482 </DL>\r
 483 \r
 484 <!-- ============ METHOD DETAIL ========== -->\r
 485 \r
 486 <A NAME="method_detail"><!-- --></A>\r
 487 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 488 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 489 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 490 <B>Method Detail</B></FONT></TH>\r
 491 </TR>\r
 492 </TABLE>\r
 493 \r
 494 <A NAME="getEventKind()"><!-- --></A><H3>\r
 495 getEventKind</H3>\r
 496 <PRE>\r
 497 byte <B>getEventKind</B>()</PRE>\r
 498 <DL>\r
 499 <DD>Gets the event kind of which instance data this EventDescription is describing.\r
 500 <P>\r
 501 <DD><DL>\r
 502 \r
 503 <DT><B>Returns:</B><DD>a byte representing the event kind.</DL>\r
 504 </DD>\r
 505 </DL>\r
 506 <HR>\r
 507 \r
 508 <A NAME="getURI()"><!-- --></A><H3>\r
 509 getURI</H3>\r
 510 <PRE>\r
 511 java.lang.String <B>getURI</B>()</PRE>\r
 512 <DL>\r
 513 <DD>Gets the URI of the EXI event.\r
 514 <P>\r
 515 <DD><DL>\r
 516 \r
 517 <DT><B>Returns:</B><DD>the URI as a String.</DL>\r
 518 </DD>\r
 519 </DL>\r
 520 <HR>\r
 521 \r
 522 <A NAME="getName()"><!-- --></A><H3>\r
 523 getName</H3>\r
 524 <PRE>\r
 525 java.lang.String <B>getName</B>()</PRE>\r
 526 <DL>\r
 527 <DD>Gets the name of the EXI event.\r
 528 <P>\r
 529 <DD><DL>\r
 530 \r
 531 <DT><B>Returns:</B><DD>the name of the event as a String.</DL>\r
 532 </DD>\r
 533 </DL>\r
 534 <HR>\r
 535 \r
 536 <A NAME="getPrefix()"><!-- --></A><H3>\r
 537 getPrefix</H3>\r
 538 <PRE>\r
 539 java.lang.String <B>getPrefix</B>()</PRE>\r
 540 <DL>\r
 541 <DD>Gets the namespace prefix of the event.\r
 542 <P>\r
 543 <DD><DL>\r
 544 \r
 545 <DT><B>Returns:</B><DD>the prefix as a String.</DL>\r
 546 </DD>\r
 547 </DL>\r
 548 <HR>\r
 549 \r
 550 <A NAME="getCharacters()"><!-- --></A><H3>\r
 551 getCharacters</H3>\r
 552 <PRE>\r
 553 <A HREF="../../../../org/openexi/schema/Characters.html" title="class in org.openexi.schema">Characters</A> <B>getCharacters</B>()</PRE>\r
 554 <DL>\r
 555 <DD>Gets the value of an EVENT_CH,
 556  Attribute (EVENT_AT, EVENT_NL, EVENT_TP), EVENT_CM,
 557  EVENT_DTD or EVENT_PI event.\r
 558 <P>\r
 559 <DD><DL>\r
 560 \r
 561 <DT><B>Returns:</B><DD>a Characters of the corresponding value</DL>\r
 562 </DD>\r
 563 </DL>\r
 564 <HR>\r
 565 \r
 566 <A NAME="getBinaryDataSource()"><!-- --></A><H3>\r
 567 getBinaryDataSource</H3>\r
 568 <PRE>\r
 569 <A HREF="../../../../org/openexi/proc/common/BinaryDataSource.html" title="class in org.openexi.proc.common">BinaryDataSource</A> <B>getBinaryDataSource</B>()</PRE>\r
 570 <DL>\r
 571 <DD>Gets the value of an EVENT_BLOB.\r
 572 <P>\r
 573 <DD><DL>\r
 574 \r
 575 <DT><B>Returns:</B><DD>a BinaryData of the corresponding value</DL>\r
 576 </DD>\r
 577 </DL>\r
 578 <HR>\r
 579 \r
 580 <A NAME="getEventType()"><!-- --></A><H3>\r
 581 getEventType</H3>\r
 582 <PRE>\r
 583 <A HREF="../../../../org/openexi/proc/common/EventType.html" title="class in org.openexi.proc.common">EventType</A> <B>getEventType</B>()</PRE>\r
 584 <DL>\r
 585 <DD>Returns the EventType from which this event is derived.\r
 586 <P>\r
 587 <DD><DL>\r
 588 </DL>\r
 589 </DD>\r
 590 </DL>\r
 591 <!-- ========= END OF CLASS DATA ========= -->\r
 592 <HR>\r
 593 \r
 594 \r
 595 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 596 <A NAME="navbar_bottom"><!-- --></A>\r
 597 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 598 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 599 <TR>\r
 600 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 601 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 602 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 603   <TR ALIGN="center" VALIGN="top">\r
 604   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 605   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 606   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 607   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 608   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 609   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 610   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 611   </TR>\r
 612 </TABLE>\r
 613 </TD>\r
 614 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 615 </EM>\r
 616 </TD>\r
 617 </TR>\r
 618 \r
 619 <TR>\r
 620 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 621 &nbsp;<A HREF="../../../../org/openexi/proc/common/BinaryDataSource.html" title="class in org.openexi.proc.common"><B>PREV CLASS</B></A>&nbsp;\r
 622 &nbsp;<A HREF="../../../../org/openexi/proc/common/EventType.html" title="class in org.openexi.proc.common"><B>NEXT CLASS</B></A></FONT></TD>\r
 623 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 624   <A HREF="../../../../index.html?org/openexi/proc/common/EventDescription.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 625 &nbsp;<A HREF="EventDescription.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 626 &nbsp;<SCRIPT type="text/javascript">\r
 627   <!--\r
 628   if(window==top) {\r
 629     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 630   }\r
 631   //-->\r
 632 </SCRIPT>\r
 633 <NOSCRIPT>\r
 634   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 635 </NOSCRIPT>\r
 636 \r
 637 \r
 638 </FONT></TD>\r
 639 </TR>\r
 640 <TR>\r
 641 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 642   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 643 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 644 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 645 </TR>\r
 646 </TABLE>\r
 647 <A NAME="skip-navbar_bottom"></A>\r
 648 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 649 \r
 650 <HR>\r
 651 \r
 652 </BODY>\r
 653 </HTML>\r