Class BarcodeScannerAdditionalConfiguration
-
- All Implemented Interfaces:
public final class BarcodeScannerAdditionalConfiguration
Entity represents additional configuration params for ScanbotBarcodeDetector.
Note: only a few barcode types support these params - for the rest these settings will have no influence. Please read each param documentation carefully before modifying.
Note: in future these params might change their behavior. If you you use non-default values in your code please read changelogs of future versions carefully to avoid subtle changes in application logic.
-
-
Field Summary
Fields Modifier and Type Field Description private final Integer
minimumTextLength
private final Integer
maximumTextLength
private final Integer
minimum1DQuietZoneSize
private final Gs1Handling
gs1HandlingMode
private final EnumSet<MSIPlesseyChecksumAlgorithm>
msiPlesseyChecksumAlgorithms
private final Boolean
stripCheckDigits
private final Boolean
lowPowerMode
private final Boolean
useIata2Of5Checksum
private final Boolean
useCode11Checksum
private final AustraliaPostCustomerFormat
australiaPostCustomerFormat
-
Constructor Summary
Constructors Constructor Description BarcodeScannerAdditionalConfiguration(Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Gs1Handling gs1HandlingMode, EnumSet<MSIPlesseyChecksumAlgorithm> msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Boolean useIata2Of5Checksum, Boolean useCode11Checksum, AustraliaPostCustomerFormat australiaPostCustomerFormat)
-
Method Summary
Modifier and Type Method Description final Integer
getMinimumTextLength()
Minimum required text length of the detected barcode. final Integer
getMaximumTextLength()
Maximum text length of the detected barcode. final Integer
getMinimum1DQuietZoneSize()
Minimum required quiet zone on the barcode. final Gs1Handling
getGs1HandlingMode()
GS1 handling mode. final EnumSet<MSIPlesseyChecksumAlgorithm>
getMsiPlesseyChecksumAlgorithms()
The checksum algorithms for MSI Plessey barcodes. final Boolean
getStripCheckDigits()
If true, check digits for UPC, EAN and MSI Plessey codes are removed from result. final Boolean
getLowPowerMode()
If true
, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed.final Boolean
getUseIata2Of5Checksum()
final Boolean
getUseCode11Checksum()
final AustraliaPostCustomerFormat
getAustraliaPostCustomerFormat()
-
-
Constructor Detail
-
BarcodeScannerAdditionalConfiguration
BarcodeScannerAdditionalConfiguration(Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Gs1Handling gs1HandlingMode, EnumSet<MSIPlesseyChecksumAlgorithm> msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Boolean useIata2Of5Checksum, Boolean useCode11Checksum, AustraliaPostCustomerFormat australiaPostCustomerFormat)
-
-
Method Detail
-
getMinimumTextLength
final Integer getMinimumTextLength()
Minimum required text length of the detected barcode. The default value is 0 (the setting is turned off). NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getMaximumTextLength
final Integer getMaximumTextLength()
Maximum text length of the detected barcode. Setting to zero removes the limit. The default value is 0 (the setting is turned off). NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getMinimum1DQuietZoneSize
final Integer getMinimum1DQuietZoneSize()
Minimum required quiet zone on the barcode. Measured in modules (the size of a minimal bar on the barcode). The default value is 10. NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getGs1HandlingMode
final Gs1Handling getGs1HandlingMode()
GS1 handling mode. The default is Gs1Handling.PARSE.
-
getMsiPlesseyChecksumAlgorithms
final EnumSet<MSIPlesseyChecksumAlgorithm> getMsiPlesseyChecksumAlgorithms()
The checksum algorithms for MSI Plessey barcodes. The default value is MSIPlesseyChecksumAlgorithm.Mod10.
-
getStripCheckDigits
final Boolean getStripCheckDigits()
If true, check digits for UPC, EAN and MSI Plessey codes are removed from result. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is
false
-
getLowPowerMode
final Boolean getLowPowerMode()
If
true
, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. Iffalse
- mode is disabled. The default isfalse
-
getUseIata2Of5Checksum
final Boolean getUseIata2Of5Checksum()
-
getUseCode11Checksum
final Boolean getUseCode11Checksum()
-
getAustraliaPostCustomerFormat
final AustraliaPostCustomerFormat getAustraliaPostCustomerFormat()
-
-
-
-