Package io.scanbot.sdk.barcode

Class BarcodeFormatCodabarConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatOneDConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatCodabarConfiguration

public class BarcodeFormatCodabarConfiguration
extends BarcodeFormatOneDConfigurationBase

Codabar barcode configuration. Add to scanner configuration to scan Codabar barcodes.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	getEnableOneDBlurScanner()	Getter for enableOneDBlurScanner field.
int	getMaximumTextLength()	Getter for maximumTextLength field.
int	getMinimumTextLength()	Getter for minimumTextLength field.
boolean	getReturnStartEnd()	Getter for returnStartEnd field.
void	setEnableOneDBlurScanner(boolean enableOneDBlurScanner)	Setter for enableOneDBlurScanner field.
void	setMaximumTextLength(int maximumTextLength)	Setter for maximumTextLength field.
void	setMinimumTextLength(int minimumTextLength)	Setter for minimumTextLength field.
void	setReturnStartEnd(boolean returnStartEnd)	Setter for returnStartEnd 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

BarcodeFormatCodabarConfiguration

public BarcodeFormatCodabarConfiguration(java.lang.String regexFilter,
                                         double minimumSizeScore,
                                         boolean addAdditionalQuietZone,
                                         int minimum1DQuietZoneSize,
                                         int minimum1DConfirmationCount,
                                         int minimumTextLength,
                                         int maximumTextLength,
                                         boolean enableOneDBlurScanner,
                                         boolean returnStartEnd)

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

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

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

returnStartEnd - If true, return the start and end characters. Default is false

BarcodeFormatCodabarConfiguration

public BarcodeFormatCodabarConfiguration()

Constructs BarcodeFormatCodabarConfiguration with default parameters.

Method Detail

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.

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.

getReturnStartEnd

public boolean getReturnStartEnd()

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

Returns:

returnStartEnd

setReturnStartEnd

public void setReturnStartEnd(boolean returnStartEnd)

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

Parameters:

returnStartEnd - Value to set.