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.grammars.GrammarCache 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="GrammarCache";
\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 PREV CLASS
\r
56 NEXT CLASS</FONT></TD>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../../../index.html?org/openexi/proc/grammars/GrammarCache.html" target="_top"><B>FRAMES</B></A>
\r
59 <A HREF="GrammarCache.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 | <A HREF="#field_summary">FIELD</A> | <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: <A HREF="#field_detail">FIELD</A> | <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.proc.grammars</FONT>
\r
90 Class GrammarCache</H2>
\r
93 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.proc.grammars.GrammarCache</B>
\r
96 <DT><B>All Implemented Interfaces:</B> <DD>org.openexi.proc.common.IGrammarCache</DD>
\r
100 <DT><PRE>public final class <B>GrammarCache</B><DT>extends java.lang.Object<DT>implements org.openexi.proc.common.IGrammarCache</DL>
\r
104 A GrammarCache object represents a set of EXI grammars used
105 for processing EXI streams using specific grammar options.
106 The GrammarCache is passed as an argument to
107 the EXIReader and Transmogrifier prior to processing an EXI stream.
\r
112 <!-- yWorks UML Doclet http://www.yworks.com/ b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
117 <!-- =========== FIELD SUMMARY =========== -->
\r
119 <A NAME="field_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>Field Summary</B></FONT></TH>
\r
125 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
126 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
127 <CODE> short</CODE></FONT></TD>
\r
128 <TD><CODE><B><A HREF="../../../../org/openexi/proc/grammars/GrammarCache.html#grammarOptions">grammarOptions</A></B></CODE>
\r
131 Short integer that encapsulates <A HREF="../../../../org/openexi/proc/common/GrammarOptions.html" title="class in org.openexi.proc.common"><CODE>GrammarOptions</CODE></A>
132 for the EXI stream.</TD>
\r
136 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
138 <A NAME="constructor_summary"><!-- --></A>
\r
139 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
140 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
141 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
142 <B>Constructor Summary</B></FONT></TH>
\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
145 <TD><CODE><B><A HREF="../../../../org/openexi/proc/grammars/GrammarCache.html#GrammarCache(org.openexi.schema.EXISchema)">GrammarCache</A></B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A> schema)</CODE>
\r
148 Creates an instance of GrammarCache informed by a schema with default
149 grammar options.</TD>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD><CODE><B><A HREF="../../../../org/openexi/proc/grammars/GrammarCache.html#GrammarCache(org.openexi.schema.EXISchema, short)">GrammarCache</A></B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A> schema,
\r
153 short grammarOptions)</CODE>
\r
156 Creates an instance of GrammarCache informed by a schema with the
157 specified grammar options.</TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD><CODE><B><A HREF="../../../../org/openexi/proc/grammars/GrammarCache.html#GrammarCache(short)">GrammarCache</A></B>(short grammarOptions)</CODE>
\r
163 Creates an instance of GrammarCache with the specified grammar options.</TD>
\r
167 <!-- ========== METHOD SUMMARY =========== -->
\r
169 <A NAME="method_summary"><!-- --></A>
\r
170 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
171 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
172 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
173 <B>Method Summary</B></FONT></TH>
\r
175 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
177 <CODE> <A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A></CODE></FONT></TD>
\r
178 <TD><CODE><B><A HREF="../../../../org/openexi/proc/grammars/GrammarCache.html#getEXISchema()">getEXISchema</A></B>()</CODE>
\r
181 Gets the compiled EXI Schema.</TD>
\r
184 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
185 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
186 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
187 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
189 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
190 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
193 <A NAME="methods_inherited_from_class_org.openexi.proc.common.IGrammarCache"><!-- --></A>
\r
194 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
195 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
196 <TH ALIGN="left"><B>Methods inherited from interface org.openexi.proc.common.IGrammarCache</B></TH>
\r
198 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
199 <TD><CODE>getElementGrammarUse</CODE></TD>
\r
205 <!-- ============ FIELD DETAIL =========== -->
\r
207 <A NAME="field_detail"><!-- --></A>
\r
208 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
209 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
210 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
211 <B>Field Detail</B></FONT></TH>
\r
215 <A NAME="grammarOptions"><!-- --></A><H3>
\r
216 grammarOptions</H3>
\r
218 public final short <B>grammarOptions</B></PRE>
\r
220 <DD>Short integer that encapsulates <A HREF="../../../../org/openexi/proc/common/GrammarOptions.html" title="class in org.openexi.proc.common"><CODE>GrammarOptions</CODE></A>
221 for the EXI stream.
\r
227 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
229 <A NAME="constructor_detail"><!-- --></A>
\r
230 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
231 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
232 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
233 <B>Constructor Detail</B></FONT></TH>
\r
237 <A NAME="GrammarCache(org.openexi.schema.EXISchema)"><!-- --></A><H3>
\r
240 public <B>GrammarCache</B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A> schema)</PRE>
\r
242 <DD>Creates an instance of GrammarCache informed by a schema with default
246 <DT><B>Parameters:</B><DD><CODE>EXISchema</CODE> - compiled schema</DL>
\r
250 <A NAME="GrammarCache(short)"><!-- --></A><H3>
\r
253 public <B>GrammarCache</B>(short grammarOptions)</PRE>
\r
255 <DD>Creates an instance of GrammarCache with the specified grammar options.
\r
258 <DT><B>Parameters:</B><DD><CODE>grammarOptions</CODE> - integer value that represents a grammar option configuration</DL>
\r
262 <A NAME="GrammarCache(org.openexi.schema.EXISchema, short)"><!-- --></A><H3>
\r
265 public <B>GrammarCache</B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A> schema,
\r
266 short grammarOptions)</PRE>
\r
268 <DD>Creates an instance of GrammarCache informed by a schema with the
269 specified grammar options.
\r
272 <DT><B>Parameters:</B><DD><CODE>EXISchema</CODE> - compiled schema<DD><CODE>grammarOptions</CODE> - integer value that represents a grammar option configuration</DL>
\r
275 <!-- ============ METHOD DETAIL ========== -->
\r
277 <A NAME="method_detail"><!-- --></A>
\r
278 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
279 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
280 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
281 <B>Method Detail</B></FONT></TH>
\r
285 <A NAME="getEXISchema()"><!-- --></A><H3>
\r
288 public <A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A> <B>getEXISchema</B>()</PRE>
\r
290 <DD>Gets the compiled EXI Schema.
\r
293 <DT><B>Specified by:</B><DD><CODE>getEXISchema</CODE> in interface <CODE>org.openexi.proc.common.IGrammarCache</CODE></DL>
\r
297 <DT><B>Returns:</B><DD>an EXI schema.</DL>
\r
300 <!-- ========= END OF CLASS DATA ========= -->
\r
304 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
305 <A NAME="navbar_bottom"><!-- --></A>
\r
306 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
307 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
309 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
310 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
311 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
312 <TR ALIGN="center" VALIGN="top">
\r
313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
315 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
323 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
329 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
330 PREV CLASS
\r
331 NEXT CLASS</FONT></TD>
\r
332 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
333 <A HREF="../../../../index.html?org/openexi/proc/grammars/GrammarCache.html" target="_top"><B>FRAMES</B></A>
\r
334 <A HREF="GrammarCache.html" target="_top"><B>NO FRAMES</B></A>
\r
335 <SCRIPT type="text/javascript">
\r
338 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
343 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
350 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
351 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
352 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
353 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
356 <A NAME="skip-navbar_bottom"></A>
\r
357 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r