third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/EXIDecoder.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:56 PDT 2014 -->\r
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">\r
   7 <TITLE>\r
   8 EXIDecoder\r
   9 </TITLE>\r
  10 \r
  11 <META NAME="keywords" CONTENT="org.openexi.proc.EXIDecoder 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="EXIDecoder";\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;PREV CLASS&nbsp;\r
  56 &nbsp;<A HREF="../../../org/openexi/proc/EXISchemaResolver.html" title="interface in org.openexi.proc"><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/EXIDecoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="EXIDecoder.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.proc</FONT>\r
  89 <BR>\r
  90 Class EXIDecoder</H2>\r
  91 <PRE>\r
  92 java.lang.Object\r
  93   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.proc.EXIDecoder</B>\r
  94 </PRE>\r
  95 <HR>\r
  96 <DL>\r
  97 <DT><PRE>public class <B>EXIDecoder</B><DT>extends java.lang.Object</DL>\r
  98 </PRE>\r
  99 \r
 100 <P>\r
 101 EXIDecoder provides methods to configure and
 102  instantiate a <A HREF="../../../org/openexi/proc/io/Scanner.html" title="class in org.openexi.proc.io"><CODE>Scanner</CODE></A> object
 103  you can use to parse the contents of an EXI stream.\r
 104 <P>\r
 105 \r
 106 <P>\r
 107 <DL>\r
 108 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
 109 </DL>\r
 110 <HR>\r
 111 \r
 112 <P>\r
 113 \r
 114 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 115 \r
 116 <A NAME="constructor_summary"><!-- --></A>\r
 117 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 118 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 119 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 120 <B>Constructor Summary</B></FONT></TH>\r
 121 </TR>\r
 122 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 123 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#EXIDecoder()">EXIDecoder</A></B>()</CODE>\r
 124 \r
 125 <BR>\r
 126 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an instance of EXIDecoder with the default inflator
 127  buffer size of 8192 bytes.</TD>\r
 128 </TR>\r
 129 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 130 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#EXIDecoder(int, boolean)">EXIDecoder</A></B>(int&nbsp;inflatorBufSize,\r
 131            boolean&nbsp;useThreadedInflater)</CODE>\r
 132 \r
 133 <BR>\r
 134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an instance of EXIDecoder with the specified inflator buffer
 135  size.</TD>\r
 136 </TR>\r
 137 </TABLE>\r
 138 &nbsp;\r
 139 <!-- ========== METHOD SUMMARY =========== -->\r
 140 \r
 141 <A NAME="method_summary"><!-- --></A>\r
 142 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 143 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 144 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 145 <B>Method Summary</B></FONT></TH>\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>&nbsp;<A HREF="../../../org/openexi/proc/io/Scanner.html" title="class in org.openexi.proc.io">Scanner</A></CODE></FONT></TD>\r
 150 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#processHeader()">processHeader</A></B>()</CODE>\r
 151 \r
 152 <BR>\r
 153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method reads and configures any header options present
 154  in the EXI stream, then returns a <A HREF="../../../org/openexi/proc/io/Scanner.html" title="class in org.openexi.proc.io"><CODE>Scanner</CODE></A>
 155  object you can use to parse the values from the EXI stream.</TD>\r
 156 </TR>\r
 157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 159 <CODE>&nbsp;void</CODE></FONT></TD>\r
 160 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.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
 161 \r
 162 <BR>\r
 163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the bit alignment style of the stream to be decoded.</TD>\r
 164 </TR>\r
 165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 167 <CODE>&nbsp;void</CODE></FONT></TD>\r
 168 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#setBlockSize(int)">setBlockSize</A></B>(int&nbsp;blockSize)</CODE>\r
 169 \r
 170 <BR>\r
 171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the size, in number of values, of the information that will be
 172  processed as a chunk of the entire EXI stream.</TD>\r
 173 </TR>\r
 174 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 176 <CODE>&nbsp;void</CODE></FONT></TD>\r
 177 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.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
 178                              int&nbsp;n_bindings)</CODE>\r
 179 \r
 180 <BR>\r
 181 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a datatype representation map (DTRM).</TD>\r
 182 </TR>\r
 183 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 185 <CODE>&nbsp;void</CODE></FONT></TD>\r
 186 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#setEnableBinaryData(boolean)">setEnableBinaryData</A></B>(boolean&nbsp;enable)</CODE>\r
 187 \r
 188 <BR>\r
 189 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Each binary value will be returned as in a EventDescription of EVENT_BLOB
 190  instead of EVENT_CH when enabled.</TD>\r
 191 </TR>\r
 192 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 194 <CODE>&nbsp;void</CODE></FONT></TD>\r
 195 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#setFragment(boolean)">setFragment</A></B>(boolean&nbsp;isFragment)</CODE>\r
 196 \r
 197 <BR>\r
 198 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set whether the document is a fragment.</TD>\r
 199 </TR>\r
 200 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 202 <CODE>&nbsp;void</CODE></FONT></TD>\r
 203 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#setGrammarCache(org.openexi.proc.grammars.GrammarCache)">setGrammarCache</A></B>(<A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars">GrammarCache</A>&nbsp;grammarCache)</CODE>\r
 204 \r
 205 <BR>\r
 206 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the GrammarCache used in decoding EXI streams.</TD>\r
 207 </TR>\r
 208 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 210 <CODE>&nbsp;void</CODE></FONT></TD>\r
 211 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#setInitialBinaryDataBufferSize(int)">setInitialBinaryDataBufferSize</A></B>(int&nbsp;initialSize)</CODE>\r
 212 \r
 213 <BR>\r
 214 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 215 </TR>\r
 216 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 217 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 218 <CODE>&nbsp;void</CODE></FONT></TD>\r
 219 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#setInputStream(java.io.InputStream)">setInputStream</A></B>(java.io.InputStream&nbsp;istream)</CODE>\r
 220 \r
 221 <BR>\r
 222 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set an input stream from which the encoded stream is read.</TD>\r
 223 </TR>\r
 224 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 225 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 226 <CODE>&nbsp;void</CODE></FONT></TD>\r
 227 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#setPreserveLexicalValues(boolean)">setPreserveLexicalValues</A></B>(boolean&nbsp;preserveLexicalValues)</CODE>\r
 228 \r
 229 <BR>\r
 230 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to <i>true</i> to preserve the original string values from the EXI
 231  stream.</TD>\r
 232 </TR>\r
 233 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 235 <CODE>&nbsp;void</CODE></FONT></TD>\r
 236 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#setValueMaxLength(int)">setValueMaxLength</A></B>(int&nbsp;valueMaxLength)</CODE>\r
 237 \r
 238 <BR>\r
 239 &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
 240  String Table.</TD>\r
 241 </TR>\r
 242 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 243 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 244 <CODE>&nbsp;void</CODE></FONT></TD>\r
 245 <TD><CODE><B><A HREF="../../../org/openexi/proc/EXIDecoder.html#setValuePartitionCapacity(int)">setValuePartitionCapacity</A></B>(int&nbsp;valuePartitionCapacity)</CODE>\r
 246 \r
 247 <BR>\r
 248 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the maximum number of values in the String Table.</TD>\r
 249 </TR>\r
 250 </TABLE>\r
 251 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 252 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 253 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 254 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
 255 </TR>\r
 256 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 257 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 258 </TR>\r
 259 </TABLE>\r
 260 &nbsp;\r
 261 <P>\r
 262 \r
 263 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 264 \r
 265 <A NAME="constructor_detail"><!-- --></A>\r
 266 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 267 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 268 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 269 <B>Constructor Detail</B></FONT></TH>\r
 270 </TR>\r
 271 </TABLE>\r
 272 \r
 273 <A NAME="EXIDecoder()"><!-- --></A><H3>\r
 274 EXIDecoder</H3>\r
 275 <PRE>\r
 276 public <B>EXIDecoder</B>()</PRE>\r
 277 <DL>\r
 278 <DD>Creates an instance of EXIDecoder with the default inflator
 279  buffer size of 8192 bytes.  Buffer size is only used when
 280  the EXI stream is encoded with EXI compression.\r
 281 <P>\r
 282 </DL>\r
 283 <HR>\r
 284 \r
 285 <A NAME="EXIDecoder(int, boolean)"><!-- --></A><H3>\r
 286 EXIDecoder</H3>\r
 287 <PRE>\r
 288 public <B>EXIDecoder</B>(int&nbsp;inflatorBufSize,\r
 289                   boolean&nbsp;useThreadedInflater)</PRE>\r
 290 <DL>\r
 291 <DD>Creates an instance of EXIDecoder with the specified inflator buffer
 292  size. When dynamic memory is limited on the target device, reducing
 293  the buffer size can improve performance and avoid runtime errors. Buffer
 294  size is only used when the EXI stream is encoded with EXI compression.\r
 295 <P>\r
 296 <DL>\r
 297 <DT><B>Parameters:</B><DD><CODE>inflatorBufSize</CODE> - size of the buffer, in bytes.<DD><CODE>useThreadedInflater</CODE> - Inflater will be run in its own thread if true</DL>\r
 298 </DL>\r
 299 \r
 300 <!-- ============ METHOD DETAIL ========== -->\r
 301 \r
 302 <A NAME="method_detail"><!-- --></A>\r
 303 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 304 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 305 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 306 <B>Method Detail</B></FONT></TH>\r
 307 </TR>\r
 308 </TABLE>\r
 309 \r
 310 <A NAME="setInputStream(java.io.InputStream)"><!-- --></A><H3>\r
 311 setInputStream</H3>\r
 312 <PRE>\r
 313 public final void <B>setInputStream</B>(java.io.InputStream&nbsp;istream)</PRE>\r
 314 <DL>\r
 315 <DD>Set an input stream from which the encoded stream is read.\r
 316 <P>\r
 317 <DD><DL>\r
 318 <DT><B>Parameters:</B><DD><CODE>istream</CODE> - InputSream to be read.</DL>\r
 319 </DD>\r
 320 </DL>\r
 321 <HR>\r
 322 \r
 323 <A NAME="setAlignmentType(org.openexi.proc.common.AlignmentType)"><!-- --></A><H3>\r
 324 setAlignmentType</H3>\r
 325 <PRE>\r
 326 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
 327                             throws org.openexi.proc.common.EXIOptionsException</PRE>\r
 328 <DL>\r
 329 <DD>Set the bit alignment style of the stream to be decoded.\r
 330 <P>\r
 331 <DD><DL>\r
 332 <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> object\r
 333 <DT><B>Throws:</B>\r
 334 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 335 </DD>\r
 336 </DL>\r
 337 <HR>\r
 338 \r
 339 <A NAME="setFragment(boolean)"><!-- --></A><H3>\r
 340 setFragment</H3>\r
 341 <PRE>\r
 342 public final void <B>setFragment</B>(boolean&nbsp;isFragment)</PRE>\r
 343 <DL>\r
 344 <DD>Set whether the document is a fragment. Fragments are nonstandard
 345  XML documents with multiple root elements. Default is false.\r
 346 <P>\r
 347 <DD><DL>\r
 348 <DT><B>Parameters:</B><DD><CODE>isFragment</CODE> - true if the stream is an XML fragment</DL>\r
 349 </DD>\r
 350 </DL>\r
 351 <HR>\r
 352 \r
 353 <A NAME="setGrammarCache(org.openexi.proc.grammars.GrammarCache)"><!-- --></A><H3>\r
 354 setGrammarCache</H3>\r
 355 <PRE>\r
 356 public final void <B>setGrammarCache</B>(<A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars">GrammarCache</A>&nbsp;grammarCache)\r
 357                            throws org.openexi.proc.common.EXIOptionsException</PRE>\r
 358 <DL>\r
 359 <DD>Set the GrammarCache used in decoding EXI streams.\r
 360 <P>\r
 361 <DD><DL>\r
 362 <DT><B>Parameters:</B><DD><CODE>grammarCache</CODE> - <A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars"><CODE>GrammarCache</CODE></A>\r
 363 <DT><B>Throws:</B>\r
 364 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 365 </DD>\r
 366 </DL>\r
 367 <HR>\r
 368 \r
 369 <A NAME="setBlockSize(int)"><!-- --></A><H3>\r
 370 setBlockSize</H3>\r
 371 <PRE>\r
 372 public final void <B>setBlockSize</B>(int&nbsp;blockSize)\r
 373                         throws org.openexi.proc.common.EXIOptionsException</PRE>\r
 374 <DL>\r
 375 <DD>Set the size, in number of values, of the information that will be
 376  processed as a chunk of the entire EXI stream. Reducing the block size
 377  can improve performance for devices with limited dynamic memory.
 378  Default is 1,000,000 items (not 1MB, but 1,000,000 complete Attribute
 379  and Element values). Block size is only used when the EXI stream is
 380  encoded with EXI-compression.\r
 381 <P>\r
 382 <DD><DL>\r
 383 <DT><B>Parameters:</B><DD><CODE>blockSize</CODE> - number of values in each processing block. Default is 1,000,000.\r
 384 <DT><B>Throws:</B>\r
 385 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 386 </DD>\r
 387 </DL>\r
 388 <HR>\r
 389 \r
 390 <A NAME="setValueMaxLength(int)"><!-- --></A><H3>\r
 391 setValueMaxLength</H3>\r
 392 <PRE>\r
 393 public final void <B>setValueMaxLength</B>(int&nbsp;valueMaxLength)</PRE>\r
 394 <DL>\r
 395 <DD>Set the maximum length of a string that will be stored for reuse in the
 396  String Table. By default, there is no maximum length. However, in data
 397  sets that have long, unique strings of information, you can improve
 398  performance by limiting the size to the length of strings that are more
 399  likely to appear more than once.\r
 400 <P>\r
 401 <DD><DL>\r
 402 <DT><B>Parameters:</B><DD><CODE>valueMaxLength</CODE> - maximum length of entries in the String Table.</DL>\r
 403 </DD>\r
 404 </DL>\r
 405 <HR>\r
 406 \r
 407 <A NAME="setValuePartitionCapacity(int)"><!-- --></A><H3>\r
 408 setValuePartitionCapacity</H3>\r
 409 <PRE>\r
 410 public final void <B>setValuePartitionCapacity</B>(int&nbsp;valuePartitionCapacity)</PRE>\r
 411 <DL>\r
 412 <DD>Set the maximum number of values in the String Table. By default, there
 413  is no limit. If the target device has limited dynamic memory, limiting
 414  the number of entries in the String Table can improve performance and
 415  reduce the likelihood that you will exceed memory capacity.\r
 416 <P>\r
 417 <DD><DL>\r
 418 <DT><B>Parameters:</B><DD><CODE>valuePartitionCapacity</CODE> - maximum number of entries in the String Table</DL>\r
 419 </DD>\r
 420 </DL>\r
 421 <HR>\r
 422 \r
 423 <A NAME="setPreserveLexicalValues(boolean)"><!-- --></A><H3>\r
 424 setPreserveLexicalValues</H3>\r
 425 <PRE>\r
 426 public final void <B>setPreserveLexicalValues</B>(boolean&nbsp;preserveLexicalValues)\r
 427                                     throws org.openexi.proc.common.EXIOptionsException</PRE>\r
 428 <DL>\r
 429 <DD>Set to <i>true</i> to preserve the original string values from the EXI
 430  stream. For example, a date string might be converted to a different
 431  format when interpreted by the EXIDecoder. Preserving the lexical values
 432  ensures that the identical strings are restored, and not just their
 433  logical values.\r
 434 <P>\r
 435 <DD><DL>\r
 436 <DT><B>Parameters:</B><DD><CODE>preserveLexicalValues</CODE> - true to keep original strings intact\r
 437 <DT><B>Throws:</B>\r
 438 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 439 </DD>\r
 440 </DL>\r
 441 <HR>\r
 442 \r
 443 <A NAME="setDatatypeRepresentationMap(org.openexi.proc.common.QName[], int)"><!-- --></A><H3>\r
 444 setDatatypeRepresentationMap</H3>\r
 445 <PRE>\r
 446 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
 447                                                int&nbsp;n_bindings)\r
 448                                         throws org.openexi.proc.common.EXIOptionsException</PRE>\r
 449 <DL>\r
 450 <DD>Set a datatype representation map (DTRM). The DTRM allows you to remap
 451  XMLSchema datatypes to EXI datatypes other than their default equivalents.
 452  The map is created using a sequence of Qualified Name pairs that identify
 453  a datatype definition in the XMLSchema namespace followed by the new
 454  corresponding datatype mapping in the EXI namespace.
 455  <br /><br />
 456  For example, the following lines map the boolean datatype from XMLSchema
 457  to the integer datatype in EXI.
 458  <pre>
 459    QName q1 = new QName("xsd:boolean","http://www.w3.org/2001/XMLSchema");
 460    QName q2 = new QName("exi:integer","http://www.w3.org/2009/exi");
 461    QName[] dtrm = new QName[2];
 462    dtrm = {q1, q2}; // Each mapping requires 2 qualified names.
 463    decoderInstance.setDatatypeRepresentationMap(dtrm, 1); // The array, and the number of pairs (1).
 464  </pre>\r
 465 <P>\r
 466 <DD><DL>\r
 467 <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
 468 <DT><B>Throws:</B>\r
 469 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 470 </DD>\r
 471 </DL>\r
 472 <HR>\r
 473 \r
 474 <A NAME="setEnableBinaryData(boolean)"><!-- --></A><H3>\r
 475 setEnableBinaryData</H3>\r
 476 <PRE>\r
 477 public final void <B>setEnableBinaryData</B>(boolean&nbsp;enable)</PRE>\r
 478 <DL>\r
 479 <DD>Each binary value will be returned as in a EventDescription of EVENT_BLOB
 480  instead of EVENT_CH when enabled.\r
 481 <P>\r
 482 <DD><DL>\r
 483 <DT><B>Parameters:</B><DD><CODE>enable</CODE> - </DL>\r
 484 </DD>\r
 485 </DL>\r
 486 <HR>\r
 487 \r
 488 <A NAME="setInitialBinaryDataBufferSize(int)"><!-- --></A><H3>\r
 489 setInitialBinaryDataBufferSize</H3>\r
 490 <PRE>\r
 491 public final void <B>setInitialBinaryDataBufferSize</B>(int&nbsp;initialSize)</PRE>\r
 492 <DL>\r
 493 <DD><DL>\r
 494 </DL>\r
 495 </DD>\r
 496 </DL>\r
 497 <HR>\r
 498 \r
 499 <A NAME="processHeader()"><!-- --></A><H3>\r
 500 processHeader</H3>\r
 501 <PRE>\r
 502 public <A HREF="../../../org/openexi/proc/io/Scanner.html" title="class in org.openexi.proc.io">Scanner</A> <B>processHeader</B>()\r
 503                       throws java.io.IOException,\r
 504                              org.openexi.proc.common.EXIOptionsException</PRE>\r
 505 <DL>\r
 506 <DD>This method reads and configures any header options present
 507  in the EXI stream, then returns a <A HREF="../../../org/openexi/proc/io/Scanner.html" title="class in org.openexi.proc.io"><CODE>Scanner</CODE></A>
 508  object you can use to parse the values from the EXI stream.\r
 509 <P>\r
 510 <DD><DL>\r
 511 \r
 512 <DT><B>Returns:</B><DD>Scanner parsable object with header options applied.\r
 513 <DT><B>Throws:</B>\r
 514 <DD><CODE>java.io.IOException</CODE>\r
 515 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>\r
 516 </DD>\r
 517 </DL>\r
 518 <!-- ========= END OF CLASS DATA ========= -->\r
 519 <HR>\r
 520 \r
 521 \r
 522 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 523 <A NAME="navbar_bottom"><!-- --></A>\r
 524 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 525 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 526 <TR>\r
 527 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 528 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 529 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 530   <TR ALIGN="center" VALIGN="top">\r
 531   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 532   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 533   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 534   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 535   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 536   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 537   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 538   </TR>\r
 539 </TABLE>\r
 540 </TD>\r
 541 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 542 </EM>\r
 543 </TD>\r
 544 </TR>\r
 545 \r
 546 <TR>\r
 547 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 548 &nbsp;PREV CLASS&nbsp;\r
 549 &nbsp;<A HREF="../../../org/openexi/proc/EXISchemaResolver.html" title="interface in org.openexi.proc"><B>NEXT CLASS</B></A></FONT></TD>\r
 550 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 551   <A HREF="../../../index.html?org/openexi/proc/EXIDecoder.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 552 &nbsp;<A HREF="EXIDecoder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 553 &nbsp;<SCRIPT type="text/javascript">\r
 554   <!--\r
 555   if(window==top) {\r
 556     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 557   }\r
 558   //-->\r
 559 </SCRIPT>\r
 560 <NOSCRIPT>\r
 561   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 562 </NOSCRIPT>\r
 563 \r
 564 \r
 565 </FONT></TD>\r
 566 </TR>\r
 567 <TR>\r
 568 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 569   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
 570 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 571 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 572 </TR>\r
 573 </TABLE>\r
 574 <A NAME="skip-navbar_bottom"></A>\r
 575 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 576 \r
 577 <HR>\r
 578 \r
 579 </BODY>\r
 580 </HTML>\r