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.io.Scanner 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="Scanner";
\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/io/CharacterBuffer.html" title="class in org.openexi.proc.io"><B>PREV CLASS</B></A>
\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/io/Scanner.html" target="_top"><B>FRAMES</B></A>
\r
59 <A HREF="Scanner.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="#fields_inherited_from_class_org.openexi.proc.grammars.Apparatus">FIELD</A> | 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.io</FONT>
\r
93 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.openexi.proc.grammars.Apparatus
\r
94 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.proc.io.Scanner</B>
\r
98 <DT><PRE>public abstract class <B>Scanner</B><DT>extends org.openexi.proc.grammars.Apparatus</DL>
\r
102 The Scanner class provides methods for scanning events
103 in the body of an EXI stream.
\r
108 <!-- yWorks UML Doclet http://www.yworks.com/ b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
113 <!-- =========== FIELD SUMMARY =========== -->
\r
115 <A NAME="field_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>Field Summary</B></FONT></TH>
\r
122 <A NAME="fields_inherited_from_class_org.openexi.proc.grammars.Apparatus"><!-- --></A>
\r
123 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
124 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
125 <TH ALIGN="left"><B>Fields inherited from class org.openexi.proc.grammars.Apparatus</B></TH>
\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
128 <TD><CODE>CODEC_BASE64BINARY, CODEC_BOOLEAN, CODEC_DATE, CODEC_DATETIME, CODEC_DECIMAL, CODEC_DOUBLE, CODEC_ENUMERATION, CODEC_GDAY, CODEC_GMONTH, CODEC_GMONTHDAY, CODEC_GYEAR, CODEC_GYEARMONTH, CODEC_HEXBINARY, CODEC_INTEGER, CODEC_LEXICAL, CODEC_LIST, CODEC_STRING, CODEC_TIME, currentState, eventTypesWorkSpace, schema, stringTable</CODE></TD>
\r
132 <!-- ========== METHOD SUMMARY =========== -->
\r
134 <A NAME="method_summary"><!-- --></A>
\r
135 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
136 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
137 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
138 <B>Method Summary</B></FONT></TH>
\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
142 <CODE> void</CODE></FONT></TD>
\r
143 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#closeInputStream()">closeInputStream</A></B>()</CODE>
\r
146 Close the input stream.</TD>
\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
150 <CODE> <A HREF="../../../../org/openexi/proc/common/EXIOptions.html" title="class in org.openexi.proc.common">EXIOptions</A></CODE></FONT></TD>
\r
151 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#getHeaderOptions()">getHeaderOptions</A></B>()</CODE>
\r
154 Returns the EXI Header options from the header of the
155 EXI stream, if present.</TD>
\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
159 <CODE>abstract <A HREF="../../../../org/openexi/proc/common/EventDescription.html" title="interface in org.openexi.proc.common">EventDescription</A></CODE></FONT></TD>
\r
160 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#nextEvent()">nextEvent</A></B>()</CODE>
\r
163 Gets the next event from the EXI stream.</TD>
\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
167 <CODE>abstract void</CODE></FONT></TD>
\r
168 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#setBinaryChunkSize(int)">setBinaryChunkSize</A></B>(int chunkSize)</CODE>
\r
171 Binary values are read in chunks of the specified size when the
172 use of binary data is enabled.</TD>
\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
176 <CODE> void</CODE></FONT></TD>
\r
177 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#setSchema(org.openexi.schema.EXISchema, org.openexi.proc.common.QName[], int)">setSchema</A></B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A> schema,
\r
178 <A HREF="../../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common">QName</A>[] dtrm,
\r
179 int n_bindings)</CODE>
\r
182 </TD>
\r
185 <A NAME="methods_inherited_from_class_org.openexi.proc.grammars.Apparatus"><!-- --></A>
\r
186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
187 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
188 <TH ALIGN="left"><B>Methods inherited from class org.openexi.proc.grammars.Apparatus</B></TH>
\r
190 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
191 <TD><CODE>attribute, characters, endDocument, endElement, getAlignmentType, getNextEventCodes, getNextEventTypes, getPreserveLexicalValues, miscContent, nillify, reset, setPreserveLexicalValues, setStringTable, startDocument, startElement, startWildcardElement, undeclaredCharacters, wildcardAttribute, xsitp</CODE></TD>
\r
194 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
195 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
196 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
197 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
199 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
200 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
206 <!-- ============ METHOD DETAIL ========== -->
\r
208 <A NAME="method_detail"><!-- --></A>
\r
209 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
210 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
211 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
212 <B>Method Detail</B></FONT></TH>
\r
216 <A NAME="setSchema(org.openexi.schema.EXISchema, org.openexi.proc.common.QName[], int)"><!-- --></A><H3>
\r
219 public void <B>setSchema</B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A> schema,
\r
220 <A HREF="../../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common">QName</A>[] dtrm,
\r
221 int n_bindings)</PRE>
\r
224 <DT><B>Overrides:</B><DD><CODE>setSchema</CODE> in class <CODE>org.openexi.proc.grammars.Apparatus</CODE></DL>
\r
232 <A NAME="nextEvent()"><!-- --></A><H3>
\r
235 public abstract <A HREF="../../../../org/openexi/proc/common/EventDescription.html" title="interface in org.openexi.proc.common">EventDescription</A> <B>nextEvent</B>()
\r
236 throws java.io.IOException</PRE>
\r
238 <DD>Gets the next event from the EXI stream.
\r
242 <DT><B>Returns:</B><DD>EXIEvent
\r
244 <DD><CODE>java.io.IOException</CODE></DL>
\r
249 <A NAME="closeInputStream()"><!-- --></A><H3>
\r
250 closeInputStream</H3>
\r
252 public void <B>closeInputStream</B>()
\r
253 throws java.io.IOException</PRE>
\r
255 <DD>Close the input stream.
\r
260 <DD><CODE>java.io.IOException</CODE></DL>
\r
265 <A NAME="getHeaderOptions()"><!-- --></A><H3>
\r
266 getHeaderOptions</H3>
\r
268 public final <A HREF="../../../../org/openexi/proc/common/EXIOptions.html" title="class in org.openexi.proc.common">EXIOptions</A> <B>getHeaderOptions</B>()</PRE>
\r
270 <DD>Returns the EXI Header options from the header of the
271 EXI stream, if present. Otherwise, returns null.
\r
275 <DT><B>Returns:</B><DD>EXIOptions or <i>null</i> if no header options are set.</DL>
\r
280 <A NAME="setBinaryChunkSize(int)"><!-- --></A><H3>
\r
281 setBinaryChunkSize</H3>
\r
283 public abstract void <B>setBinaryChunkSize</B>(int chunkSize)</PRE>
\r
285 <DD>Binary values are read in chunks of the specified size when the
286 use of binary data is enabled.
\r
289 <DT><B>Parameters:</B><DD><CODE>chunkSize</CODE> - </DL>
\r
292 <!-- ========= END OF CLASS DATA ========= -->
\r
296 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
297 <A NAME="navbar_bottom"><!-- --></A>
\r
298 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
299 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
301 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
302 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
303 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
304 <TR ALIGN="center" VALIGN="top">
\r
305 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
306 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
307 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
308 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
310 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
315 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
321 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
322 <A HREF="../../../../org/openexi/proc/io/CharacterBuffer.html" title="class in org.openexi.proc.io"><B>PREV CLASS</B></A>
\r
323 NEXT CLASS</FONT></TD>
\r
324 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
325 <A HREF="../../../../index.html?org/openexi/proc/io/Scanner.html" target="_top"><B>FRAMES</B></A>
\r
326 <A HREF="Scanner.html" target="_top"><B>NO FRAMES</B></A>
\r
327 <SCRIPT type="text/javascript">
\r
330 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
335 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
342 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
343 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.openexi.proc.grammars.Apparatus">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
344 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
345 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
348 <A NAME="skip-navbar_bottom"></A>
\r
349 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r