Package io.scanbot.sdk.barcode

Class BarcodeFormatUpcEanConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatOneDConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatUpcEanConfiguration

public class BarcodeFormatUpcEanConfiguration
extends BarcodeFormatOneDConfigurationBase

UPC/EAN barcode configuration. Add to scanner configuration to scan EAN-8, EAN-13, UPC-E and UPC-A barcodes.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatUpcEanConfiguration()	Constructs BarcodeFormatUpcEanConfiguration with default parameters.
BarcodeFormatUpcEanConfiguration(java.lang.String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, int minimum1DQuietZoneSize, int minimum1DConfirmationCount, boolean stripCheckDigits, boolean enableOneDBlurScanner, boolean ean8, boolean ean13, boolean upca, boolean upce, UpcEanExtensionBehavior extensions, int minimumStandaloneConfirmationCount)	Constructs BarcodeFormatUpcEanConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
boolean	getEan13()	Getter for ean13 field.
boolean	getEan8()	Getter for ean8 field.
boolean	getEnableOneDBlurScanner()	Getter for enableOneDBlurScanner field.
UpcEanExtensionBehavior	getExtensions()	Getter for extensions field.
int	getMinimumStandaloneConfirmationCount()	Getter for minimumStandaloneConfirmationCount field.
boolean	getStripCheckDigits()	Getter for stripCheckDigits field.
boolean	getUpca()	Getter for upca field.
boolean	getUpce()	Getter for upce field.
void	setEan13(boolean ean13)	Setter for ean13 field.
void	setEan8(boolean ean8)	Setter for ean8 field.
void	setEnableOneDBlurScanner(boolean enableOneDBlurScanner)	Setter for enableOneDBlurScanner field.
void	setExtensions(UpcEanExtensionBehavior extensions)	Setter for extensions field.
void	setMinimumStandaloneConfirmationCount(int minimumStandaloneConfirmationCount)	Setter for minimumStandaloneConfirmationCount field.
void	setStripCheckDigits(boolean stripCheckDigits)	Setter for stripCheckDigits field.
void	setUpca(boolean upca)	Setter for upca field.
void	setUpce(boolean upce)	Setter for upce field.

Methods inherited from class io.scanbot.sdk.barcode.BarcodeFormatOneDConfigurationBase

getMinimum1DConfirmationCount, getMinimum1DQuietZoneSize, setMinimum1DConfirmationCount, setMinimum1DQuietZoneSize

Methods inherited from class io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

getAddAdditionalQuietZone, getMinimumSizeScore, getRegexFilter, setAddAdditionalQuietZone, setMinimumSizeScore, setRegexFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

BarcodeFormatUpcEanConfiguration

public BarcodeFormatUpcEanConfiguration(java.lang.String regexFilter,
                                        double minimumSizeScore,
                                        boolean addAdditionalQuietZone,
                                        int minimum1DQuietZoneSize,
                                        int minimum1DConfirmationCount,
                                        boolean stripCheckDigits,
                                        boolean enableOneDBlurScanner,
                                        boolean ean8,
                                        boolean ean13,
                                        boolean upca,
                                        boolean upce,
                                        UpcEanExtensionBehavior extensions,
                                        int minimumStandaloneConfirmationCount)

Constructs BarcodeFormatUpcEanConfiguration with the given params.

Parameters:

regexFilter - Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). Default is ""

minimumSizeScore - Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is. Default is 0

addAdditionalQuietZone - If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode. Default is false

minimum1DQuietZoneSize - Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11. Default is 6

minimum1DConfirmationCount - In case of live scanning, we require confirmations across frames to consider the one-d barcode as valid. Default is 1

stripCheckDigits - If true, the check digits are stripped from the result. Default is false

enableOneDBlurScanner - If true, barcodes with heavy blur or from far distance are tried to scan. Default is true

ean8 - If true, scan and return valid EAN-8 barcodes. Default is true

ean13 - If true, scan and return valid EAN-13 barcodes. Default is true

upca - If true, scan and return valid UPC-A barcodes. If false, but ean13 is true, then UPC-A barcodes will be returned as EAN-13 barcodes. Default is true

upce - If true, scan and return valid UPC-E barcodes. Default is true

extensions - Behavior when scanning UPC/EAN barcodes with EAN-2 or EAN-5 extensions. Default is ALLOW_ANY

minimumStandaloneConfirmationCount - In case that ean/upc both with and without extensions are allowed, we require confirmations to consider a standalone EAN or UPC (i.e. without extension) as valid. Default is 1

BarcodeFormatUpcEanConfiguration

public BarcodeFormatUpcEanConfiguration()

Constructs BarcodeFormatUpcEanConfiguration with default parameters.

Method Detail

getStripCheckDigits

public boolean getStripCheckDigits()

Getter for stripCheckDigits field. See constructor documentation for more information about the field.

Returns:

stripCheckDigits

setStripCheckDigits

public void setStripCheckDigits(boolean stripCheckDigits)

Setter for stripCheckDigits field. See constructor documentation for more information about the field.

Parameters:

stripCheckDigits - Value to set.

getEnableOneDBlurScanner

public boolean getEnableOneDBlurScanner()

Getter for enableOneDBlurScanner field. See constructor documentation for more information about the field.

Returns:

enableOneDBlurScanner

setEnableOneDBlurScanner

public void setEnableOneDBlurScanner(boolean enableOneDBlurScanner)

Setter for enableOneDBlurScanner field. See constructor documentation for more information about the field.

Parameters:

enableOneDBlurScanner - Value to set.

getEan8

public boolean getEan8()

Getter for ean8 field. See constructor documentation for more information about the field.

Returns:

ean8

setEan8

public void setEan8(boolean ean8)

Setter for ean8 field. See constructor documentation for more information about the field.

Parameters:

ean8 - Value to set.

getEan13

public boolean getEan13()

Getter for ean13 field. See constructor documentation for more information about the field.

Returns:

ean13

setEan13

public void setEan13(boolean ean13)

Setter for ean13 field. See constructor documentation for more information about the field.

Parameters:

ean13 - Value to set.

getUpca

public boolean getUpca()

Getter for upca field. See constructor documentation for more information about the field.

Returns:

upca

setUpca

public void setUpca(boolean upca)

Setter for upca field. See constructor documentation for more information about the field.

Parameters:

upca - Value to set.

getUpce

public boolean getUpce()

Getter for upce field. See constructor documentation for more information about the field.

Returns:

upce

setUpce

public void setUpce(boolean upce)

Setter for upce field. See constructor documentation for more information about the field.

Parameters:

upce - Value to set.

getExtensions

public UpcEanExtensionBehavior getExtensions()

Getter for extensions field. See constructor documentation for more information about the field.

Returns:

extensions

setExtensions

public void setExtensions(UpcEanExtensionBehavior extensions)

Setter for extensions field. See constructor documentation for more information about the field.

Parameters:

extensions - Value to set.

getMinimumStandaloneConfirmationCount

public int getMinimumStandaloneConfirmationCount()

Getter for minimumStandaloneConfirmationCount field. See constructor documentation for more information about the field.

Returns:

minimumStandaloneConfirmationCount

setMinimumStandaloneConfirmationCount

public void setMinimumStandaloneConfirmationCount(int minimumStandaloneConfirmationCount)

Setter for minimumStandaloneConfirmationCount field. See constructor documentation for more information about the field.

Parameters:

minimumStandaloneConfirmationCount - Value to set.