com.google.zxing.oned
Class UPCAReader

java.lang.Object
  extended by com.google.zxing.oned.UPCAReader
All Implemented Interfaces:
OneDReader, UPCEANReader, Reader

public final class UPCAReader
extends java.lang.Object
implements UPCEANReader

Implements decoding of the UPC-A format.

Author:
dswitkin@google.com (Daniel Switkin), Sean Owen

Constructor Summary
UPCAReader()
           
 
Method Summary
 Result decode(MonochromeBitmapSource image)
          Locates and decodes a barcode in some format within an image.
 Result decode(MonochromeBitmapSource image, java.util.Hashtable hints)
          Locates and decodes a barcode in some format within an image.
 Result decodeRow(int rowNumber, BitArray row, java.util.Hashtable hints)
          Attempts to decode a one-dimensional barcode format given a single row of an image.
 Result decodeRow(int rowNumber, BitArray row, int[] startGuardRange)
          Like OneDReader.decodeRow(int, BitArray, java.util.Hashtable), but allows caller to inform method about where the UPC/EAN start pattern is found.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UPCAReader

public UPCAReader()
Method Detail

decodeRow

public Result decodeRow(int rowNumber,
                        BitArray row,
                        int[] startGuardRange)
                 throws ReaderException
Description copied from interface: UPCEANReader

Like OneDReader.decodeRow(int, BitArray, java.util.Hashtable), but allows caller to inform method about where the UPC/EAN start pattern is found. This allows this to be computed once and reused across many implementations.

Specified by:
decodeRow in interface UPCEANReader
Throws:
ReaderException

decodeRow

public Result decodeRow(int rowNumber,
                        BitArray row,
                        java.util.Hashtable hints)
                 throws ReaderException
Description copied from interface: OneDReader

Attempts to decode a one-dimensional barcode format given a single row of an image.

Specified by:
decodeRow in interface OneDReader
Parameters:
rowNumber - row number from top of the row
row - the black/white pixel data of the row
hints - decode hints
Returns:
Result containing encoded string and start/end of barcode
Throws:
ReaderException - if an error occurs or barcode cannot be found

decode

public Result decode(MonochromeBitmapSource image)
              throws ReaderException
Description copied from interface: Reader
Locates and decodes a barcode in some format within an image.

Specified by:
decode in interface Reader
Parameters:
image - image of barcode to decode
Returns:
String which the barcode encodes
Throws:
ReaderException - if the barcode cannot be located or decoded for any reason

decode

public Result decode(MonochromeBitmapSource image,
                     java.util.Hashtable hints)
              throws ReaderException
Description copied from interface: Reader
Locates and decodes a barcode in some format within an image. This method also accepts hints, each possibly associated to some data, which may help the implementation decode.

Specified by:
decode in interface Reader
Parameters:
image - image of barcode to decode
hints - passed as a Hashtable from DecodeHintType to aribtrary data. The meaning of the data depends upon the hint type. The implementation may or may not do anything with these hints.
Returns:
String which the barcode encodes
Throws:
ReaderException - if the barcode cannot be located or decoded for any reason