Package io.scanbot.sdk.barcode

Class BarcodeFormatGs1CompositeConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatGs1CompositeConfiguration

public class BarcodeFormatGs1CompositeConfiguration
extends BarcodeFormatConfigurationBase

GS1 Composite configuration. Add to scanner configuration to scan GS1 Composite barcodes. When not enabled, the individual parts of GS1 Composite barcodes will be returned as separate items, if the respective formats are enabled (UPC-A, Code 128, MicroPDF417, PDF417). Those barcode items will have their isGS1CompositePart field set to true. If GS1 Composite scanning is enabled, the individual parts are never returned, even if their respective formats are enabled, except when the linear component is a UPC or EAN barcode. In that case the linear component might still occasionally be returned as a separate result. If this situation needs to be avoided, remove the UPC and EAN formats from the enabled formats. If GS1 Composite scanning is disabled, but GS1 message validation is enabled, then the parts of the composite barcode may fail validation and be rejected.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatGs1CompositeConfiguration()	Constructs BarcodeFormatGs1CompositeConfiguration with default parameters.
BarcodeFormatGs1CompositeConfiguration(java.lang.String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, int minimum1DQuietZoneSize, Gs1Handling gs1Handling, boolean strictMode)	Constructs BarcodeFormatGs1CompositeConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
Gs1Handling	getGs1Handling()	Getter for gs1Handling field.
int	getMinimum1DQuietZoneSize()	Getter for minimum1DQuietZoneSize field.
boolean	getStrictMode()	Getter for strictMode field.
void	setGs1Handling(Gs1Handling gs1Handling)	Setter for gs1Handling field.
void	setMinimum1DQuietZoneSize(int minimum1DQuietZoneSize)	Setter for minimum1DQuietZoneSize field.
void	setStrictMode(boolean strictMode)	Setter for strictMode 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

BarcodeFormatGs1CompositeConfiguration

public BarcodeFormatGs1CompositeConfiguration(java.lang.String regexFilter,
                                              double minimumSizeScore,
                                              boolean addAdditionalQuietZone,
                                              int minimum1DQuietZoneSize,
                                              Gs1Handling gs1Handling,
                                              boolean strictMode)

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

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

BarcodeFormatGs1CompositeConfiguration

public BarcodeFormatGs1CompositeConfiguration()

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

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.