Try adding current javadoc to SVN
[zxing.git] / docs / javadoc / com / google / zxing / multi / GenericMultipleBarcodeReader.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.6.0_13) on Fri Jun 26 13:12:29 EDT 2009 -->
6 <TITLE>
7 GenericMultipleBarcodeReader
8 </TITLE>
9
10 <META NAME="date" CONTENT="2009-06-26">
11
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14 <SCRIPT type="text/javascript">
15 function windowTitle()
16 {
17     if (location.href.indexOf('is-external=true') == -1) {
18         parent.document.title="GenericMultipleBarcodeReader";
19     }
20 }
21 </SCRIPT>
22 <NOSCRIPT>
23 </NOSCRIPT>
24
25 </HEAD>
26
27 <BODY BGCOLOR="white" onload="windowTitle();">
28 <HR>
29
30
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <A NAME="navbar_top"><!-- --></A>
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35 <TR>
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37 <A NAME="navbar_top_firstrow"><!-- --></A>
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39   <TR ALIGN="center" VALIGN="top">
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47   </TR>
48 </TABLE>
49 </TD>
50 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51 </EM>
52 </TD>
53 </TR>
54
55 <TR>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 &nbsp;<A HREF="../../../../com/google/zxing/multi/ByQuadrantReader.html" title="class in com.google.zxing.multi"><B>PREV CLASS</B></A>&nbsp;
58 &nbsp;<A HREF="../../../../com/google/zxing/multi/MultipleBarcodeReader.html" title="interface in com.google.zxing.multi"><B>NEXT CLASS</B></A></FONT></TD>
59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60   <A HREF="../../../../index.html?com/google/zxing/multi/GenericMultipleBarcodeReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61 &nbsp;<A HREF="GenericMultipleBarcodeReader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62 &nbsp;<SCRIPT type="text/javascript">
63   <!--
64   if(window==top) {
65     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
66   }
67   //-->
68 </SCRIPT>
69 <NOSCRIPT>
70   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
71 </NOSCRIPT>
72
73
74 </FONT></TD>
75 </TR>
76 <TR>
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81 </TR>
82 </TABLE>
83 <A NAME="skip-navbar_top"></A>
84 <!-- ========= END OF TOP NAVBAR ========= -->
85
86 <HR>
87 <!-- ======== START OF CLASS DATA ======== -->
88 <H2>
89 <FONT SIZE="-1">
90 com.google.zxing.multi</FONT>
91 <BR>
92 Class GenericMultipleBarcodeReader</H2>
93 <PRE>
94 java.lang.Object
95   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.zxing.multi.GenericMultipleBarcodeReader</B>
96 </PRE>
97 <DL>
98 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/google/zxing/multi/MultipleBarcodeReader.html" title="interface in com.google.zxing.multi">MultipleBarcodeReader</A></DD>
99 </DL>
100 <HR>
101 <DL>
102 <DT><PRE>public final class <B>GenericMultipleBarcodeReader</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/google/zxing/multi/MultipleBarcodeReader.html" title="interface in com.google.zxing.multi">MultipleBarcodeReader</A></DL>
103 </PRE>
104
105 <P>
106 <p>Attempts to locate multiple barcodes in an image by repeatedly decoding portion of the image.
107  After one barcode is found, the areas left, above, right and below the barcode's
108  <A HREF="../../../../com/google/zxing/ResultPoint.html" title="class in com.google.zxing"><CODE>ResultPoint</CODE></A>s are scanned, recursively.</p>
109
110  <p>A caller may want to also employ <A HREF="../../../../com/google/zxing/multi/ByQuadrantReader.html" title="class in com.google.zxing.multi"><CODE>ByQuadrantReader</CODE></A> when attempting to find multiple
111  2D barcodes, like QR Codes, in an image, where the presence of multiple barcodes might prevent
112  detecting any one of them.</p>
113
114  <p>That is, instead of passing a <A HREF="../../../../com/google/zxing/Reader.html" title="interface in com.google.zxing"><CODE>Reader</CODE></A> a caller might pass
115  <code>new ByQuadrantReader(reader)</code>.</p>
116 <P>
117
118 <P>
119 <DL>
120 <DT><B>Author:</B></DT>
121   <DD>Sean Owen</DD>
122 </DL>
123 <HR>
124
125 <P>
126
127 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
128
129 <A NAME="constructor_summary"><!-- --></A>
130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
132 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
133 <B>Constructor Summary</B></FONT></TH>
134 </TR>
135 <TR BGCOLOR="white" CLASS="TableRowColor">
136 <TD><CODE><B><A HREF="../../../../com/google/zxing/multi/GenericMultipleBarcodeReader.html#GenericMultipleBarcodeReader(com.google.zxing.Reader)">GenericMultipleBarcodeReader</A></B>(<A HREF="../../../../com/google/zxing/Reader.html" title="interface in com.google.zxing">Reader</A>&nbsp;delegate)</CODE>
137
138 <BR>
139 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
140 </TR>
141 </TABLE>
142 &nbsp;
143 <!-- ========== METHOD SUMMARY =========== -->
144
145 <A NAME="method_summary"><!-- --></A>
146 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
149 <B>Method Summary</B></FONT></TH>
150 </TR>
151 <TR BGCOLOR="white" CLASS="TableRowColor">
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153 <CODE>&nbsp;<A HREF="../../../../com/google/zxing/Result.html" title="class in com.google.zxing">Result</A>[]</CODE></FONT></TD>
154 <TD><CODE><B><A HREF="../../../../com/google/zxing/multi/GenericMultipleBarcodeReader.html#decodeMultiple(com.google.zxing.MonochromeBitmapSource)">decodeMultiple</A></B>(<A HREF="../../../../com/google/zxing/MonochromeBitmapSource.html" title="interface in com.google.zxing">MonochromeBitmapSource</A>&nbsp;image)</CODE>
155
156 <BR>
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158 </TR>
159 <TR BGCOLOR="white" CLASS="TableRowColor">
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161 <CODE>&nbsp;<A HREF="../../../../com/google/zxing/Result.html" title="class in com.google.zxing">Result</A>[]</CODE></FONT></TD>
162 <TD><CODE><B><A HREF="../../../../com/google/zxing/multi/GenericMultipleBarcodeReader.html#decodeMultiple(com.google.zxing.MonochromeBitmapSource, java.util.Hashtable)">decodeMultiple</A></B>(<A HREF="../../../../com/google/zxing/MonochromeBitmapSource.html" title="interface in com.google.zxing">MonochromeBitmapSource</A>&nbsp;image,
163                java.util.Hashtable&nbsp;hints)</CODE>
164
165 <BR>
166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
167 </TR>
168 </TABLE>
169 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
170 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
171 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
172 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
173 </TR>
174 <TR BGCOLOR="white" CLASS="TableRowColor">
175 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
176 </TR>
177 </TABLE>
178 &nbsp;
179 <P>
180
181 <!-- ========= CONSTRUCTOR DETAIL ======== -->
182
183 <A NAME="constructor_detail"><!-- --></A>
184 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
187 <B>Constructor Detail</B></FONT></TH>
188 </TR>
189 </TABLE>
190
191 <A NAME="GenericMultipleBarcodeReader(com.google.zxing.Reader)"><!-- --></A><H3>
192 GenericMultipleBarcodeReader</H3>
193 <PRE>
194 public <B>GenericMultipleBarcodeReader</B>(<A HREF="../../../../com/google/zxing/Reader.html" title="interface in com.google.zxing">Reader</A>&nbsp;delegate)</PRE>
195 <DL>
196 </DL>
197
198 <!-- ============ METHOD DETAIL ========== -->
199
200 <A NAME="method_detail"><!-- --></A>
201 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
204 <B>Method Detail</B></FONT></TH>
205 </TR>
206 </TABLE>
207
208 <A NAME="decodeMultiple(com.google.zxing.MonochromeBitmapSource)"><!-- --></A><H3>
209 decodeMultiple</H3>
210 <PRE>
211 public <A HREF="../../../../com/google/zxing/Result.html" title="class in com.google.zxing">Result</A>[] <B>decodeMultiple</B>(<A HREF="../../../../com/google/zxing/MonochromeBitmapSource.html" title="interface in com.google.zxing">MonochromeBitmapSource</A>&nbsp;image)
212                         throws <A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></PRE>
213 <DL>
214 <DD><DL>
215 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/zxing/multi/MultipleBarcodeReader.html#decodeMultiple(com.google.zxing.MonochromeBitmapSource)">decodeMultiple</A></CODE> in interface <CODE><A HREF="../../../../com/google/zxing/multi/MultipleBarcodeReader.html" title="interface in com.google.zxing.multi">MultipleBarcodeReader</A></CODE></DL>
216 </DD>
217 <DD><DL>
218
219 <DT><B>Throws:</B>
220 <DD><CODE><A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></CODE></DL>
221 </DD>
222 </DL>
223 <HR>
224
225 <A NAME="decodeMultiple(com.google.zxing.MonochromeBitmapSource, java.util.Hashtable)"><!-- --></A><H3>
226 decodeMultiple</H3>
227 <PRE>
228 public <A HREF="../../../../com/google/zxing/Result.html" title="class in com.google.zxing">Result</A>[] <B>decodeMultiple</B>(<A HREF="../../../../com/google/zxing/MonochromeBitmapSource.html" title="interface in com.google.zxing">MonochromeBitmapSource</A>&nbsp;image,
229                                java.util.Hashtable&nbsp;hints)
230                         throws <A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></PRE>
231 <DL>
232 <DD><DL>
233 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/zxing/multi/MultipleBarcodeReader.html#decodeMultiple(com.google.zxing.MonochromeBitmapSource, java.util.Hashtable)">decodeMultiple</A></CODE> in interface <CODE><A HREF="../../../../com/google/zxing/multi/MultipleBarcodeReader.html" title="interface in com.google.zxing.multi">MultipleBarcodeReader</A></CODE></DL>
234 </DD>
235 <DD><DL>
236
237 <DT><B>Throws:</B>
238 <DD><CODE><A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></CODE></DL>
239 </DD>
240 </DL>
241 <!-- ========= END OF CLASS DATA ========= -->
242 <HR>
243
244
245 <!-- ======= START OF BOTTOM NAVBAR ====== -->
246 <A NAME="navbar_bottom"><!-- --></A>
247 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
248 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
249 <TR>
250 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
251 <A NAME="navbar_bottom_firstrow"><!-- --></A>
252 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
253   <TR ALIGN="center" VALIGN="top">
254   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
255   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
256   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
257   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
258   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
259   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
260   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
261   </TR>
262 </TABLE>
263 </TD>
264 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
265 <script type="text/javascript"> var gaJsHost = (("https:" == document.location.protocol) ?  "https://ssl." : "http://www."); document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); </script> <script type="text/javascript"> var pageTracker = _gat._getTracker("UA-788492-5"); pageTracker._initData(); pageTracker._trackPageview(); </script></EM>
266 </TD>
267 </TR>
268
269 <TR>
270 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
271 &nbsp;<A HREF="../../../../com/google/zxing/multi/ByQuadrantReader.html" title="class in com.google.zxing.multi"><B>PREV CLASS</B></A>&nbsp;
272 &nbsp;<A HREF="../../../../com/google/zxing/multi/MultipleBarcodeReader.html" title="interface in com.google.zxing.multi"><B>NEXT CLASS</B></A></FONT></TD>
273 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
274   <A HREF="../../../../index.html?com/google/zxing/multi/GenericMultipleBarcodeReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;
275 &nbsp;<A HREF="GenericMultipleBarcodeReader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
276 &nbsp;<SCRIPT type="text/javascript">
277   <!--
278   if(window==top) {
279     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
280   }
281   //-->
282 </SCRIPT>
283 <NOSCRIPT>
284   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
285 </NOSCRIPT>
286
287
288 </FONT></TD>
289 </TR>
290 <TR>
291 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
292   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
293 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
294 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
295 </TR>
296 </TABLE>
297 <A NAME="skip-navbar_bottom"></A>
298 <!-- ======== END OF BOTTOM NAVBAR ======= -->
299
300 <HR>
301
302 </BODY>
303 </HTML>