com.symbol.emdk.barcode

Class ScannerConfig.DecoderParams.UpcEanParams

java.lang.Object

com.symbol.emdk.barcode.ScannerConfig.DecoderParams.UpcEanParams

Enclosing class:

ScannerConfig.DecoderParams

public class ScannerConfig.DecoderParams.UpcEanParams
extends java.lang.Object

The UPCEAN class provides access to parameters that are available for the UPC/EAN decoder. UPC/EAN is the family of codes which are used to identify products and UPC EAN Params are the params common to these codes

 
 	Example Usage:
 	config.upcEanParams.booklandCode = true;
 
 

Field Summary

Fields

Modifier and Type	Field and Description
boolean	booklandCode Flag to enable Bookland code decoding.
ScannerConfig.BooklandFormat	booklandFormat Specifies the bookland format to use.
boolean	convertDataBarToUpcEan If this is set it converts DataBar barcodes to UPC/EAN format.
boolean	couponCode Enables Coupon code decoding.
ScannerConfig.CouponReport	couponReport Used to differentiate between old coupon (UPC/EAN and Code128) and new GS1 DataBar Coupons.
boolean	eanZeroExtend Enable this parameter to add five leading zeros to decoded EAN-8 symbols to make them compatible in format to EAN-13 symbols.
boolean	linearDecode Deprecated.
boolean	randomWeightCheckDigit Flag to enable random weight check digit verification.
boolean	reducedQuietZone Flag to Enable or Disable decoding of UPC barcodes with reduced quiet zones.
ScannerConfig.SecurityLevel	securityLevel The scanner of fers four levels of decode security for UPC/EAN barcodes.
boolean	supplemental2 Flag to enable length 2 supplementals.
boolean	supplemental5 Flag to enable length 5 supplementals.
ScannerConfig.SupplementalMode	supplementalMode The supplemental mode.
int	supplementalRetries Retry count for auto-discriminating for supplementals.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

booklandCode

public boolean booklandCode

Flag to enable Bookland code decoding. Any EAN which begins with the 978 prefix is called a Bookland EAN barcode and is used on books and book related products internationally.

 
 	Example Usage:
 	upcEan.booklandCode = true;
 
 

booklandFormat

public ScannerConfig.BooklandFormat booklandFormat

Specifies the bookland format to use. Use enum ScannerConfig.BooklandFormat.

 
 	Example Usage:
 	upcEan.booklandFormat = BooklandFormat.ISBN_10;
 
 

convertDataBarToUpcEan

public boolean convertDataBarToUpcEan

If this is set it converts DataBar barcodes to UPC/EAN format. For this setting to work UPC/EAN symbologies must be enabled. A check in the checkbox indicates that the option is enabled.

 
 	Example Usage:
 	upcEan.convertDataBarToUPCEAN = true;
 
 

couponCode

public boolean couponCode

Enables Coupon code decoding. Note that in order to successfully decode Coupon codes, all of the correct decoders must be enabled.

 
 	Example Usage:
 	upcEan.couponCode = true;
 
 

linearDecode

@Deprecated
public boolean linearDecode

Deprecated.

randomWeightCheckDigit

public boolean randomWeightCheckDigit

Flag to enable random weight check digit verification.

 
 	Example Usage:
 	upcEan.randomWeightCheckDigit = true;
 
 

securityLevel

public ScannerConfig.SecurityLevel securityLevel

The scanner of fers four levels of decode security for UPC/EAN barcodes. Select higher security levels for lower quality bar codes. There is an inverse relationship between security and decode speed, so be sure to choose only that level of security necessary for the application. Use enum ScannerConfig.SecurityLevel.

 
 	Example Usage:
 	upcEan.securityLevel = SecurityLevel.LEVEL_0;
 
 

supplemental2

public boolean supplemental2

Flag to enable length 2 supplementals.

 
 	Example Usage:
 	upcEan.supplemental2 = false;
 
 

supplemental5

public boolean supplemental5

Flag to enable length 5 supplementals.

 
 	Example Usage:
 	upcEan.supplemental5 = false;
 
 

supplementalMode

public ScannerConfig.SupplementalMode supplementalMode

The supplemental mode. Use enum ScannerConfig.SupplementalMode.

 
 	Example Usage:
 	upcEan.supplementalMode = SupplementalMode.S_378_379;
 
 

supplementalRetries

public int supplementalRetries

Retry count for auto-discriminating for supplementals. Possible values are 2 to 20 inclusive. Note that this flag is only considered if Supplemental Mode - UPC EAN is set to one of the following values: Supplementals Auto, Supplementals Smart, Supplementals 378-379 , Supplementals 978-979, Supplementals 977 or Supplementals 414-419-434-439 (2 to 20, default 10).

 
 	Example Usage:
 	upcEan.supplementalRetries = 10;
 
 

couponReport

public ScannerConfig.CouponReport couponReport

Used to differentiate between old coupon (UPC/EAN and Code128) and new GS1 DataBar Coupons. NOTE: There is an Interim GS1 DataBar Coupon (UPC A and the GS1 DataBar), which is meant for smooth transition of adaption from old coupon format to new coupon format. If an interim coupon is presented to the scanner, it will read old or new portion of it, depending on the report mode setting. Use enum ScannerConfig.CouponReport.

 
 	Example Usage:
 	upcEan.couponReport = CouponReport.OLD;
 
 

eanZeroExtend

public boolean eanZeroExtend

Enable this parameter to add five leading zeros to decoded EAN-8 symbols to make them compatible in format to EAN-13 symbols. Disable this to transmit EAN-8 symbols as is

reducedQuietZone

public boolean reducedQuietZone

Flag to Enable or Disable decoding of UPC barcodes with reduced quiet zones. If you enable, select a OneDQuietZoneLevel to set the effort level.

 
 	Example Usage:
 	upcEan.reducedQuietZone = true;