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.sax.Transmogrifier 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="Transmogrifier";
\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/sax/SAXTransmogrifier.html" title="interface in org.openexi.sax"><B>PREV CLASS</B></A>
\r
56 <A HREF="../../../org/openexi/sax/TransmogrifierException.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/Transmogrifier.html" target="_top"><B>FRAMES</B></A>
\r
59 <A HREF="Transmogrifier.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
78 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.sax</FONT>
\r
90 Class Transmogrifier</H2>
\r
93 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.sax.Transmogrifier</B>
\r
97 <DT><PRE>public final class <B>Transmogrifier</B><DT>extends java.lang.Object</DL>
\r
101 The Transmogrifier converts an XML stream to an EXI stream.
\r
106 <!-- yWorks UML Doclet http://www.yworks.com/ b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
112 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
114 <A NAME="constructor_summary"><!-- --></A>
\r
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
117 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
118 <B>Constructor Summary</B></FONT></TH>
\r
120 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
121 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#Transmogrifier()">Transmogrifier</A></B>()</CODE>
\r
124 Create an instance of the Transmogrifier with a default SAX parser.</TD>
\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
127 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#Transmogrifier(javax.xml.parsers.SAXParserFactory)">Transmogrifier</A></B>(javax.xml.parsers.SAXParserFactory saxParserFactory)</CODE>
\r
130 Create an instance of the Transmogrifier, specifying the SAXParserFactory
131 from which to create the SAX parser.</TD>
\r
135 <!-- ========== METHOD SUMMARY =========== -->
\r
137 <A NAME="method_summary"><!-- --></A>
\r
138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
140 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
141 <B>Method Summary</B></FONT></TH>
\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
145 <CODE> void</CODE></FONT></TD>
\r
146 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#encode(org.xml.sax.InputSource)">encode</A></B>(org.xml.sax.InputSource is)</CODE>
\r
149 Parses XML input source and converts it to an EXI stream.</TD>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
153 <CODE> <A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars">GrammarCache</A></CODE></FONT></TD>
\r
154 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#getGrammarCache()">getGrammarCache</A></B>()</CODE>
\r
157 Returns the GrammarCache that was previously set.</TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
161 <CODE> <A HREF="../../../org/openexi/sax/SAXTransmogrifier.html" title="interface in org.openexi.sax">SAXTransmogrifier</A></CODE></FONT></TD>
\r
162 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#getSAXTransmogrifier()">getSAXTransmogrifier</A></B>()</CODE>
\r
165 Returns the SAXTransmogrifier, which implements both the ContentHandler
166 and LexicalHandler.</TD>
\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
170 <CODE> void</CODE></FONT></TD>
\r
171 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.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> alignmentType)</CODE>
\r
174 Set the bit alignment style for the encoded EXI stream.</TD>
\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
178 <CODE> void</CODE></FONT></TD>
\r
179 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setBlockSize(int)">setBlockSize</A></B>(int blockSize)</CODE>
\r
182 Set the size, in number of values, of the information that will be
183 processed as a chunk of the entire XML stream.</TD>
\r
185 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
186 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
187 <CODE> void</CODE></FONT></TD>
\r
188 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.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>[] dtrm,
\r
189 int n_bindings)</CODE>
\r
192 Set a datatype representation map (DTRM).</TD>
\r
194 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
196 <CODE> void</CODE></FONT></TD>
\r
197 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setEntityResolver(org.xml.sax.EntityResolver)">setEntityResolver</A></B>(org.xml.sax.EntityResolver entityResolver)</CODE>
\r
200 Set an external SAX entity resolver.</TD>
\r
202 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
203 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
204 <CODE> void</CODE></FONT></TD>
\r
205 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setFragment(boolean)">setFragment</A></B>(boolean isFragment)</CODE>
\r
208 Set to true if the XML input stream is an XML fragment (a non-compliant
209 XML document with multiple root elements).</TD>
\r
211 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
213 <CODE> void</CODE></FONT></TD>
\r
214 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.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> grammarCache)</CODE>
\r
217 Set the GrammarCache used in transmogrifying XML data to EXI.</TD>
\r
219 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
221 <CODE> void</CODE></FONT></TD>
\r
222 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setGrammarCache(org.openexi.proc.grammars.GrammarCache, org.openexi.proc.common.SchemaId)">setGrammarCache</A></B>(<A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars">GrammarCache</A> grammarCache,
\r
223 org.openexi.proc.common.SchemaId schemaId)</CODE>
\r
226 Set the GrammarCache to be used in encoding XML streams into EXI streams
227 by the transmogrifier.</TD>
\r
229 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
231 <CODE> void</CODE></FONT></TD>
\r
232 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setOutputCookie(boolean)">setOutputCookie</A></B>(boolean outputCookie)</CODE>
\r
235 Tells the encoder whether to or not to start the stream by
236 adding an EXI cookie.</TD>
\r
238 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
239 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
240 <CODE> void</CODE></FONT></TD>
\r
241 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setOutputOptions(org.openexi.proc.HeaderOptionsOutputType)">setOutputOptions</A></B>(<A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A> outputOptions)</CODE>
\r
244 Set the header output options.</TD>
\r
246 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
247 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
248 <CODE> void</CODE></FONT></TD>
\r
249 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setOutputStream(java.io.OutputStream)">setOutputStream</A></B>(java.io.OutputStream ostream)</CODE>
\r
252 Set an output stream to which encoded streams are written.</TD>
\r
254 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
255 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
256 <CODE> void</CODE></FONT></TD>
\r
257 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setPreserveLexicalValues(boolean)">setPreserveLexicalValues</A></B>(boolean preserveLexicalValues)</CODE>
\r
260 Set to <i>true</i> to preserve the original string values from the XML
263 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
264 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
265 <CODE> void</CODE></FONT></TD>
\r
266 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setPreserveWhitespaces(boolean)">setPreserveWhitespaces</A></B>(boolean preserveWhitespaces)</CODE>
\r
269 Set to true to preserve whitespace (for example, spaces, tabs, and
270 line breaks) in the encoded EXI stream.</TD>
\r
272 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
273 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
274 <CODE> void</CODE></FONT></TD>
\r
275 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setResolveExternalGeneralEntities(boolean)">setResolveExternalGeneralEntities</A></B>(boolean resolveExternalGeneralEntities)</CODE>
\r
278 Change the way a Transmogrifier handles external general entities.</TD>
\r
280 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
281 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
282 <CODE> void</CODE></FONT></TD>
\r
283 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setValueMaxLength(int)">setValueMaxLength</A></B>(int valueMaxLength)</CODE>
\r
286 Set the maximum length of a string that will be stored for reuse in the
289 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
290 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
291 <CODE> void</CODE></FONT></TD>
\r
292 <TD><CODE><B><A HREF="../../../org/openexi/sax/Transmogrifier.html#setValuePartitionCapacity(int)">setValuePartitionCapacity</A></B>(int valuePartitionCapacity)</CODE>
\r
295 Set the maximum number of values in the String Table.</TD>
\r
298 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
299 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
300 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
301 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
303 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
304 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
310 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
312 <A NAME="constructor_detail"><!-- --></A>
\r
313 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
314 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
315 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
316 <B>Constructor Detail</B></FONT></TH>
\r
320 <A NAME="Transmogrifier()"><!-- --></A><H3>
\r
321 Transmogrifier</H3>
\r
323 public <B>Transmogrifier</B>()
\r
324 throws org.openexi.sax.TransmogrifierRuntimeException</PRE>
\r
326 <DD>Create an instance of the Transmogrifier with a default SAX parser.
\r
331 <DD><CODE><A HREF="../../../org/openexi/sax/TransmogrifierException.html" title="class in org.openexi.sax">TransmogrifierException</A></CODE>
\r
332 <DD><CODE>org.openexi.sax.TransmogrifierRuntimeException</CODE></DL>
\r
336 <A NAME="Transmogrifier(javax.xml.parsers.SAXParserFactory)"><!-- --></A><H3>
\r
337 Transmogrifier</H3>
\r
339 public <B>Transmogrifier</B>(javax.xml.parsers.SAXParserFactory saxParserFactory)
\r
340 throws org.openexi.sax.TransmogrifierRuntimeException</PRE>
\r
342 <DD>Create an instance of the Transmogrifier, specifying the SAXParserFactory
343 from which to create the SAX parser.
\r
346 <DT><B>Parameters:</B><DD><CODE>saxParserFactory</CODE> -
\r
348 <DD><CODE><A HREF="../../../org/openexi/sax/TransmogrifierException.html" title="class in org.openexi.sax">TransmogrifierException</A></CODE>
\r
349 <DD><CODE>org.openexi.sax.TransmogrifierRuntimeException</CODE></DL>
\r
352 <!-- ============ METHOD DETAIL ========== -->
\r
354 <A NAME="method_detail"><!-- --></A>
\r
355 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
356 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
357 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
358 <B>Method Detail</B></FONT></TH>
\r
362 <A NAME="setResolveExternalGeneralEntities(boolean)"><!-- --></A><H3>
\r
363 setResolveExternalGeneralEntities</H3>
\r
365 public void <B>setResolveExternalGeneralEntities</B>(boolean resolveExternalGeneralEntities)
\r
366 throws <A HREF="../../../org/openexi/sax/TransmogrifierException.html" title="class in org.openexi.sax">TransmogrifierException</A></PRE>
\r
368 <DD>Change the way a Transmogrifier handles external general entities. When the value
369 of resolveExternalGeneralEntities is set to true, a Transmogrifier will try to
370 resolve external general entities. Otherwise, external general entities will not
374 <DT><B>Parameters:</B><DD><CODE>resolveExternalGeneralEntities</CODE> -
\r
376 <DD><CODE><A HREF="../../../org/openexi/sax/TransmogrifierException.html" title="class in org.openexi.sax">TransmogrifierException</A></CODE> - Thrown when the underlying XMLReader does not
377 support the specified behavior.</DL>
\r
382 <A NAME="setOutputStream(java.io.OutputStream)"><!-- --></A><H3>
\r
383 setOutputStream</H3>
\r
385 public final void <B>setOutputStream</B>(java.io.OutputStream ostream)</PRE>
\r
387 <DD>Set an output stream to which encoded streams are written.
\r
390 <DT><B>Parameters:</B><DD><CODE>ostream</CODE> - output stream</DL>
\r
395 <A NAME="setAlignmentType(org.openexi.proc.common.AlignmentType)"><!-- --></A><H3>
\r
396 setAlignmentType</H3>
\r
398 public final void <B>setAlignmentType</B>(<A HREF="../../../org/openexi/proc/common/AlignmentType.html" title="enum in org.openexi.proc.common">AlignmentType</A> alignmentType)
\r
399 throws org.openexi.proc.common.EXIOptionsException</PRE>
\r
401 <DD>Set the bit alignment style for the encoded EXI stream.
\r
404 <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>.
405 Default is <i>bit-packed</i>.
\r
407 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>
\r
412 <A NAME="setFragment(boolean)"><!-- --></A><H3>
\r
415 public final void <B>setFragment</B>(boolean isFragment)</PRE>
\r
417 <DD>Set to true if the XML input stream is an XML fragment (a non-compliant
418 XML document with multiple root elements).
\r
421 <DT><B>Parameters:</B><DD><CODE>isFragment</CODE> - true if the XML input stream is an XML fragment.</DL>
\r
426 <A NAME="setBlockSize(int)"><!-- --></A><H3>
\r
429 public final void <B>setBlockSize</B>(int blockSize)
\r
430 throws org.openexi.proc.common.EXIOptionsException</PRE>
\r
432 <DD>Set the size, in number of values, of the information that will be
433 processed as a chunk of the entire XML stream. Reducing the block size
434 can improve performance for devices with limited dynamic memory.
435 Default is 1,000,000 items (not 1MB, but 1,000,000 complete Attribute
436 and Element values). Block size is only used when the EXI stream is
437 encoded with EXI-compression.
\r
440 <DT><B>Parameters:</B><DD><CODE>blockSize</CODE> - number of values in each processing block. Default is 1,000,000.
\r
442 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>
\r
447 <A NAME="setValueMaxLength(int)"><!-- --></A><H3>
\r
448 setValueMaxLength</H3>
\r
450 public final void <B>setValueMaxLength</B>(int valueMaxLength)</PRE>
\r
452 <DD>Set the maximum length of a string that will be stored for reuse in the
453 String Table. By default, there is no maximum length. However, in data
454 sets that have long, unique strings of information, you can improve
455 performance by limiting the size to the length of strings that are more
456 likely to appear more than once.
\r
459 <DT><B>Parameters:</B><DD><CODE>valueMaxLength</CODE> - maximum length of entries in the String Table.</DL>
\r
464 <A NAME="setValuePartitionCapacity(int)"><!-- --></A><H3>
\r
465 setValuePartitionCapacity</H3>
\r
467 public final void <B>setValuePartitionCapacity</B>(int valuePartitionCapacity)</PRE>
\r
469 <DD>Set the maximum number of values in the String Table. By default, there
470 is no limit. If the target device has limited dynamic memory, limiting
471 the number of entries in the String Table can improve performance and
472 reduce the likelihood that you will exceed memory capacity.
\r
475 <DT><B>Parameters:</B><DD><CODE>valuePartitionCapacity</CODE> - maximum number of entries in the String Table</DL>
\r
480 <A NAME="setPreserveLexicalValues(boolean)"><!-- --></A><H3>
\r
481 setPreserveLexicalValues</H3>
\r
483 public final void <B>setPreserveLexicalValues</B>(boolean preserveLexicalValues)
\r
484 throws org.openexi.proc.common.EXIOptionsException</PRE>
\r
486 <DD>Set to <i>true</i> to preserve the original string values from the XML
487 stream. For example, a date string might be converted to a different
488 format when interpreted by the Transmogrifier. Preserving the lexical values
489 ensures that the identical strings are restored, and not just their
493 <DT><B>Parameters:</B><DD><CODE>preserveLexicalValues</CODE> - <i>true</i> to keep original strings intact
\r
495 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>
\r
500 <A NAME="setGrammarCache(org.openexi.proc.grammars.GrammarCache)"><!-- --></A><H3>
\r
501 setGrammarCache</H3>
\r
503 public final void <B>setGrammarCache</B>(<A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars">GrammarCache</A> grammarCache)
\r
504 throws org.openexi.proc.common.EXIOptionsException</PRE>
\r
506 <DD>Set the GrammarCache used in transmogrifying XML data to EXI.
\r
509 <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
511 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>
\r
516 <A NAME="setGrammarCache(org.openexi.proc.grammars.GrammarCache, org.openexi.proc.common.SchemaId)"><!-- --></A><H3>
\r
517 setGrammarCache</H3>
\r
519 public final void <B>setGrammarCache</B>(<A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars">GrammarCache</A> grammarCache,
\r
520 org.openexi.proc.common.SchemaId schemaId)
\r
521 throws org.openexi.proc.common.EXIOptionsException</PRE>
\r
523 <DD>Set the GrammarCache to be used in encoding XML streams into EXI streams
524 by the transmogrifier.
525 The SchemaId contains the string that is written in the header when
526 <i>HeaderOptionsOutputType.all</i> is set.
\r
529 <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><DD><CODE>schemaId</CODE> -
\r
531 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>
\r
536 <A NAME="getGrammarCache()"><!-- --></A><H3>
\r
537 getGrammarCache</H3>
\r
539 public final <A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars">GrammarCache</A> <B>getGrammarCache</B>()</PRE>
\r
541 <DD>Returns the GrammarCache that was previously set.
\r
545 <DT><B>Returns:</B><DD>a GrammarCache</DL>
\r
550 <A NAME="setDatatypeRepresentationMap(org.openexi.proc.common.QName[], int)"><!-- --></A><H3>
\r
551 setDatatypeRepresentationMap</H3>
\r
553 public final void <B>setDatatypeRepresentationMap</B>(<A HREF="../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common">QName</A>[] dtrm,
\r
554 int n_bindings)
\r
555 throws org.openexi.proc.common.EXIOptionsException</PRE>
\r
557 <DD>Set a datatype representation map (DTRM). The DTRM allows you to remap
558 XMLSchema datatypes to EXI datatypes other than their default equivalents.
559 The map is created using a sequence of Qualified Name pairs that identify
560 a datatype definition in the XMLSchema namespace followed by the new
561 corresponding datatype mapping in the EXI namespace.
563 For example, the following lines map the boolean datatype from XMLSchema
564 to the integer datatype in EXI.
566 QName q1 = new QName("xsd:boolean","http://www.w3.org/2001/XMLSchema");
567 QName q2 = new QName("exi:integer","http://www.w3.org/2009/exi");
568 QName[] dtrm = new QName[2];
569 dtrm = {q1, q2}; // Each mapping requires 2 qualified names.
570 transmogrifierInstance.setDatatypeRepresentationMap(dtrm, 1); // The array, and the number of pairs (1).
574 <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
576 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>
\r
581 <A NAME="setEntityResolver(org.xml.sax.EntityResolver)"><!-- --></A><H3>
\r
582 setEntityResolver</H3>
\r
584 public final void <B>setEntityResolver</B>(org.xml.sax.EntityResolver entityResolver)</PRE>
\r
586 <DD>Set an external SAX entity resolver.
\r
589 <DT><B>Parameters:</B><DD><CODE>entityResolver</CODE> - <CODE>EntityResolver</CODE></DL>
\r
594 <A NAME="setOutputCookie(boolean)"><!-- --></A><H3>
\r
595 setOutputCookie</H3>
\r
597 public final void <B>setOutputCookie</B>(boolean outputCookie)</PRE>
\r
599 <DD>Tells the encoder whether to or not to start the stream by
600 adding an EXI cookie.
\r
603 <DT><B>Parameters:</B><DD><CODE>outputCookie</CODE> - <i>true</i> to include the EXI cookie</DL>
\r
608 <A NAME="setOutputOptions(org.openexi.proc.HeaderOptionsOutputType)"><!-- --></A><H3>
\r
609 setOutputOptions</H3>
\r
611 public final void <B>setOutputOptions</B>(<A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A> outputOptions)
\r
612 throws org.openexi.proc.common.EXIOptionsException</PRE>
\r
614 <DD>Set the header output options. Choices are set using the
615 <A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc"><CODE>HeaderOptionsOutputType</CODE></A> enumeration.
616 Options are <i>all, lessSchemaID</i> (that is, all values
617 except for the SchemaId), or <i>none.</i>
\r
620 <DT><B>Parameters:</B><DD><CODE>outputOptions</CODE> - <A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc"><CODE>HeaderOptionsOutputType</CODE></A>
\r
622 <DD><CODE>org.openexi.proc.common.EXIOptionsException</CODE></DL>
\r
627 <A NAME="setPreserveWhitespaces(boolean)"><!-- --></A><H3>
\r
628 setPreserveWhitespaces</H3>
\r
630 public final void <B>setPreserveWhitespaces</B>(boolean preserveWhitespaces)</PRE>
\r
632 <DD>Set to true to preserve whitespace (for example, spaces, tabs, and
633 line breaks) in the encoded EXI stream. By default, non-essential whitespace
634 is removed from the encoded stream.
\r
637 <DT><B>Parameters:</B><DD><CODE>preserveWhitespaces</CODE> - <i>true</i> to retain whitespace in the encoded EXI stream</DL>
\r
642 <A NAME="encode(org.xml.sax.InputSource)"><!-- --></A><H3>
\r
645 public void <B>encode</B>(org.xml.sax.InputSource is)
\r
646 throws <A HREF="../../../org/openexi/sax/TransmogrifierException.html" title="class in org.openexi.sax">TransmogrifierException</A>,
\r
647 java.io.IOException</PRE>
\r
649 <DD>Parses XML input source and converts it to an EXI stream.
\r
652 <DT><B>Parameters:</B><DD><CODE>is</CODE> - XML input source
\r
654 <DD><CODE><A HREF="../../../org/openexi/sax/TransmogrifierException.html" title="class in org.openexi.sax">TransmogrifierException</A></CODE>
\r
655 <DD><CODE>java.io.IOException</CODE></DL>
\r
660 <A NAME="getSAXTransmogrifier()"><!-- --></A><H3>
\r
661 getSAXTransmogrifier</H3>
\r
663 public <A HREF="../../../org/openexi/sax/SAXTransmogrifier.html" title="interface in org.openexi.sax">SAXTransmogrifier</A> <B>getSAXTransmogrifier</B>()</PRE>
\r
665 <DD>Returns the SAXTransmogrifier, which implements both the ContentHandler
666 and LexicalHandler. SAX programmers can connect the SAXTransmogrifier to
667 their favorite XML Parser to convert SAX events into an EXI stream.
\r
673 <!-- ========= END OF CLASS DATA ========= -->
\r
677 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
678 <A NAME="navbar_bottom"><!-- --></A>
\r
679 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
680 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
682 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
683 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
684 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
685 <TR ALIGN="center" VALIGN="top">
\r
686 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
687 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
688 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
689 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
690 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
691 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
692 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
696 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
702 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
703 <A HREF="../../../org/openexi/sax/SAXTransmogrifier.html" title="interface in org.openexi.sax"><B>PREV CLASS</B></A>
\r
704 <A HREF="../../../org/openexi/sax/TransmogrifierException.html" title="class in org.openexi.sax"><B>NEXT CLASS</B></A></FONT></TD>
\r
705 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
706 <A HREF="../../../index.html?org/openexi/sax/Transmogrifier.html" target="_top"><B>FRAMES</B></A>
\r
707 <A HREF="Transmogrifier.html" target="_top"><B>NO FRAMES</B></A>
\r
708 <SCRIPT type="text/javascript">
\r
711 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
716 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
723 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
724 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
725 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
726 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
729 <A NAME="skip-navbar_bottom"></A>
\r
730 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r