Class BarcodeFormatCode2Of5Configuration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class BarcodeFormatCode2Of5Configuration extends BarcodeFormatOneDConfigurationBase implements Parcelable
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.
-
-
Field Summary
Fields Modifier and Type Field Description private final String
_type
private String
regexFilter
private Double
minimumSizeScore
private Boolean
addAdditionalQuietZone
private Integer
minimum1DQuietZoneSize
private Boolean
stripCheckDigits
private Integer
minimumTextLength
private Integer
maximumTextLength
private Boolean
iata2of5
private Boolean
code25
private Boolean
industrial2of5
private Boolean
useIATA2OF5Checksum
-
Constructor Summary
Constructors Constructor Description BarcodeFormatCode2Of5Configuration(Map<String, Object> source)
BarcodeFormatCode2Of5Configuration(JSONObject json)
BarcodeFormatCode2Of5Configuration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, Integer minimum1DQuietZoneSize, Boolean stripCheckDigits, Integer minimumTextLength, Integer maximumTextLength, Boolean iata2of5, Boolean code25, Boolean industrial2of5, Boolean useIATA2OF5Checksum)
-
Method Summary
Modifier and Type Method Description String
get_type()
String
getRegexFilter()
Regular expression filter for barcode text. Unit
setRegexFilter(String regexFilter)
Regular expression filter for barcode text. Double
getMinimumSizeScore()
Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Unit
setMinimumSizeScore(Double minimumSizeScore)
Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Boolean
getAddAdditionalQuietZone()
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. Unit
setAddAdditionalQuietZone(Boolean addAdditionalQuietZone)
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. Integer
getMinimum1DQuietZoneSize()
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. Unit
setMinimum1DQuietZoneSize(Integer minimum1DQuietZoneSize)
Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. final Boolean
getStripCheckDigits()
If true, the check digits are stripped from the result. final Unit
setStripCheckDigits(Boolean stripCheckDigits)
If true, the check digits are stripped from the result. final Integer
getMinimumTextLength()
Minimum text length. final Unit
setMinimumTextLength(Integer minimumTextLength)
Minimum text length. final Integer
getMaximumTextLength()
Maximum text length. final Unit
setMaximumTextLength(Integer maximumTextLength)
Maximum text length. final Boolean
getIata2of5()
If true, scan IATA 2-of-5 barcodes. final Unit
setIata2of5(Boolean iata2of5)
If true, scan IATA 2-of-5 barcodes. final Boolean
getCode25()
If true, scan and return Code 25 (Code 2-of-5) barcodes. final Unit
setCode25(Boolean code25)
If true, scan and return Code 25 (Code 2-of-5) barcodes. final Boolean
getIndustrial2of5()
If true, scan and return valid Industrial 2-of-5 barcodes. final Unit
setIndustrial2of5(Boolean industrial2of5)
If true, scan and return valid Industrial 2-of-5 barcodes. final Boolean
getUseIATA2OF5Checksum()
If true, return IATA_2_OF_5 barcodes only if they have a valid check digit. final Unit
setUseIATA2OF5Checksum(Boolean useIATA2OF5Checksum)
If true, return IATA_2_OF_5 barcodes only if they have a valid check digit. JSONObject
toJson(ToJsonConfiguration config)
BarcodeFormatCode2Of5Configuration
clone()
final static BarcodeFormatCode2Of5Configuration
default()
-
-
-
Constructor Detail
-
BarcodeFormatCode2Of5Configuration
BarcodeFormatCode2Of5Configuration(JSONObject json)
-
BarcodeFormatCode2Of5Configuration
BarcodeFormatCode2Of5Configuration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, Integer minimum1DQuietZoneSize, Boolean stripCheckDigits, Integer minimumTextLength, Integer maximumTextLength, Boolean iata2of5, Boolean code25, Boolean industrial2of5, Boolean useIATA2OF5Checksum)
-
-
Method Detail
-
getRegexFilter
String getRegexFilter()
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 ""
-
setRegexFilter
Unit setRegexFilter(String 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 ""
-
getMinimumSizeScore
Double getMinimumSizeScore()
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
-
setMinimumSizeScore
Unit setMinimumSizeScore(Double 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
-
getAddAdditionalQuietZone
Boolean getAddAdditionalQuietZone()
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
-
setAddAdditionalQuietZone
Unit setAddAdditionalQuietZone(Boolean 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
-
getMinimum1DQuietZoneSize
Integer getMinimum1DQuietZoneSize()
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
-
setMinimum1DQuietZoneSize
Unit setMinimum1DQuietZoneSize(Integer 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
-
getStripCheckDigits
final Boolean getStripCheckDigits()
If true, the check digits are stripped from the result.
Default is false
-
setStripCheckDigits
final Unit setStripCheckDigits(Boolean stripCheckDigits)
If true, the check digits are stripped from the result.
Default is false
-
getMinimumTextLength
final Integer getMinimumTextLength()
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
-
setMinimumTextLength
final Unit setMinimumTextLength(Integer minimumTextLength)
Minimum text length. Applied only to linear barcode formats that allow variable length.
Default is 1
-
getMaximumTextLength
final Integer getMaximumTextLength()
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
-
setMaximumTextLength
final Unit setMaximumTextLength(Integer maximumTextLength)
Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.
Default is 0
-
getIata2of5
final Boolean getIata2of5()
If true, scan IATA 2-of-5 barcodes. If useIATA2OF5Checksum is true, only barcodes with a valid checksum are returned.
Default is true
-
setIata2of5
final Unit setIata2of5(Boolean iata2of5)
If true, scan IATA 2-of-5 barcodes. If useIATA2OF5Checksum is true, only barcodes with a valid checksum are returned.
Default is true
-
getCode25
final Boolean getCode25()
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
-
setCode25
final Unit setCode25(Boolean 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
-
getIndustrial2of5
final Boolean getIndustrial2of5()
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
-
setIndustrial2of5
final Unit setIndustrial2of5(Boolean 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
-
getUseIATA2OF5Checksum
final Boolean getUseIATA2OF5Checksum()
If true, return IATA_2_OF_5 barcodes only if they have a valid check digit.
Default is true
-
setUseIATA2OF5Checksum
final Unit setUseIATA2OF5Checksum(Boolean useIATA2OF5Checksum)
If true, return IATA_2_OF_5 barcodes only if they have a valid check digit.
Default is true
-
toJson
JSONObject toJson(ToJsonConfiguration config)
-
default
final static BarcodeFormatCode2Of5Configuration default()
-
-