Package io.scanbot.sdk.barcode

Class BarcodeFormatConfigurationBase

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

Direct Known Subclasses:

BarcodeFormatCommonConfiguration, BarcodeFormatCommonFourStateConfiguration, BarcodeFormatCommonOneDConfiguration, BarcodeFormatCommonTwoDConfiguration, BarcodeFormatFourStateConfigurationBase, BarcodeFormatGs1CompositeConfiguration, BarcodeFormatOneDConfigurationBase, BarcodeFormatTwoDConfigurationBase

public abstract class BarcodeFormatConfigurationBase
extends Object

Base class for all barcode configurations.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatConfigurationBase()	Constructs BarcodeFormatConfigurationBase with default parameters.
BarcodeFormatConfigurationBase(String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone)	Constructs BarcodeFormatConfigurationBase with the given params.

Method Summary

Modifier and Type	Method	Description
boolean	getAddAdditionalQuietZone()	Getter for addAdditionalQuietZone field.
double	getMinimumSizeScore()	Getter for minimumSizeScore field.
String	getRegexFilter()	Getter for regexFilter field.
void	setAddAdditionalQuietZone(boolean addAdditionalQuietZone)	Setter for addAdditionalQuietZone field.
void	setMinimumSizeScore(double minimumSizeScore)	Setter for minimumSizeScore field.
void	setRegexFilter(String regexFilter)	Setter for regexFilter field.

Methods inherited from class java.lang.Object

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

Constructor Details

BarcodeFormatConfigurationBase

public BarcodeFormatConfigurationBase(String regexFilter,
 double minimumSizeScore,
 boolean addAdditionalQuietZone)

Constructs BarcodeFormatConfigurationBase 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`.

BarcodeFormatConfigurationBase

public BarcodeFormatConfigurationBase()

Constructs BarcodeFormatConfigurationBase with default parameters.

Method Details

getRegexFilter

public String getRegexFilter()

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

Returns:

regexFilter

setRegexFilter

public void setRegexFilter(String regexFilter)

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

Parameters:

regexFilter - Value to set.

getMinimumSizeScore

public double getMinimumSizeScore()

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

Returns:

minimumSizeScore

setMinimumSizeScore

public void setMinimumSizeScore(double minimumSizeScore)

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

Parameters:

minimumSizeScore - Value to set.

getAddAdditionalQuietZone

public boolean getAddAdditionalQuietZone()

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

Returns:

addAdditionalQuietZone

setAddAdditionalQuietZone

public void setAddAdditionalQuietZone(boolean addAdditionalQuietZone)

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

Parameters:

addAdditionalQuietZone - Value to set.