Bug 809: Enhancements to the toaster example
[controller.git] / third-party / org.openexi / nagasena / src / main / resources / doc / org / openexi / sax / SAXTransmogrifier.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 SAXTransmogrifier\r
9 </TITLE>\r
10 \r
11 <META NAME="keywords" CONTENT="org.openexi.sax.SAXTransmogrifier interface">\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="SAXTransmogrifier";\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;<A HREF="../../../org/openexi/sax/ReaderSupport.html" title="class in org.openexi.sax"><B>PREV CLASS</B></A>&nbsp;\r
56 &nbsp;<A HREF="../../../org/openexi/sax/Transmogrifier.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/SAXTransmogrifier.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="SAXTransmogrifier.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;CONSTR&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;CONSTR&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.sax</FONT>\r
89 <BR>\r
90 Interface SAXTransmogrifier</H2>\r
91 <DL>\r
92 <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../org/openexi/sax/BinaryDataHandler.html" title="interface in org.openexi.sax">BinaryDataHandler</A>, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler</DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT><PRE>public interface <B>SAXTransmogrifier</B><DT>extends org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, <A HREF="../../../org/openexi/sax/BinaryDataHandler.html" title="interface in org.openexi.sax">BinaryDataHandler</A></DL>\r
97 </PRE>\r
98 \r
99 <P>\r
100 Applications can directly feed SAX events into a transmogrifier through SAXTransmogrifier.\r
101 <P>\r
102 \r
103 <P>\r
104 <DL>\r
105 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
106 </DL>\r
107 <HR>\r
108 \r
109 <P>\r
110 \r
111 <!-- ========== METHOD SUMMARY =========== -->\r
112 \r
113 <A NAME="method_summary"><!-- --></A>\r
114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
116 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
117 <B>Method Summary</B></FONT></TH>\r
118 </TR>\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">\r
120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
121 <CODE>&nbsp;<A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars">GrammarCache</A></CODE></FONT></TD>\r
122 <TD><CODE><B><A HREF="../../../org/openexi/sax/SAXTransmogrifier.html#getGrammarCache()">getGrammarCache</A></B>()</CODE>\r
123 \r
124 <BR>\r
125 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the GrammarCache that is in use by this SAXTransmogrifier.</TD>\r
126 </TR>\r
127 </TABLE>\r
128 &nbsp;<A NAME="methods_inherited_from_class_org.xml.sax.ContentHandler"><!-- --></A>\r
129 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
130 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
131 <TH ALIGN="left"><B>Methods inherited from interface org.xml.sax.ContentHandler</B></TH>\r
132 </TR>\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">\r
134 <TD><CODE>characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping</CODE></TD>\r
135 </TR>\r
136 </TABLE>\r
137 &nbsp;<A NAME="methods_inherited_from_class_org.xml.sax.ext.LexicalHandler"><!-- --></A>\r
138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
139 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
140 <TH ALIGN="left"><B>Methods inherited from interface org.xml.sax.ext.LexicalHandler</B></TH>\r
141 </TR>\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
143 <TD><CODE>comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity</CODE></TD>\r
144 </TR>\r
145 </TABLE>\r
146 &nbsp;<A NAME="methods_inherited_from_class_org.openexi.sax.BinaryDataHandler"><!-- --></A>\r
147 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
148 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
149 <TH ALIGN="left"><B>Methods inherited from interface org.openexi.sax.<A HREF="../../../org/openexi/sax/BinaryDataHandler.html" title="interface in org.openexi.sax">BinaryDataHandler</A></B></TH>\r
150 </TR>\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">\r
152 <TD><CODE><A HREF="../../../org/openexi/sax/BinaryDataHandler.html#binaryData(byte[], int, int, org.openexi.proc.io.BinaryDataSink)">binaryData</A>, <A HREF="../../../org/openexi/sax/BinaryDataHandler.html#endBinaryData(org.openexi.proc.io.BinaryDataSink)">endBinaryData</A>, <A HREF="../../../org/openexi/sax/BinaryDataHandler.html#startBinaryData(long)">startBinaryData</A></CODE></TD>\r
153 </TR>\r
154 </TABLE>\r
155 &nbsp;\r
156 <P>\r
157 \r
158 <!-- ============ METHOD DETAIL ========== -->\r
159 \r
160 <A NAME="method_detail"><!-- --></A>\r
161 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
162 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
163 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
164 <B>Method Detail</B></FONT></TH>\r
165 </TR>\r
166 </TABLE>\r
167 \r
168 <A NAME="getGrammarCache()"><!-- --></A><H3>\r
169 getGrammarCache</H3>\r
170 <PRE>\r
171 <A HREF="../../../org/openexi/proc/grammars/GrammarCache.html" title="class in org.openexi.proc.grammars">GrammarCache</A> <B>getGrammarCache</B>()</PRE>\r
172 <DL>\r
173 <DD>Returns the GrammarCache that is in use by this SAXTransmogrifier.\r
174 <P>\r
175 <DD><DL>\r
176 </DL>\r
177 </DD>\r
178 <DD><DL>\r
179 \r
180 <DT><B>Returns:</B><DD>a GrammarCache</DL>\r
181 </DD>\r
182 </DL>\r
183 <!-- ========= END OF CLASS DATA ========= -->\r
184 <HR>\r
185 \r
186 \r
187 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
188 <A NAME="navbar_bottom"><!-- --></A>\r
189 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
190 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
191 <TR>\r
192 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
193 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
194 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
195   <TR ALIGN="center" VALIGN="top">\r
196   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
197   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
198   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
199   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
200   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
201   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
202   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
203   </TR>\r
204 </TABLE>\r
205 </TD>\r
206 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
207 </EM>\r
208 </TD>\r
209 </TR>\r
210 \r
211 <TR>\r
212 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
213 &nbsp;<A HREF="../../../org/openexi/sax/ReaderSupport.html" title="class in org.openexi.sax"><B>PREV CLASS</B></A>&nbsp;\r
214 &nbsp;<A HREF="../../../org/openexi/sax/Transmogrifier.html" title="class in org.openexi.sax"><B>NEXT CLASS</B></A></FONT></TD>\r
215 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
216   <A HREF="../../../index.html?org/openexi/sax/SAXTransmogrifier.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
217 &nbsp;<A HREF="SAXTransmogrifier.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
218 &nbsp;<SCRIPT type="text/javascript">\r
219   <!--\r
220   if(window==top) {\r
221     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
222   }\r
223   //-->\r
224 </SCRIPT>\r
225 <NOSCRIPT>\r
226   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
227 </NOSCRIPT>\r
228 \r
229 \r
230 </FONT></TD>\r
231 </TR>\r
232 <TR>\r
233 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
234   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
235 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
236 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
237 </TR>\r
238 </TABLE>\r
239 <A NAME="skip-navbar_bottom"></A>\r
240 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
241 \r
242 <HR>\r
243 \r
244 </BODY>\r
245 </HTML>\r