Package com.google.zxing.maxicode

Class MaxiCodeReader

java.lang.Object

com.google.zxing.maxicode.MaxiCodeReader

All Implemented Interfaces:

Reader

public final class MaxiCodeReader
extends java.lang.Object
implements Reader

This implementation can detect and decode a MaxiCode in an image.

Field Summary

Fields

Modifier and Type	Field	Description
private Decoder	decoder
private static int	MATRIX_HEIGHT
private static int	MATRIX_WIDTH
private static ResultPoint[]	NO_POINTS

Constructor Summary

Constructors

Constructor	Description
MaxiCodeReader()

Method Summary

Modifier and Type	Method	Description
Result	decode(BinaryBitmap image)	Locates and decodes a MaxiCode in an image.
Result	decode(BinaryBitmap image, java.util.Map<DecodeHintType,?> hints)	Locates and decodes a barcode in some format within an image.
private static BitMatrix	extractPureBits(BitMatrix image)	This method detects a code in a "pure" image -- that is, pure monochrome image which contains only an unrotated, unskewed, image of a code, with some white border around it.
void	reset()	Resets any internal state the implementation has after a decode, to prepare it for reuse.

Methods inherited from class java.lang.Object

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

Field Detail

NO_POINTS

private static final ResultPoint[] NO_POINTS

MATRIX_WIDTH

private static final int MATRIX_WIDTH

See Also:

Constant Field Values

MATRIX_HEIGHT

private static final int MATRIX_HEIGHT

See Also:

Constant Field Values

decoder

private final Decoder decoder

Constructor Detail

MaxiCodeReader

public MaxiCodeReader()

Method Detail

decode

public Result decode(BinaryBitmap image)
              throws NotFoundException,
                     ChecksumException,
                     FormatException

Locates and decodes a MaxiCode in an image.

Specified by:

decode in interface Reader

Parameters:

image - image of barcode to decode

Returns:

a String representing the content encoded by the MaxiCode

Throws:

NotFoundException - if a MaxiCode cannot be found

FormatException - if a MaxiCode cannot be decoded

ChecksumException - if error correction fails

decode

public Result decode(BinaryBitmap image,
                     java.util.Map<DecodeHintType,?> hints)
              throws NotFoundException,
                     ChecksumException,
                     FormatException

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 Map from DecodeHintType to arbitrary 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:

NotFoundException - if no potential barcode is found

ChecksumException - if a potential barcode is found but does not pass its checksum

FormatException - if a potential barcode is found but format is invalid

reset

public void reset()

Description copied from interface: Reader

Resets any internal state the implementation has after a decode, to prepare it for reuse.

Specified by:

reset in interface Reader

extractPureBits

private static BitMatrix extractPureBits(BitMatrix image)
                                  throws NotFoundException

This method detects a code in a "pure" image -- that is, pure monochrome image which contains only an unrotated, unskewed, image of a code, with some white border around it. This is a specialized method that works exceptionally fast in this special case.

Throws:

NotFoundException