1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (build 1.6.0_13) on Fri Jun 26 13:12:29 EDT 2009 -->
10 <META NAME="date" CONTENT="2009-06-26">
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14 <SCRIPT type="text/javascript">
15 function windowTitle()
17 if (location.href.indexOf('is-external=true') == -1) {
18 parent.document.title="UPCEReader";
27 <BODY BGCOLOR="white" onload="windowTitle();">
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="">
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> </TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
50 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../../com/google/zxing/oned/UPCEANWriter.html" title="interface in com.google.zxing.oned"><B>PREV CLASS</B></A>
58 NEXT CLASS</FONT></TD>
59 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60 <A HREF="../../../../index.html?com/google/zxing/oned/UPCEReader.html" target="_top"><B>FRAMES</B></A>
61 <A HREF="UPCEReader.html" target="_top"><B>NO FRAMES</B></A>
62 <SCRIPT type="text/javascript">
65 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
70 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
83 <A NAME="skip-navbar_top"></A>
84 <!-- ========= END OF TOP NAVBAR ========= -->
87 <!-- ======== START OF CLASS DATA ======== -->
90 com.google.zxing.oned</FONT>
95 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/google/zxing/oned/AbstractOneDReader.html" title="class in com.google.zxing.oned">com.google.zxing.oned.AbstractOneDReader</A>
96 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html" title="class in com.google.zxing.oned">com.google.zxing.oned.AbstractUPCEANReader</A>
97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.google.zxing.oned.UPCEReader</B>
100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/google/zxing/oned/OneDReader.html" title="interface in com.google.zxing.oned">OneDReader</A>, <A HREF="../../../../com/google/zxing/oned/UPCEANReader.html" title="interface in com.google.zxing.oned">UPCEANReader</A>, <A HREF="../../../../com/google/zxing/Reader.html" title="interface in com.google.zxing">Reader</A></DD>
104 <DT><PRE>public final class <B>UPCEReader</B><DT>extends <A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html" title="class in com.google.zxing.oned">AbstractUPCEANReader</A></DL>
108 <p>Implements decoding of the UPC-E format.</p>
110 <p><a href="http://www.barcodeisland.com/upce.phtml">This</a> is a great reference for
111 UPC-E information.</p>
116 <DT><B>Author:</B></DT>
123 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
125 <A NAME="constructor_summary"><!-- --></A>
126 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
129 <B>Constructor Summary</B></FONT></TH>
131 <TR BGCOLOR="white" CLASS="TableRowColor">
132 <TD><CODE><B><A HREF="../../../../com/google/zxing/oned/UPCEReader.html#UPCEReader()">UPCEReader</A></B>()</CODE>
135 </TD>
139 <!-- ========== METHOD SUMMARY =========== -->
141 <A NAME="method_summary"><!-- --></A>
142 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
143 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
144 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
145 <B>Method Summary</B></FONT></TH>
147 <TR BGCOLOR="white" CLASS="TableRowColor">
148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149 <CODE>protected boolean</CODE></FONT></TD>
150 <TD><CODE><B><A HREF="../../../../com/google/zxing/oned/UPCEReader.html#checkChecksum(java.lang.String)">checkChecksum</A></B>(java.lang.String s)</CODE>
153 </TD>
155 <TR BGCOLOR="white" CLASS="TableRowColor">
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157 <CODE>static java.lang.String</CODE></FONT></TD>
158 <TD><CODE><B><A HREF="../../../../com/google/zxing/oned/UPCEReader.html#convertUPCEtoUPCA(java.lang.String)">convertUPCEtoUPCA</A></B>(java.lang.String upce)</CODE>
161 Expands a UPC-E value back into its full, equivalent UPC-A code value.</TD>
163 <TR BGCOLOR="white" CLASS="TableRowColor">
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165 <CODE>protected int[]</CODE></FONT></TD>
166 <TD><CODE><B><A HREF="../../../../com/google/zxing/oned/UPCEReader.html#decodeEnd(com.google.zxing.common.BitArray, int)">decodeEnd</A></B>(<A HREF="../../../../com/google/zxing/common/BitArray.html" title="class in com.google.zxing.common">BitArray</A> row,
167 int endStart)</CODE>
170 </TD>
172 <TR BGCOLOR="white" CLASS="TableRowColor">
173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174 <CODE>protected int</CODE></FONT></TD>
175 <TD><CODE><B><A HREF="../../../../com/google/zxing/oned/UPCEReader.html#decodeMiddle(com.google.zxing.common.BitArray, int[], java.lang.StringBuffer)">decodeMiddle</A></B>(<A HREF="../../../../com/google/zxing/common/BitArray.html" title="class in com.google.zxing.common">BitArray</A> row,
176 int[] startRange,
177 java.lang.StringBuffer result)</CODE>
180 Subclasses override this to decode the portion of a barcode between the start and end guard patterns.</TD>
183 <A NAME="methods_inherited_from_class_com.google.zxing.oned.AbstractUPCEANReader"><!-- --></A>
184 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
186 <TH ALIGN="left"><B>Methods inherited from class com.google.zxing.oned.<A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html" title="class in com.google.zxing.oned">AbstractUPCEANReader</A></B></TH>
188 <TR BGCOLOR="white" CLASS="TableRowColor">
189 <TD><CODE><A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html#checkStandardUPCEANChecksum(java.lang.String)">checkStandardUPCEANChecksum</A>, <A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html#decodeRow(int, com.google.zxing.common.BitArray, java.util.Hashtable)">decodeRow</A>, <A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html#decodeRow(int, com.google.zxing.common.BitArray, int[])">decodeRow</A></CODE></TD>
192 <A NAME="methods_inherited_from_class_com.google.zxing.oned.AbstractOneDReader"><!-- --></A>
193 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
194 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
195 <TH ALIGN="left"><B>Methods inherited from class com.google.zxing.oned.<A HREF="../../../../com/google/zxing/oned/AbstractOneDReader.html" title="class in com.google.zxing.oned">AbstractOneDReader</A></B></TH>
197 <TR BGCOLOR="white" CLASS="TableRowColor">
198 <TD><CODE><A HREF="../../../../com/google/zxing/oned/AbstractOneDReader.html#decode(com.google.zxing.MonochromeBitmapSource)">decode</A>, <A HREF="../../../../com/google/zxing/oned/AbstractOneDReader.html#decode(com.google.zxing.MonochromeBitmapSource, java.util.Hashtable)">decode</A></CODE></TD>
201 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
202 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
204 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
206 <TR BGCOLOR="white" CLASS="TableRowColor">
207 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
210 <A NAME="methods_inherited_from_class_com.google.zxing.Reader"><!-- --></A>
211 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
213 <TH ALIGN="left"><B>Methods inherited from interface com.google.zxing.<A HREF="../../../../com/google/zxing/Reader.html" title="interface in com.google.zxing">Reader</A></B></TH>
215 <TR BGCOLOR="white" CLASS="TableRowColor">
216 <TD><CODE><A HREF="../../../../com/google/zxing/Reader.html#decode(com.google.zxing.MonochromeBitmapSource)">decode</A>, <A HREF="../../../../com/google/zxing/Reader.html#decode(com.google.zxing.MonochromeBitmapSource, java.util.Hashtable)">decode</A></CODE></TD>
222 <!-- ========= CONSTRUCTOR DETAIL ======== -->
224 <A NAME="constructor_detail"><!-- --></A>
225 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
226 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
227 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
228 <B>Constructor Detail</B></FONT></TH>
232 <A NAME="UPCEReader()"><!-- --></A><H3>
235 public <B>UPCEReader</B>()</PRE>
239 <!-- ============ METHOD DETAIL ========== -->
241 <A NAME="method_detail"><!-- --></A>
242 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
243 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
244 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
245 <B>Method Detail</B></FONT></TH>
249 <A NAME="decodeMiddle(com.google.zxing.common.BitArray, int[], java.lang.StringBuffer)"><!-- --></A><H3>
252 protected int <B>decodeMiddle</B>(<A HREF="../../../../com/google/zxing/common/BitArray.html" title="class in com.google.zxing.common">BitArray</A> row,
253 int[] startRange,
254 java.lang.StringBuffer result)
255 throws <A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></PRE>
257 <DD><B>Description copied from class: <CODE><A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html#decodeMiddle(com.google.zxing.common.BitArray, int[], java.lang.StringBuffer)">AbstractUPCEANReader</A></CODE></B></DD>
258 <DD>Subclasses override this to decode the portion of a barcode between the start and end guard patterns.
261 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html#decodeMiddle(com.google.zxing.common.BitArray, int[], java.lang.StringBuffer)">decodeMiddle</A></CODE> in class <CODE><A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html" title="class in com.google.zxing.oned">AbstractUPCEANReader</A></CODE></DL>
264 <DT><B>Parameters:</B><DD><CODE>row</CODE> - row of black/white values to search<DD><CODE>startRange</CODE> - start/end offset of start guard pattern<DD><CODE>result</CODE> - <CODE>StringBuffer</CODE> to append decoded chars to
265 <DT><B>Returns:</B><DD>horizontal offset of first pixel after the "middle" that was decoded
267 <DD><CODE><A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></CODE> - if decoding could not complete successfully</DL>
272 <A NAME="decodeEnd(com.google.zxing.common.BitArray, int)"><!-- --></A><H3>
275 protected int[] <B>decodeEnd</B>(<A HREF="../../../../com/google/zxing/common/BitArray.html" title="class in com.google.zxing.common">BitArray</A> row,
277 throws <A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></PRE>
285 <DD><CODE><A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></CODE></DL>
290 <A NAME="checkChecksum(java.lang.String)"><!-- --></A><H3>
293 protected boolean <B>checkChecksum</B>(java.lang.String s)
294 throws <A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></PRE>
301 <DT><B>Returns:</B><DD><A HREF="../../../../com/google/zxing/oned/AbstractUPCEANReader.html#checkStandardUPCEANChecksum(java.lang.String)"><CODE>AbstractUPCEANReader.checkStandardUPCEANChecksum(String)</CODE></A>
303 <DD><CODE><A HREF="../../../../com/google/zxing/ReaderException.html" title="class in com.google.zxing">ReaderException</A></CODE></DL>
308 <A NAME="convertUPCEtoUPCA(java.lang.String)"><!-- --></A><H3>
309 convertUPCEtoUPCA</H3>
311 public static java.lang.String <B>convertUPCEtoUPCA</B>(java.lang.String upce)</PRE>
313 <DD>Expands a UPC-E value back into its full, equivalent UPC-A code value.
316 <DT><B>Parameters:</B><DD><CODE>upce</CODE> - UPC-E code as string of digits
317 <DT><B>Returns:</B><DD>equivalent UPC-A code as string of digits</DL>
320 <!-- ========= END OF CLASS DATA ========= -->
324 <!-- ======= START OF BOTTOM NAVBAR ====== -->
325 <A NAME="navbar_bottom"><!-- --></A>
326 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
327 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
329 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
330 <A NAME="navbar_bottom_firstrow"><!-- --></A>
331 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
332 <TR ALIGN="center" VALIGN="top">
333 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
334 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
335 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
336 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
337 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
338 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
339 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
343 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
344 <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>
349 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
350 <A HREF="../../../../com/google/zxing/oned/UPCEANWriter.html" title="interface in com.google.zxing.oned"><B>PREV CLASS</B></A>
351 NEXT CLASS</FONT></TD>
352 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
353 <A HREF="../../../../index.html?com/google/zxing/oned/UPCEReader.html" target="_top"><B>FRAMES</B></A>
354 <A HREF="UPCEReader.html" target="_top"><B>NO FRAMES</B></A>
355 <SCRIPT type="text/javascript">
358 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
363 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
370 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
371 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
372 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
373 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
376 <A NAME="skip-navbar_bottom"></A>
377 <!-- ======== END OF BOTTOM NAVBAR ======= -->