Package io.scanbot.sdk.barcode

Class BarcodeFormatCommonConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatCommonConfiguration

public class BarcodeFormatCommonConfiguration
extends BarcodeFormatConfigurationBase

Convenience configuration for enabling the scanning of multiple barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple barcodes. The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatCommonConfiguration()	Constructs BarcodeFormatCommonConfiguration with default parameters.
BarcodeFormatCommonConfiguration(java.lang.String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, int minimum1DQuietZoneSize, int minimum1DConfirmationCount, boolean stripCheckDigits, int minimumTextLength, int maximumTextLength, Gs1Handling gs1Handling, boolean strictMode, boolean enableOneDBlurScanner, java.util.List<BarcodeFormat> formats)	Constructs BarcodeFormatCommonConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
boolean	getEnableOneDBlurScanner()	Getter for enableOneDBlurScanner field.
java.util.List<BarcodeFormat>	getFormats()	Getter for formats field.
Gs1Handling	getGs1Handling()	Getter for gs1Handling field.
int	getMaximumTextLength()	Getter for maximumTextLength field.
int	getMinimum1DConfirmationCount()	Getter for minimum1DConfirmationCount field.
int	getMinimum1DQuietZoneSize()	Getter for minimum1DQuietZoneSize field.
int	getMinimumTextLength()	Getter for minimumTextLength field.
boolean	getStrictMode()	Getter for strictMode field.
boolean	getStripCheckDigits()	Getter for stripCheckDigits field.
void	setEnableOneDBlurScanner(boolean enableOneDBlurScanner)	Setter for enableOneDBlurScanner field.
void	setFormats(java.util.List<BarcodeFormat> formats)	Setter for formats field.
void	setGs1Handling(Gs1Handling gs1Handling)	Setter for gs1Handling field.
void	setMaximumTextLength(int maximumTextLength)	Setter for maximumTextLength field.
void	setMinimum1DConfirmationCount(int minimum1DConfirmationCount)	Setter for minimum1DConfirmationCount field.
void	setMinimum1DQuietZoneSize(int minimum1DQuietZoneSize)	Setter for minimum1DQuietZoneSize field.
void	setMinimumTextLength(int minimumTextLength)	Setter for minimumTextLength field.
void	setStrictMode(boolean strictMode)	Setter for strictMode field.
void	setStripCheckDigits(boolean stripCheckDigits)	Setter for stripCheckDigits field.

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

BarcodeFormatCommonConfiguration

public BarcodeFormatCommonConfiguration(java.lang.String regexFilter,
                                        double minimumSizeScore,
                                        boolean addAdditionalQuietZone,
                                        int minimum1DQuietZoneSize,
                                        int minimum1DConfirmationCount,
                                        boolean stripCheckDigits,
                                        int minimumTextLength,
                                        int maximumTextLength,
                                        Gs1Handling gs1Handling,
                                        boolean strictMode,
                                        boolean enableOneDBlurScanner,
                                        java.util.List<BarcodeFormat> formats)

Constructs BarcodeFormatCommonConfiguration 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

minimumTextLength - Minimum text length. Applied only to linear barcode formats that allow variable length. Default is 1

maximumTextLength - Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length. Default is 0

gs1Handling - GS1 message handling options. Default is PARSE

strictMode - If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives. Default is true

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

formats - List of barcode formats to scan. By default, the most commonly used formats are enabled.

BarcodeFormatCommonConfiguration

public BarcodeFormatCommonConfiguration()

Constructs BarcodeFormatCommonConfiguration with default parameters.

Method Detail

getMinimum1DQuietZoneSize

public int getMinimum1DQuietZoneSize()

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

Returns:

minimum1DQuietZoneSize

setMinimum1DQuietZoneSize

public void setMinimum1DQuietZoneSize(int minimum1DQuietZoneSize)

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

Parameters:

minimum1DQuietZoneSize - Value to set.

getMinimum1DConfirmationCount

public int getMinimum1DConfirmationCount()

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

Returns:

minimum1DConfirmationCount

setMinimum1DConfirmationCount

public void setMinimum1DConfirmationCount(int minimum1DConfirmationCount)

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

Parameters:

minimum1DConfirmationCount - Value to set.

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.

getMinimumTextLength

public int getMinimumTextLength()

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

Returns:

minimumTextLength

setMinimumTextLength

public void setMinimumTextLength(int minimumTextLength)

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

Parameters:

minimumTextLength - Value to set.

getMaximumTextLength

public int getMaximumTextLength()

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

Returns:

maximumTextLength

setMaximumTextLength

public void setMaximumTextLength(int maximumTextLength)

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

Parameters:

maximumTextLength - Value to set.

getGs1Handling

public Gs1Handling getGs1Handling()

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

Returns:

gs1Handling

setGs1Handling

public void setGs1Handling(Gs1Handling gs1Handling)

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

Parameters:

gs1Handling - Value to set.

getStrictMode

public boolean getStrictMode()

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

Returns:

strictMode

setStrictMode

public void setStrictMode(boolean strictMode)

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

Parameters:

strictMode - 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.

getFormats

public java.util.List<BarcodeFormat> getFormats()

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

Returns:

formats

setFormats

public void setFormats(java.util.List<BarcodeFormat> formats)

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

Parameters:

formats - Value to set.