Package io.scanbot.sdk.barcode

Class BarcodeFormatCode11Configuration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatOneDConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatCode11Configuration

public class BarcodeFormatCode11Configuration
extends BarcodeFormatOneDConfigurationBase

Code 11 barcode configuration. Add to scanner configuration to scan Code 11 barcodes.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatCode11Configuration()	Constructs BarcodeFormatCode11Configuration with default parameters.
BarcodeFormatCode11Configuration(java.lang.String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, int minimum1DQuietZoneSize, int minimum1DConfirmationCount, boolean stripCheckDigits, int minimumTextLength, int maximumTextLength, boolean checksum)	Constructs BarcodeFormatCode11Configuration with the given params.

Method Summary

Modifier and Type	Method	Description
boolean	getChecksum()	Getter for checksum field.
int	getMaximumTextLength()	Getter for maximumTextLength field.
int	getMinimumTextLength()	Getter for minimumTextLength field.
boolean	getStripCheckDigits()	Getter for stripCheckDigits field.
void	setChecksum(boolean checksum)	Setter for checksum field.
void	setMaximumTextLength(int maximumTextLength)	Setter for maximumTextLength field.
void	setMinimumTextLength(int minimumTextLength)	Setter for minimumTextLength field.
void	setStripCheckDigits(boolean stripCheckDigits)	Setter for stripCheckDigits 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

BarcodeFormatCode11Configuration

public BarcodeFormatCode11Configuration(java.lang.String regexFilter,
                                        double minimumSizeScore,
                                        boolean addAdditionalQuietZone,
                                        int minimum1DQuietZoneSize,
                                        int minimum1DConfirmationCount,
                                        boolean stripCheckDigits,
                                        int minimumTextLength,
                                        int maximumTextLength,
                                        boolean checksum)

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

checksum - If true, return CODE_11 barcodes only if they have a valid checksum. Default is true

BarcodeFormatCode11Configuration

public BarcodeFormatCode11Configuration()

Constructs BarcodeFormatCode11Configuration 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.

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.

getChecksum

public boolean getChecksum()

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

Returns:

checksum

setChecksum

public void setChecksum(boolean checksum)

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

Parameters:

checksum - Value to set.