third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/EXIReader.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 EXIReader\r
   9 </TITLE>\r
  10 \r
  11 <META NAME="keywords" CONTENT="org.openexi.sax.EXIReader class">\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="EXIReader";\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/sax/BinaryDataHandler.html" title="interface in org.openexi.sax"><B>PREV CLASS</B></A>&nbsp;\r
  56 &nbsp;<A HREF="../../../org/openexi/sax/ReaderSupport.html" title="class in org.openexi.sax"><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/sax/EXIReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="EXIReader.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;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  78 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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.sax</FONT>\r
  89 <BR>\r
  90 Class EXIReader</H2>\r
  91 <PRE>\r
  92 java.lang.Object\r
  93   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/openexi/sax/ReaderSupport.html" title="class in org.openexi.sax">org.openexi.sax.ReaderSupport</A>\r
  94       <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.sax.EXIReader</B>\r
  95 </PRE>\r
  96 <DL>\r
  97 <DT><B>All Implemented Interfaces:</B> <DD>org.xml.sax.Attributes, org.xml.sax.XMLReader</DD>\r
  98 </DL>\r
  99 <HR>\r
 100 <DL>\r
 101 <DT><PRE>public final class <B>EXIReader</B><DT>extends <A HREF="../../../org/openexi/sax/ReaderSupport.html" title="class in org.openexi.sax">ReaderSupport</A><DT>implements org.xml.sax.XMLReader</DL>\r
 102 </PRE>\r
 103 \r
 104 <P>\r
 105 EXIReader implements the SAX XMLReader to provide a convenient and
 106  familiar interface for decoding an EXI stream.\r
 107 <P>\r
 108 \r
 109 <P>\r
 110 <DL>\r
 111 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
 112 </DL>\r
 113 <HR>\r
 114 \r
 115 <P>\r
 116 \r
 117 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 118 \r
 119 <A NAME="constructor_summary"><!-- --></A>\r
 120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 122 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 123 <B>Constructor Summary</B></FONT></TH>\r
 124 </TR>\r
 125 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 126 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#EXIReader()">EXIReader</A></B>()</CODE>\r
 127 \r
 128 <BR>\r
 129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 130 </TR>\r
 131 </TABLE>\r
 132 &nbsp;\r
 133 <!-- ========== METHOD SUMMARY =========== -->\r
 134 \r
 135 <A NAME="method_summary"><!-- --></A>\r
 136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 137 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 138 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 139 <B>Method Summary</B></FONT></TH>\r
 140 </TR>\r
 141 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 143 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 144 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#getFeature(java.lang.String)">getFeature</A></B>(java.lang.String&nbsp;name)</CODE>\r
 145 \r
 146 <BR>\r
 147 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get features for the SAX parser.</TD>\r
 148 </TR>\r
 149 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 151 <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>\r
 152 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String&nbsp;name)</CODE>\r
 153 \r
 154 <BR>\r
 155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Use to retrieve the name of the lexical handler, currently the only
 156  property recognized by this class.</TD>\r
 157 </TR>\r
 158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 160 <CODE>&nbsp;void</CODE></FONT></TD>\r
 161 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setAlignmentType(org.openexi.proc.common.AlignmentType)">setAlignmentType</A></B>(<A HREF="../../../org/openexi/proc/common/AlignmentType.html" title="enum in org.openexi.proc.common">AlignmentType</A>&nbsp;alignmentType)</CODE>\r
 162 \r
 163 <BR>\r
 164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the bit alignment style used to compile the EXI input stream.</TD>\r
 165 </TR>\r
 166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 168 <CODE>&nbsp;void</CODE></FONT></TD>\r
 169 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setBlockSize(int)">setBlockSize</A></B>(int&nbsp;blockSize)</CODE>\r
 170 \r
 171 <BR>\r
 172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the size, in number of values, of the information that will be
 173  processed as a chunk of the entire EXI stream.</TD>\r
 174 </TR>\r
 175 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 177 <CODE>&nbsp;void</CODE></FONT></TD>\r
 178 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setDatatypeRepresentationMap(org.openexi.proc.common.QName[], int)">setDatatypeRepresentationMap</A></B>(<A HREF="../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common">QName</A>[]&nbsp;dtrm,\r
 179                              int&nbsp;n_bindings)</CODE>\r
 180 \r
 181 <BR>\r
 182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a datatype representation map.</TD>\r
 183 </TR>\r
 184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 186 <CODE>&nbsp;void</CODE></FONT></TD>\r
 187 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setEXISchemaResolver(org.openexi.proc.EXISchemaResolver)">setEXISchemaResolver</A></B>(<A HREF="../../../org/openexi/proc/EXISchemaResolver.html" title="interface in org.openexi.proc">EXISchemaResolver</A>&nbsp;schemaResolver)</CODE>\r
 188 \r
 189 <BR>\r
 190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the EXISchemaResolver to retrieve the schema needed to decode the
 191  current EXI stream.</TD>\r
 192 </TR>\r
 193 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 194 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 195 <CODE>&nbsp;void</CODE></FONT></TD>\r
 196 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setFeature(java.lang.String, boolean)">setFeature</A></B>(java.lang.String&nbsp;name,\r
 197            boolean&nbsp;value)</CODE>\r
 198 \r
 199 <BR>\r
 200 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set features for the SAX parser.</TD>\r
 201 </TR>\r
 202 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 203 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 204 <CODE>&nbsp;void</CODE></FONT></TD>\r
 205 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setFragment(boolean)">setFragment</A></B>(boolean&nbsp;isFragment)</CODE>\r
 206 \r
 207 <BR>\r
 208 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to true if the EXI input stream is an XML fragment (a non-compliant
 209  XML document with multiple root elements).</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>&nbsp;void</CODE></FONT></TD>\r
 214 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setLexicalHandler(org.xml.sax.ext.LexicalHandler)">setLexicalHandler</A></B>(org.xml.sax.ext.LexicalHandler&nbsp;lexicalHandler)</CODE>\r
 215 \r
 216 <BR>\r
 217 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a SAX lexical handler to receive SAX lexical events.</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>&nbsp;void</CODE></FONT></TD>\r
 222 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setPreserveLexicalValues(boolean)">setPreserveLexicalValues</A></B>(boolean&nbsp;preserveLexicalValues)</CODE>\r
 223 \r
 224 <BR>\r
 225 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to true if the EXI input stream was compiled with the Preserve Lexical
 226  Values set to true.</TD>\r
 227 </TR>\r
 228 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 229 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 230 <CODE>&nbsp;void</CODE></FONT></TD>\r
 231 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A></B>(java.lang.String&nbsp;name,\r
 232             java.lang.Object&nbsp;value)</CODE>\r
 233 \r
 234 <BR>\r
 235 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method wraps the friendlier setLexicalHandler method to provide
 236  syntax familiar to experienced SAX programmers.</TD>\r
 237 </TR>\r
 238 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 239 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 240 <CODE>&nbsp;void</CODE></FONT></TD>\r
 241 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setValueMaxLength(int)">setValueMaxLength</A></B>(int&nbsp;valueMaxLength)</CODE>\r
 242 \r
 243 <BR>\r
 244 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the maximum length of a string that will be stored for reuse in the
 245  String Table.</TD>\r
 246 </TR>\r
 247 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 248 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 249 <CODE>&nbsp;void</CODE></FONT></TD>\r
 250 <TD><CODE><B><A HREF="../../../org/openexi/sax/EXIReader.html#setValuePartitionCapacity(int)">setValuePartitionCapacity</A></B>(int&nbsp;valuePartitionCapacity)</CODE>\r
 251 \r
 252 <BR>\r
 253 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the maximum number of values in the String Table.</TD>\r
 254 </TR>\r
 255 </TABLE>\r
 256 &nbsp;<A NAME="methods_inherited_from_class_org.openexi.sax.ReaderSupport"><!-- --></A>\r
 257 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 258 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 259 <TH ALIGN="left"><B>Methods inherited from class org.openexi.sax.<A HREF="../../../org/openexi/sax/ReaderSupport.html" title="class in org.openexi.sax">ReaderSupport</A></B></TH>\r
 260 </TR>\r
 261 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 262 <TD><CODE><A HREF="../../../org/openexi/sax/ReaderSupport.html#getContentHandler()">getContentHandler</A>, <A HREF="../../../org/openexi/sax/ReaderSupport.html#setContentHandler(org.xml.sax.ContentHandler)">setContentHandler</A>, <A HREF="../../../org/openexi/sax/ReaderSupport.html#setGrammarCache(org.openexi.proc.grammars.GrammarCache)">setGrammarCache</A></CODE></TD>\r
 263 </TR>\r
 264 </TABLE>\r
 265 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 266 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 267 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 268 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
 269 </TR>\r
 270 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 271 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 272 </TR>\r
 273 </TABLE>\r
 274 &nbsp;<A NAME="methods_inherited_from_class_org.xml.sax.XMLReader"><!-- --></A>\r
 275 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 276 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 277 <TH ALIGN="left"><B>Methods inherited from interface org.xml.sax.XMLReader</B></TH>\r
 278 </TR>\r
 279 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 280 <TD><CODE>getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, parse, parse, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler</CODE></TD>\r
 281 </TR>\r
 282 </TABLE>\r
 283 &nbsp;<A NAME="methods_inherited_from_class_org.xml.sax.Attributes"><!-- --></A>\r
 284 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 285 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 286 <TH ALIGN="left"><B>Methods inherited from interface org.xml.sax.Attributes</B></TH>\r
 287 </TR>\r
 288 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 289 <TD><CODE>getIndex, getIndex, getLength, getLocalName, getQName, getType, getType, getType, getURI, getValue, getValue, getValue</CODE></TD>\r
 290 </TR>\r
 291 </TABLE>\r
 292 &nbsp;\r
 293 <P>\r
 294 \r
 295 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 296 \r
 297 <A NAME="constructor_detail"><!-- --></A>\r
 298 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 299 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 300 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 301 <B>Constructor Detail</B></FONT></TH>\r
 302 </TR>\r
 303 </TABLE>\r
 304 \r
 305 <A NAME="EXIReader()"><!-- --></A><H3>\r
 306 EXIReader</H3>\r
 307 <PRE>\r
 308 public <B>EXIReader</B>()</PRE>\r
 309 <DL>\r
 310 </DL>\r
 311 \r
 312 <!-- ============ METHOD DETAIL ========== -->\r
 313 \r
 314 <A NAME="method_detail"><!-- --></A>\r
 315 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 316 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 317 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 318 <B>Method Detail</B></FONT></TH>\r
 319 </TR>\r
 320 </TABLE>\r
 321 \r
 322 <A NAME="setProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3>\r
 323 setProperty</H3>\r
 324 <PRE>\r
 325 public final void <B>setProperty</B>(java.lang.String&nbsp;name,\r
 326                               java.lang.Object&nbsp;value)\r
 327                        throws org.xml.sax.SAXNotRecognizedException</PRE>\r
 328 <DL>\r
 329 <DD>This method wraps the friendlier setLexicalHandler method to provide
 330  syntax familiar to experienced SAX programmers. The only property
 331  supported is: <pre>http://xml.org/sax/properties/lexical-handler</pre>\r
 332 <P>\r
 333 <DD><DL>\r
 334 <DT><B>Specified by:</B><DD><CODE>setProperty</CODE> in interface <CODE>org.xml.sax.XMLReader</CODE></DL>\r
 335 </DD>\r
 336 <DD><DL>\r
 337 <DT><B>Parameters:</B><DD><CODE>name</CODE> - must equal "http://xml.org/sax/properties/lexical-handler"<DD><CODE>value</CODE> - an org.xml.sax.ext.LexicalHandler object\r
 338 <DT><B>Throws:</B>\r
 339 <DD><CODE>org.xml.sax.SAXNotRecognizedException</CODE></DL>\r
 340 </DD>\r
 341 </DL>\r
 342 <HR>\r
 343 \r
 344 <A NAME="getProperty(java.lang.String)"><!-- --></A><H3>\r
 345 getProperty</H3>\r
 346 <PRE>\r
 347 public final java.lang.Object <B>getProperty</B>(java.lang.String&nbsp;name)\r
 348                                    throws org.xml.sax.SAXNotRecognizedException</PRE>\r
 349 <DL>\r
 350 <DD>Use to retrieve the name of the lexical handler, currently the only
 351  property recognized by this class. Pass the String
 352  "http://xml.org/sax/properties/lexical-handler" as the name.\r
 353 <P>\r
 354 <DD><DL>\r
 355 <DT><B>Specified by:</B><DD><CODE>getProperty</CODE> in interface <CODE>org.xml.sax.XMLReader</CODE></DL>\r
 356 </DD>\r
 357 <DD><DL>\r
 358 \r
 359 <DT><B>Returns:</B><DD>String name of the lexical handler\r
 360 <DT><B>Throws:</B>\r
 361 <DD><CODE>org.xml.sax.SAXNotRecognizedException</CODE></DL>\r
 362 </DD>\r
 363 </DL>\r
 364 <HR>\r
 365 \r
 366 <A NAME="setFeature(java.lang.String, boolean)"><!-- --></A><H3>\r
 367 setFeature</H3>\r
 368 <PRE>\r
 369 public final void <B>setFeature</B>(java.lang.String&nbsp;name,\r
 370                              boolean&nbsp;value)\r
 371                       throws org.xml.sax.SAXNotRecognizedException,\r
 372                              org.xml.sax.SAXNotSupportedException</PRE>\r
 373 <DL>\r
 374 <DD>Set features for the SAX parser. The only supported arguments are <pre>
 375  EXIReader.setFeature("http://xml.org/sax/features/namespaces", true);</pre> and <pre>
 376  EXIReader.setFeature("http://xml.org/sax/features/namespace-prefixes", false);</pre>\r
 377 <P>\r
 378 <DD><DL>\r
 379 <DT><B>Specified by:</B><DD><CODE>setFeature</CODE> in interface <CODE>org.xml.sax.XMLReader</CODE></DL>\r
 380 </DD>\r
 381 <DD><DL>\r
 382 \r
 383 <DT><B>Throws:</B>\r
 384 <DD><CODE>org.xml.sax.SAXNotRecognizedException</CODE>\r
 385 <DD><CODE>org.xml.sax.SAXNotSupportedException</CODE></DL>\r
 386 </DD>\r
 387 </DL>\r
 388 <HR>\r
 389 \r
 390 <A NAME="getFeature(java.lang.String)"><!-- --></A><H3>\r
 391 getFeature</H3>\r
 392 <PRE>\r
 393 public final boolean <B>getFeature</B>(java.lang.String&nbsp;name)\r
 394                          throws org.xml.sax.SAXNotRecognizedException</PRE>\r
 395 <DL>\r
 396 <DD>Get features for the SAX parser.\r
 397 <P>\r
 398 <DD><DL>\r
 399 <DT><B>Specified by:</B><DD><CODE>getFeature</CODE> in interface <CODE>org.xml.sax.XMLReader</CODE></DL>\r
 400 </DD>\r
 401 <DD><DL>\r
 402 \r
 403 <DT><B>Returns:</B><DD><i>true</i> if the feature is "http://xml.org/sax/features/namespaces"
 404  and <i>false</i> if the feature is "http://xml.org/sax/features/namespace-prefixes"\r
 405 <DT><B>Throws:</B>\r
 406 <DD><CODE>org.xml.sax.SAXNotRecognizedException</CODE></DL>\r
 407 </DD>\r
 408 </DL>\r
 409 <HR>\r
 410 \r
 411 <A NAME="setAlignmentType(org.openexi.proc.common.AlignmentType)"><!-- --></A><H3>\r
 412 setAlignmentType</H3>\r
 413 <PRE>\r
 414 public final void <B>setAlignmentType</B>(<A HREF="../../../org/openexi/proc/common/AlignmentType.html" title="enum in org.openexi.proc.common">AlignmentType</A>&nbsp;alignmentType)\r
 415                             throws org.openexi.proc.common.EXIOptionsException</PRE>\r
 416 <DL>\r
 417 <DD>Set the bit alignment style used to compile the EXI input stream.\r
 418 <P>\r
 419 <DD><DL>\r
 420 </DL>\r
 421 </DD>\r
 422 <DD><DL>\r
 423 <DT><B>Parameters:</B><DD><CODE>alignmentType</CODE> - <A HREF="../../../org/openexi/proc/common/AlignmentType.html" title="enum in org.openexi.proc.common"><CODE>AlignmentType</CODE></A>\r
 424 <DT><B>Throws:</B>\r
 425 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 426 </DD>\r
 427 </DL>\r
 428 <HR>\r
 429 \r
 430 <A NAME="setFragment(boolean)"><!-- --></A><H3>\r
 431 setFragment</H3>\r
 432 <PRE>\r
 433 public final void <B>setFragment</B>(boolean&nbsp;isFragment)</PRE>\r
 434 <DL>\r
 435 <DD>Set to true if the EXI input stream is an XML fragment (a non-compliant
 436  XML document with multiple root elements).\r
 437 <P>\r
 438 <DD><DL>\r
 439 </DL>\r
 440 </DD>\r
 441 <DD><DL>\r
 442 <DT><B>Parameters:</B><DD><CODE>isFragment</CODE> - true if the EXI input stream is an XML fragment.</DL>\r
 443 </DD>\r
 444 </DL>\r
 445 <HR>\r
 446 \r
 447 <A NAME="setPreserveLexicalValues(boolean)"><!-- --></A><H3>\r
 448 setPreserveLexicalValues</H3>\r
 449 <PRE>\r
 450 public final void <B>setPreserveLexicalValues</B>(boolean&nbsp;preserveLexicalValues)\r
 451                                     throws org.openexi.proc.common.EXIOptionsException</PRE>\r
 452 <DL>\r
 453 <DD>Set to true if the EXI input stream was compiled with the Preserve Lexical
 454  Values set to true. The original strings, rather than logical XML
 455  equivalents, are restored in the XML output stream.\r
 456 <P>\r
 457 <DD><DL>\r
 458 </DL>\r
 459 </DD>\r
 460 <DD><DL>\r
 461 <DT><B>Parameters:</B><DD><CODE>preserveLexicalValues</CODE> - set to true if the EXI input stream was compiled with
 462  Preserve Lexical Values set to true.\r
 463 <DT><B>Throws:</B>\r
 464 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 465 </DD>\r
 466 </DL>\r
 467 <HR>\r
 468 \r
 469 <A NAME="setEXISchemaResolver(org.openexi.proc.EXISchemaResolver)"><!-- --></A><H3>\r
 470 setEXISchemaResolver</H3>\r
 471 <PRE>\r
 472 public final void <B>setEXISchemaResolver</B>(<A HREF="../../../org/openexi/proc/EXISchemaResolver.html" title="interface in org.openexi.proc">EXISchemaResolver</A>&nbsp;schemaResolver)</PRE>\r
 473 <DL>\r
 474 <DD>Set the EXISchemaResolver to retrieve the schema needed to decode the
 475  current EXI stream.\r
 476 <P>\r
 477 <DD><DL>\r
 478 </DL>\r
 479 </DD>\r
 480 <DD><DL>\r
 481 <DT><B>Parameters:</B><DD><CODE>schemaResolver</CODE> - <A HREF="../../../org/openexi/proc/EXISchemaResolver.html" title="interface in org.openexi.proc"><CODE>EXISchemaResolver</CODE></A></DL>\r
 482 </DD>\r
 483 </DL>\r
 484 <HR>\r
 485 \r
 486 <A NAME="setDatatypeRepresentationMap(org.openexi.proc.common.QName[], int)"><!-- --></A><H3>\r
 487 setDatatypeRepresentationMap</H3>\r
 488 <PRE>\r
 489 public final void <B>setDatatypeRepresentationMap</B>(<A HREF="../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common">QName</A>[]&nbsp;dtrm,\r
 490                                                int&nbsp;n_bindings)\r
 491                                         throws org.openexi.proc.common.EXIOptionsException</PRE>\r
 492 <DL>\r
 493 <DD>Set a datatype representation map.\r
 494 <P>\r
 495 <DD><DL>\r
 496 </DL>\r
 497 </DD>\r
 498 <DD><DL>\r
 499 <DT><B>Parameters:</B><DD><CODE>dtrm</CODE> - a sequence of pairs of datatype qname and datatype representation qname<DD><CODE>n_bindings</CODE> - the number of qname pairs\r
 500 <DT><B>Throws:</B>\r
 501 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 502 </DD>\r
 503 </DL>\r
 504 <HR>\r
 505 \r
 506 <A NAME="setBlockSize(int)"><!-- --></A><H3>\r
 507 setBlockSize</H3>\r
 508 <PRE>\r
 509 public final void <B>setBlockSize</B>(int&nbsp;blockSize)\r
 510                         throws org.openexi.proc.common.EXIOptionsException</PRE>\r
 511 <DL>\r
 512 <DD>Set the size, in number of values, of the information that will be
 513  processed as a chunk of the entire EXI stream. Reducing the block size
 514  can improve performance for devices with limited dynamic memory.
 515  Default is 1,000,000 items (not 1MB, but 1,000,000 complete Attribute
 516  and Element values). Block size is only used when the EXI stream is
 517  encoded with EXI-compression.\r
 518 <P>\r
 519 <DD><DL>\r
 520 </DL>\r
 521 </DD>\r
 522 <DD><DL>\r
 523 <DT><B>Parameters:</B><DD><CODE>blockSize</CODE> - number of values in each processing block. Default is 1,000,000.\r
 524 <DT><B>Throws:</B>\r
 525 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 526 </DD>\r
 527 </DL>\r
 528 <HR>\r
 529 \r
 530 <A NAME="setValueMaxLength(int)"><!-- --></A><H3>\r
 531 setValueMaxLength</H3>\r
 532 <PRE>\r
 533 public final void <B>setValueMaxLength</B>(int&nbsp;valueMaxLength)</PRE>\r
 534 <DL>\r
 535 <DD>Set the maximum length of a string that will be stored for reuse in the
 536  String Table. By default, there is no maximum length. However, in data
 537  sets that have long, unique strings of information, you can improve
 538  performance by limiting the size to the length of strings that are more
 539  likely to appear more than once.\r
 540 <P>\r
 541 <DD><DL>\r
 542 </DL>\r
 543 </DD>\r
 544 <DD><DL>\r
 545 <DT><B>Parameters:</B><DD><CODE>valueMaxLength</CODE> - maximum length of entries in the String Table.</DL>\r
 546 </DD>\r
 547 </DL>\r
 548 <HR>\r
 549 \r
 550 <A NAME="setValuePartitionCapacity(int)"><!-- --></A><H3>\r
 551 setValuePartitionCapacity</H3>\r
 552 <PRE>\r
 553 public final void <B>setValuePartitionCapacity</B>(int&nbsp;valuePartitionCapacity)</PRE>\r
 554 <DL>\r
 555 <DD>Set the maximum number of values in the String Table. By default, there
 556  is no limit. If the target device has limited dynamic memory, limiting
 557  the number of entries in the String Table can improve performance and
 558  reduce the likelihood that you will exceed memory capacity.\r
 559 <P>\r
 560 <DD><DL>\r
 561 </DL>\r
 562 </DD>\r
 563 <DD><DL>\r
 564 <DT><B>Parameters:</B><DD><CODE>valuePartitionCapacity</CODE> - maximum number of entries in the String Table</DL>\r
 565 </DD>\r
 566 </DL>\r
 567 <HR>\r
 568 \r
 569 <A NAME="setLexicalHandler(org.xml.sax.ext.LexicalHandler)"><!-- --></A><H3>\r
 570 setLexicalHandler</H3>\r
 571 <PRE>\r
 572 public void <B>setLexicalHandler</B>(org.xml.sax.ext.LexicalHandler&nbsp;lexicalHandler)</PRE>\r
 573 <DL>\r
 574 <DD>Set a SAX lexical handler to receive SAX lexical events.\r
 575 <P>\r
 576 <DD><DL>\r
 577 </DL>\r
 578 </DD>\r
 579 <DD><DL>\r
 580 <DT><B>Parameters:</B><DD><CODE>lexicalHandler</CODE> - SAX lexical handler</DL>\r
 581 </DD>\r
 582 </DL>\r
 583 <!-- ========= END OF CLASS DATA ========= -->\r
 584 <HR>\r
 585 \r
 586 \r
 587 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 588 <A NAME="navbar_bottom"><!-- --></A>\r
 589 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 590 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 591 <TR>\r
 592 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 593 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 594 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 595   <TR ALIGN="center" VALIGN="top">\r
 596   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 597   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 598   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 599   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 600   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 601   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 602   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 603   </TR>\r
 604 </TABLE>\r
 605 </TD>\r
 606 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 607 </EM>\r
 608 </TD>\r
 609 </TR>\r
 610 \r
 611 <TR>\r
 612 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 613 &nbsp;<A HREF="../../../org/openexi/sax/BinaryDataHandler.html" title="interface in org.openexi.sax"><B>PREV CLASS</B></A>&nbsp;\r
 614 &nbsp;<A HREF="../../../org/openexi/sax/ReaderSupport.html" title="class in org.openexi.sax"><B>NEXT CLASS</B></A></FONT></TD>\r
 615 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 616   <A HREF="../../../index.html?org/openexi/sax/EXIReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 617 &nbsp;<A HREF="EXIReader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 618 &nbsp;<SCRIPT type="text/javascript">\r
 619   <!--\r
 620   if(window==top) {\r
 621     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 622   }\r
 623   //-->\r
 624 </SCRIPT>\r
 625 <NOSCRIPT>\r
 626   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 627 </NOSCRIPT>\r
 628 \r
 629 \r
 630 </FONT></TD>\r
 631 </TR>\r
 632 <TR>\r
 633 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 634   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 635 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 636 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 637 </TR>\r
 638 </TABLE>\r
 639 <A NAME="skip-navbar_bottom"></A>\r
 640 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 641 \r
 642 <HR>\r
 643 \r
 644 </BODY>\r
 645 </HTML>\r