1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\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
11 <META NAME="keywords" CONTENT="org.openexi.proc.common.EXIOptions class">
\r
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
\r
15 <SCRIPT type="text/javascript">
\r
16 function windowTitle()
\r
18 parent.document.title="EXIOptions";
\r
26 <BODY BGCOLOR="white" onload="windowTitle();">
\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
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> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../../../org/openexi/proc/common/EventType.html" title="class in org.openexi.proc.common"><B>PREV CLASS</B></A>
\r
56 <A HREF="../../../../org/openexi/proc/common/GrammarOptions.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/EXIOptions.html" target="_top"><B>FRAMES</B></A>
\r
59 <A HREF="EXIOptions.html" target="_top"><B>NO FRAMES</B></A>
\r
60 <SCRIPT type="text/javascript">
\r
63 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
68 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
76 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
78 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
81 <A NAME="skip-navbar_top"></A>
\r
82 <!-- ========= END OF TOP NAVBAR ========= -->
\r
85 <!-- ======== START OF CLASS DATA ======== -->
\r
88 org.openexi.proc.common</FONT>
\r
90 Class EXIOptions</H2>
\r
93 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.proc.common.EXIOptions</B>
\r
97 <DT><PRE>public final class <B>EXIOptions</B><DT>extends java.lang.Object</DL>
\r
101 EXIOptions provides accessors for values associated with
102 EXI options in the EXI header of an EXI stream.
\r
107 <!-- yWorks UML Doclet http://www.yworks.com/ b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
113 <!-- ========== METHOD SUMMARY =========== -->
\r
115 <A NAME="method_summary"><!-- --></A>
\r
116 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
117 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
118 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
119 <B>Method Summary</B></FONT></TH>
\r
121 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
122 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
123 <CODE> <A HREF="../../../../org/openexi/proc/common/AlignmentType.html" title="enum in org.openexi.proc.common">AlignmentType</A></CODE></FONT></TD>
\r
124 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getAlignmentType()">getAlignmentType</A></B>()</CODE>
\r
127 Get the bit alignment setting.</TD>
\r
129 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
130 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
131 <CODE> int</CODE></FONT></TD>
\r
132 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getBlockSize()">getBlockSize</A></B>()</CODE>
\r
135 Returns the number of element and attribute values that are read and processed
138 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
139 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
140 <CODE> <A HREF="../../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common">QName</A>[]</CODE></FONT></TD>
\r
141 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getDatatypeRepresentationMap()">getDatatypeRepresentationMap</A></B>()</CODE>
\r
144 Returns an array of qualified names that map XMLSchema datatypes to
145 non-standard equivalents in EXI.</TD>
\r
147 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
149 <CODE> int</CODE></FONT></TD>
\r
150 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getDatatypeRepresentationMapBindingsCount()">getDatatypeRepresentationMapBindingsCount</A></B>()</CODE>
\r
153 Returns the number of Datatype Representation Map QName pairs.</TD>
\r
155 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
157 <CODE> boolean</CODE></FONT></TD>
\r
158 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getPreserveComments()">getPreserveComments</A></B>()</CODE>
\r
161 Returns whether comments are conserved in the EXI Stream.</TD>
\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
165 <CODE> boolean</CODE></FONT></TD>
\r
166 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getPreserveDTD()">getPreserveDTD</A></B>()</CODE>
\r
169 Returns whether the document type definition is conserved in the EXI Stream.</TD>
\r
171 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
173 <CODE> boolean</CODE></FONT></TD>
\r
174 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getPreserveLexicalValues()">getPreserveLexicalValues</A></B>()</CODE>
\r
177 Returns whether lexical values (literal strings) are preserved rather
178 than the logical values of elements and attributes.</TD>
\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
182 <CODE> boolean</CODE></FONT></TD>
\r
183 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getPreserveNS()">getPreserveNS</A></B>()</CODE>
\r
186 Returns whether the namespaces are preserved in the EXI stream.</TD>
\r
188 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
190 <CODE> boolean</CODE></FONT></TD>
\r
191 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getPreservePIs()">getPreservePIs</A></B>()</CODE>
\r
194 Returns whether processing instructions are conserved in the EXI Stream.</TD>
\r
196 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
197 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
198 <CODE> int</CODE></FONT></TD>
\r
199 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getValueMaxLength()">getValueMaxLength</A></B>()</CODE>
\r
202 Returns the maximum length in characters of strings that will be included
203 in the String Table.</TD>
\r
205 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
207 <CODE> int</CODE></FONT></TD>
\r
208 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#getValuePartitionCapacity()">getValuePartitionCapacity</A></B>()</CODE>
\r
211 Returns the maximum number of entries in the String Table.</TD>
\r
213 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
215 <CODE> boolean</CODE></FONT></TD>
\r
216 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#isFragment()">isFragment</A></B>()</CODE>
\r
219 An XML fragment is a non-compliant XML document with multiple root
222 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
224 <CODE> boolean</CODE></FONT></TD>
\r
225 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/EXIOptions.html#isStrict()">isStrict</A></B>()</CODE>
\r
228 The Strict option applies to streams that have an associated XML Schema
229 and the data in the XML stream is 100% compliant with the schema.</TD>
\r
232 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
233 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
234 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
235 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
237 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
238 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
244 <!-- ============ METHOD DETAIL ========== -->
\r
246 <A NAME="method_detail"><!-- --></A>
\r
247 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
248 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
249 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
250 <B>Method Detail</B></FONT></TH>
\r
254 <A NAME="getAlignmentType()"><!-- --></A><H3>
\r
255 getAlignmentType</H3>
\r
257 public <A HREF="../../../../org/openexi/proc/common/AlignmentType.html" title="enum in org.openexi.proc.common">AlignmentType</A> <B>getAlignmentType</B>()</PRE>
\r
259 <DD>Get the bit alignment setting.
\r
263 <DT><B>Returns:</B><DD><A HREF="../../../../org/openexi/proc/common/AlignmentType.html" title="enum in org.openexi.proc.common"><CODE>AlignmentType</CODE></A></DL>
\r
268 <A NAME="isFragment()"><!-- --></A><H3>
\r
271 public boolean <B>isFragment</B>()</PRE>
\r
273 <DD>An XML fragment is a non-compliant XML document with multiple root
278 <DT><B>Returns:</B><DD><i>true</i> if the stream is an XML fragment.</DL>
\r
283 <A NAME="isStrict()"><!-- --></A><H3>
\r
286 public boolean <B>isStrict</B>()</PRE>
\r
288 <DD>The Strict option applies to streams that have an associated XML Schema
289 and the data in the XML stream is 100% compliant with the schema.
\r
293 <DT><B>Returns:</B><DD><i>true</i> if using strict interpretation of an associated XML Schema.</DL>
\r
298 <A NAME="getPreserveComments()"><!-- --></A><H3>
\r
299 getPreserveComments</H3>
\r
301 public boolean <B>getPreserveComments</B>()</PRE>
\r
303 <DD>Returns whether comments are conserved in the EXI Stream.
\r
307 <DT><B>Returns:</B><DD><i>true</i> if comments are preserved.</DL>
\r
312 <A NAME="getPreservePIs()"><!-- --></A><H3>
\r
313 getPreservePIs</H3>
\r
315 public boolean <B>getPreservePIs</B>()</PRE>
\r
317 <DD>Returns whether processing instructions are conserved in the EXI Stream.
\r
321 <DT><B>Returns:</B><DD><i>true</i> if processing instructions are preserved.</DL>
\r
326 <A NAME="getPreserveDTD()"><!-- --></A><H3>
\r
327 getPreserveDTD</H3>
\r
329 public boolean <B>getPreserveDTD</B>()</PRE>
\r
331 <DD>Returns whether the document type definition is conserved in the EXI Stream.
\r
335 <DT><B>Returns:</B><DD><i>true</i> if the document type definition is preserved.</DL>
\r
340 <A NAME="getPreserveNS()"><!-- --></A><H3>
\r
343 public boolean <B>getPreserveNS</B>()</PRE>
\r
345 <DD>Returns whether the namespaces are preserved in the EXI stream.
\r
349 <DT><B>Returns:</B><DD><i>true</i> if namespaces are preserved.</DL>
\r
354 <A NAME="getBlockSize()"><!-- --></A><H3>
\r
357 public int <B>getBlockSize</B>()</PRE>
\r
359 <DD>Returns the number of element and attribute values that are read and processed
364 <DT><B>Returns:</B><DD>the current block size. Default is 1,000,000.</DL>
\r
369 <A NAME="getValueMaxLength()"><!-- --></A><H3>
\r
370 getValueMaxLength</H3>
\r
372 public int <B>getValueMaxLength</B>()</PRE>
\r
374 <DD>Returns the maximum length in characters of strings that will be included
375 in the String Table.
\r
379 <DT><B>Returns:</B><DD>the maximum length of values added to the String Table. Default is unbounded (-1).</DL>
\r
384 <A NAME="getValuePartitionCapacity()"><!-- --></A><H3>
\r
385 getValuePartitionCapacity</H3>
\r
387 public int <B>getValuePartitionCapacity</B>()</PRE>
\r
389 <DD>Returns the maximum number of entries in the String Table.
\r
393 <DT><B>Returns:</B><DD>the maximum number of partitions (entries) in the String Table. Default is unbounded (-1).</DL>
\r
398 <A NAME="getPreserveLexicalValues()"><!-- --></A><H3>
\r
399 getPreserveLexicalValues</H3>
\r
401 public boolean <B>getPreserveLexicalValues</B>()</PRE>
\r
403 <DD>Returns whether lexical values (literal strings) are preserved rather
404 than the logical values of elements and attributes.
\r
408 <DT><B>Returns:</B><DD><i>true</i> if lexical values are preserved.</DL>
\r
413 <A NAME="getDatatypeRepresentationMapBindingsCount()"><!-- --></A><H3>
\r
414 getDatatypeRepresentationMapBindingsCount</H3>
\r
416 public int <B>getDatatypeRepresentationMapBindingsCount</B>()</PRE>
\r
418 <DD>Returns the number of Datatype Representation Map QName pairs.
\r
422 <DT><B>Returns:</B><DD>the number of DTRM bindings.</DL>
\r
427 <A NAME="getDatatypeRepresentationMap()"><!-- --></A><H3>
\r
428 getDatatypeRepresentationMap</H3>
\r
430 public <A HREF="../../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common">QName</A>[] <B>getDatatypeRepresentationMap</B>()</PRE>
\r
432 <DD>Returns an array of qualified names that map XMLSchema datatypes to
433 non-standard equivalents in EXI.
\r
437 <DT><B>Returns:</B><DD>an array of qualified names comprising a DTRM.</DL>
\r
440 <!-- ========= END OF CLASS DATA ========= -->
\r
444 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
445 <A NAME="navbar_bottom"><!-- --></A>
\r
446 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
447 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
449 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
450 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
451 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
452 <TR ALIGN="center" VALIGN="top">
\r
453 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
454 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
455 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
456 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
457 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
458 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
459 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
463 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
469 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
470 <A HREF="../../../../org/openexi/proc/common/EventType.html" title="class in org.openexi.proc.common"><B>PREV CLASS</B></A>
\r
471 <A HREF="../../../../org/openexi/proc/common/GrammarOptions.html" title="class in org.openexi.proc.common"><B>NEXT CLASS</B></A></FONT></TD>
\r
472 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
473 <A HREF="../../../../index.html?org/openexi/proc/common/EXIOptions.html" target="_top"><B>FRAMES</B></A>
\r
474 <A HREF="EXIOptions.html" target="_top"><B>NO FRAMES</B></A>
\r
475 <SCRIPT type="text/javascript">
\r
478 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
483 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
490 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
491 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
492 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
493 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
496 <A NAME="skip-navbar_bottom"></A>
\r
497 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r