Class UPCEReader

java.lang.Object

com.google.zxing.oned.OneDReader

com.google.zxing.oned.UPCEANReader

com.google.zxing.oned.UPCEReader

All Implemented Interfaces:

Reader

public final class UPCEReader
extends UPCEANReader

Implements decoding of the UPC-E format.

This is a great reference for UPC-E information.

Field Summary

Fields

Modifier and Type	Field	Description
private final int[]	decodeMiddleCounters
private static final int[]	MIDDLE_END_PATTERN	The pattern that marks the middle, and end, of a UPC-E pattern.
(package private) static final int[][]	NUMSYS_AND_CHECK_DIGIT_PATTERNS	See UPCEANReader.L_AND_G_PATTERNS; these values similarly represent patterns of even-odd parity encodings of digits that imply both the number system (0 or 1) used, and the check digit.

Fields inherited from class UPCEANReader

END_PATTERN, L_AND_G_PATTERNS, L_PATTERNS, MIDDLE_PATTERN, START_END_PATTERN

Constructor Summary

Constructors

Constructor	Description
UPCEReader()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkChecksum(String s)
static String	convertUPCEtoUPCA(String upce)	Expands a UPC-E value back into its full, equivalent UPC-A code value.
protected int[]	decodeEnd(BitArray row, int endStart)
protected int	decodeMiddle(BitArray row, int[] startRange, StringBuilder result)	Subclasses override this to decode the portion of a barcode between the start and end guard patterns.
private static void	determineNumSysAndCheckDigit(StringBuilder resultString, int lgPatternFound)
(package private) BarcodeFormat	getBarcodeFormat()	Get the format of this decoder.

Methods inherited from class UPCEANReader

checkStandardUPCEANChecksum, decodeDigit, decodeRow, decodeRow, findGuardPattern, findStartGuardPattern, getStandardUPCEANChecksum

Methods inherited from class OneDReader

decode, decode, patternMatchVariance, recordPattern, recordPatternInReverse, reset

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MIDDLE_END_PATTERN

private static final int[] MIDDLE_END_PATTERN

The pattern that marks the middle, and end, of a UPC-E pattern. There is no "second half" to a UPC-E barcode.

NUMSYS_AND_CHECK_DIGIT_PATTERNS

static final int[][] NUMSYS_AND_CHECK_DIGIT_PATTERNS

See UPCEANReader.L_AND_G_PATTERNS; these values similarly represent patterns of even-odd parity encodings of digits that imply both the number system (0 or 1) used, and the check digit.

decodeMiddleCounters

private final int[] decodeMiddleCounters

Constructor Details

UPCEReader

public UPCEReader()

Method Details

decodeMiddle

protected int decodeMiddle(BitArray row,
 int[] startRange,
 StringBuilder result)
                    throws NotFoundException

Description copied from class: UPCEANReader

Subclasses override this to decode the portion of a barcode between the start and end guard patterns.

Specified by:

decodeMiddle in class UPCEANReader

Parameters:

row - row of black/white values to search

startRange - start/end offset of start guard pattern

result - StringBuilder to append decoded chars to

Returns:

horizontal offset of first pixel after the "middle" that was decoded

Throws:

NotFoundException - if decoding could not complete successfully

decodeEnd

protected int[] decodeEnd(BitArray row,
 int endStart)
                   throws NotFoundException

Overrides:

decodeEnd in class UPCEANReader

Throws:

NotFoundException

checkChecksum

protected boolean checkChecksum(String s)
                         throws FormatException

Overrides:

checkChecksum in class UPCEANReader

Parameters:

s - string of digits to check

Returns:

UPCEANReader.checkStandardUPCEANChecksum(CharSequence)

Throws:

FormatException - if the string does not contain only digits

determineNumSysAndCheckDigit

private static void determineNumSysAndCheckDigit(StringBuilder resultString,
 int lgPatternFound)
                                          throws NotFoundException

Throws:

NotFoundException

getBarcodeFormat

BarcodeFormat getBarcodeFormat()

Description copied from class: UPCEANReader

Get the format of this decoder.

Specified by:

getBarcodeFormat in class UPCEANReader

Returns:

The 1D format.

convertUPCEtoUPCA

public static String convertUPCEtoUPCA(String upce)

Expands a UPC-E value back into its full, equivalent UPC-A code value.

Parameters:

upce - UPC-E code as string of digits

Returns:

equivalent UPC-A code as string of digits