Package adams.data.barcode.decode

Class AbstractBarcodeDecoder

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.barcode.decode.AbstractBarcodeDecoder

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

MultiQRCode, PassThrough, ZXing

public abstract class AbstractBarcodeDecoder
extends AbstractOptionHandler

Ancestor for Barcode decoders.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractBarcodeDecoder()

Method Summary

Modifier and Type	Method	Description
protected void	check(AbstractImageContainer image)	Performs checks on the image.
TextContainer	decode(AbstractImageContainer image)	Attempts to decode the barcode in the image.
protected abstract TextContainer	doDecode(AbstractImageContainer image)	Performs the actual decoding.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractBarcodeDecoder

public AbstractBarcodeDecoder()

Method Detail

check

protected void check(AbstractImageContainer image)

Performs checks on the image.

Default implementation just ensures that an image is present.

Parameters:

image - the image to check

doDecode

protected abstract TextContainer doDecode(AbstractImageContainer image)

Performs the actual decoding.

Parameters:

image - the image to extract the barcode from

Returns:

a TextContainer with the decoded barcode text and (optional) meta-data

decode

public TextContainer decode(AbstractImageContainer image)

Attempts to decode the barcode in the image.

Parameters:

image - the image to extract the barcode from

Returns:

a TextContainer with the decoded barcode text and (optional) meta-data