Package io.scanbot.sdk.barcode

Class BarcodeFormatCode2Of5Configuration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatOneDConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatCode2Of5Configuration

public class BarcodeFormatCode2Of5Configuration
extends BarcodeFormatOneDConfigurationBase

Configuration for all 2-of-5 barcode types (except Interleaved 2-of-5, which is handled by ItfConfig). Add to scanner configuration to scan Code 25, IATA 2-of-5 and Industrial 2-of-5 barcodes. Industrial 2-of-5 barcodes are a subset of Code 25 barcodes. Any valid Industrial 2-of-5 barcode is also a valid Code 25 barcode.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatCode2Of5Configuration()	Constructs BarcodeFormatCode2Of5Configuration with default parameters.
BarcodeFormatCode2Of5Configuration(java.lang.String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, int minimum1DQuietZoneSize, int minimum1DConfirmationCount, boolean stripCheckDigits, int minimumTextLength, int maximumTextLength, boolean iata2of5, boolean code25, boolean industrial2of5, boolean useIATA2OF5Checksum)	Constructs BarcodeFormatCode2Of5Configuration with the given params.

Method Summary

Modifier and Type	Method	Description
boolean	getCode25()	Getter for code25 field.
boolean	getIata2of5()	Getter for iata2of5 field.
boolean	getIndustrial2of5()	Getter for industrial2of5 field.
int	getMaximumTextLength()	Getter for maximumTextLength field.
int	getMinimumTextLength()	Getter for minimumTextLength field.
boolean	getStripCheckDigits()	Getter for stripCheckDigits field.
boolean	getUseIATA2OF5Checksum()	Getter for useIATA2OF5Checksum field.
void	setCode25(boolean code25)	Setter for code25 field.
void	setIata2of5(boolean iata2of5)	Setter for iata2of5 field.
void	setIndustrial2of5(boolean industrial2of5)	Setter for industrial2of5 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.
void	setUseIATA2OF5Checksum(boolean useIATA2OF5Checksum)	Setter for useIATA2OF5Checksum 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

BarcodeFormatCode2Of5Configuration

public BarcodeFormatCode2Of5Configuration(java.lang.String regexFilter,
                                          double minimumSizeScore,
                                          boolean addAdditionalQuietZone,
                                          int minimum1DQuietZoneSize,
                                          int minimum1DConfirmationCount,
                                          boolean stripCheckDigits,
                                          int minimumTextLength,
                                          int maximumTextLength,
                                          boolean iata2of5,
                                          boolean code25,
                                          boolean industrial2of5,
                                          boolean useIATA2OF5Checksum)

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

iata2of5 - If true, scan IATA 2-of-5 barcodes. If useIATA2OF5Checksum is true, only barcodes with a valid checksum are returned. Default is true

code25 - If true, scan and return Code 25 (Code 2-of-5) barcodes. If industrial2of5 is also true, then valid Industrial 2-of-5 barcodes will preferentially be returned as such, instead of Code 25. Default is false

industrial2of5 - If true, scan and return valid Industrial 2-of-5 barcodes. If false, but code25 is true, Industrial 2-of-5 barcodes will be returned as Code 25 barcodes. Default is true

useIATA2OF5Checksum - If true, return IATA_2_OF_5 barcodes only if they have a valid check digit. Default is true

BarcodeFormatCode2Of5Configuration

public BarcodeFormatCode2Of5Configuration()

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

getIata2of5

public boolean getIata2of5()

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

Returns:

iata2of5

setIata2of5

public void setIata2of5(boolean iata2of5)

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

Parameters:

iata2of5 - Value to set.

getCode25

public boolean getCode25()

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

Returns:

code25

setCode25

public void setCode25(boolean code25)

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

Parameters:

code25 - Value to set.

getIndustrial2of5

public boolean getIndustrial2of5()

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

Returns:

industrial2of5

setIndustrial2of5

public void setIndustrial2of5(boolean industrial2of5)

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

Parameters:

industrial2of5 - Value to set.

getUseIATA2OF5Checksum

public boolean getUseIATA2OF5Checksum()

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

Returns:

useIATA2OF5Checksum

setUseIATA2OF5Checksum

public void setUseIATA2OF5Checksum(boolean useIATA2OF5Checksum)

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

Parameters:

useIATA2OF5Checksum - Value to set.