Bug 849: Fixed NPE in Translated Data Change Events.
[controller.git] / third-party / org.openexi / nagasena / src / main / resources / doc / org / openexi / proc / grammars / GrammarCache.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 GrammarCache\r
9 </TITLE>\r
10 \r
11 <META NAME="keywords" CONTENT="org.openexi.proc.grammars.GrammarCache 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="GrammarCache";\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;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>  &nbsp;\r
59 &nbsp;<A HREF="GrammarCache.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.grammars</FONT>\r
89 <BR>\r
90 Class GrammarCache</H2>\r
91 <PRE>\r
92 java.lang.Object\r
93   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.proc.grammars.GrammarCache</B>\r
94 </PRE>\r
95 <DL>\r
96 <DT><B>All Implemented Interfaces:</B> <DD>org.openexi.proc.common.IGrammarCache</DD>\r
97 </DL>\r
98 <HR>\r
99 <DL>\r
100 <DT><PRE>public final class <B>GrammarCache</B><DT>extends java.lang.Object<DT>implements org.openexi.proc.common.IGrammarCache</DL>\r
101 </PRE>\r
102 \r
103 <P>\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
108 <P>\r
109 \r
110 <P>\r
111 <DL>\r
112 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
113 </DL>\r
114 <HR>\r
115 \r
116 <P>\r
117 <!-- =========== FIELD SUMMARY =========== -->\r
118 \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
124 </TR>\r
125 <TR BGCOLOR="white" CLASS="TableRowColor">\r
126 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
127 <CODE>&nbsp;short</CODE></FONT></TD>\r
128 <TD><CODE><B><A HREF="../../../../org/openexi/proc/grammars/GrammarCache.html#grammarOptions">grammarOptions</A></B></CODE>\r
129 \r
130 <BR>\r
131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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
133 </TR>\r
134 </TABLE>\r
135 &nbsp;\r
136 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
137 \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
143 </TR>\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>&nbsp;schema)</CODE>\r
146 \r
147 <BR>\r
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an instance of GrammarCache informed by a schema with default 
149  grammar options.</TD>\r
150 </TR>\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>&nbsp;schema,\r
153              short&nbsp;grammarOptions)</CODE>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an instance of GrammarCache informed by a schema with the
157  specified grammar options.</TD>\r
158 </TR>\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&nbsp;grammarOptions)</CODE>\r
161 \r
162 <BR>\r
163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an instance of GrammarCache with the specified grammar options.</TD>\r
164 </TR>\r
165 </TABLE>\r
166 &nbsp;\r
167 <!-- ========== METHOD SUMMARY =========== -->\r
168 \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
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;<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
179 \r
180 <BR>\r
181 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the compiled EXI Schema.</TD>\r
182 </TR>\r
183 </TABLE>\r
184 &nbsp;<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
188 </TR>\r
189 <TR BGCOLOR="white" CLASS="TableRowColor">\r
190 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
191 </TR>\r
192 </TABLE>\r
193 &nbsp;<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
197 </TR>\r
198 <TR BGCOLOR="white" CLASS="TableRowColor">\r
199 <TD><CODE>getElementGrammarUse</CODE></TD>\r
200 </TR>\r
201 </TABLE>\r
202 &nbsp;\r
203 <P>\r
204 \r
205 <!-- ============ FIELD DETAIL =========== -->\r
206 \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
212 </TR>\r
213 </TABLE>\r
214 \r
215 <A NAME="grammarOptions"><!-- --></A><H3>\r
216 grammarOptions</H3>\r
217 <PRE>\r
218 public final short <B>grammarOptions</B></PRE>\r
219 <DL>\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
222 <P>\r
223 <DL>\r
224 </DL>\r
225 </DL>\r
226 \r
227 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
228 \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
234 </TR>\r
235 </TABLE>\r
236 \r
237 <A NAME="GrammarCache(org.openexi.schema.EXISchema)"><!-- --></A><H3>\r
238 GrammarCache</H3>\r
239 <PRE>\r
240 public <B>GrammarCache</B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A>&nbsp;schema)</PRE>\r
241 <DL>\r
242 <DD>Creates an instance of GrammarCache informed by a schema with default 
243  grammar options.\r
244 <P>\r
245 <DL>\r
246 <DT><B>Parameters:</B><DD><CODE>EXISchema</CODE> - compiled schema</DL>\r
247 </DL>\r
248 <HR>\r
249 \r
250 <A NAME="GrammarCache(short)"><!-- --></A><H3>\r
251 GrammarCache</H3>\r
252 <PRE>\r
253 public <B>GrammarCache</B>(short&nbsp;grammarOptions)</PRE>\r
254 <DL>\r
255 <DD>Creates an instance of GrammarCache with the specified grammar options.\r
256 <P>\r
257 <DL>\r
258 <DT><B>Parameters:</B><DD><CODE>grammarOptions</CODE> - integer value that represents a grammar option configuration</DL>\r
259 </DL>\r
260 <HR>\r
261 \r
262 <A NAME="GrammarCache(org.openexi.schema.EXISchema, short)"><!-- --></A><H3>\r
263 GrammarCache</H3>\r
264 <PRE>\r
265 public <B>GrammarCache</B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A>&nbsp;schema,\r
266                     short&nbsp;grammarOptions)</PRE>\r
267 <DL>\r
268 <DD>Creates an instance of GrammarCache informed by a schema with the
269  specified grammar options.\r
270 <P>\r
271 <DL>\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
273 </DL>\r
274 \r
275 <!-- ============ METHOD DETAIL ========== -->\r
276 \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
282 </TR>\r
283 </TABLE>\r
284 \r
285 <A NAME="getEXISchema()"><!-- --></A><H3>\r
286 getEXISchema</H3>\r
287 <PRE>\r
288 public <A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A> <B>getEXISchema</B>()</PRE>\r
289 <DL>\r
290 <DD>Gets the compiled EXI Schema.\r
291 <P>\r
292 <DD><DL>\r
293 <DT><B>Specified by:</B><DD><CODE>getEXISchema</CODE> in interface <CODE>org.openexi.proc.common.IGrammarCache</CODE></DL>\r
294 </DD>\r
295 <DD><DL>\r
296 \r
297 <DT><B>Returns:</B><DD>an EXI schema.</DL>\r
298 </DD>\r
299 </DL>\r
300 <!-- ========= END OF CLASS DATA ========= -->\r
301 <HR>\r
302 \r
303 \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
308 <TR>\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>&nbsp;</TD>\r
314   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
315   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
316   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
317   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
318   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
319   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
320   </TR>\r
321 </TABLE>\r
322 </TD>\r
323 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
324 </EM>\r
325 </TD>\r
326 </TR>\r
327 \r
328 <TR>\r
329 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
330 &nbsp;PREV CLASS&nbsp;\r
331 &nbsp;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>  &nbsp;\r
334 &nbsp;<A HREF="GrammarCache.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
335 &nbsp;<SCRIPT type="text/javascript">\r
336   <!--\r
337   if(window==top) {\r
338     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
339   }\r
340   //-->\r
341 </SCRIPT>\r
342 <NOSCRIPT>\r
343   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
344 </NOSCRIPT>\r
345 \r
346 \r
347 </FONT></TD>\r
348 </TR>\r
349 <TR>\r
350 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
351   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
352 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
353 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
354 </TR>\r
355 </TABLE>\r
356 <A NAME="skip-navbar_bottom"></A>\r
357 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
358 \r
359 <HR>\r
360 \r
361 </BODY>\r
362 </HTML>\r