com.sap.ip.me.api.pios.symbology
Class EAN13

java.lang.Object
  extended bycom.sap.ip.me.api.pios.symbology.Symbology
      extended bycom.sap.ip.me.api.pios.symbology.SymbologyLinear
          extended bycom.sap.ip.me.api.pios.symbology.EAN13

public final class EAN13
extends SymbologyLinear

Represents the EAN-13 Symbology.

EAN-13, based upon the UPC-A standard, was implemented by the International Article Numbering Association (EAN) in Europe. This standard was implemented mostly because the UPC-A standard was not well designed for international use. The only difference between a UPC-A symbol and an EAN-13 symbol is that the number system code is 2-digits long in EAN-13 as opposed to 1 digit in UPC-A.

Aliases:
None
Code Type:
Discrete
Character Set:
Numeric only (0..9)
Check Character:
Mandatory
Barcode Example:
     EAN-13 Sample

The following options can be set for this symbology:

Supplement:
Required: optional
Used by: Printer
Default: No supplement
Possible values:
TWO_DIGIT_ADDON:
Supplemental barcode used with magazines, newspapers and other such periodicals. The 2-digit supplement typically represents the issue number of the periodical.
FIVE_DIGIT_ADDON:
Supplemental barcode used on books to indicate a suggested retail price.
Check Digit Transmit:
Required optional
Used by: Scanner
Default: No transmit
Possible values:
CHECK_DIGIT_TRANSMIT:
Determines whether or not the check digit in a barcode is sent as part of the data.

Example: Create a EAN13 symbology for the printer.
 
 	...
 	EAN13 ean13 = new EAN13();
	...
 
 

Since:
MI 2.5
Author:
Abaco

Field Summary
static long CHECK_DIGIT_TRANSMIT
          Constant to indicate reporting of the bar code check digit.
static long FIVE_DIGIT_ADDON
          Constant to indicate the five digit addon option.
static long TWO_DIGIT_ADDON
          Constant to indicate the two digit addon option.
 
Fields inherited from class com.sap.ip.me.api.pios.symbology.Symbology
options
 
Constructor Summary
EAN13()
          Constructs a new EAN13 object.
EAN13(long options)
          Constructs a new EAN13 object with the symbology options provided.
 
Method Summary
 java.lang.String getName()
          Returns the symbology name.
 int getType()
          Returns the symbology type.
 void setOptions(long options)
          Sets the configured options for the symbology.
 
Methods inherited from class com.sap.ip.me.api.pios.symbology.Symbology
getOptions, validateOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TWO_DIGIT_ADDON

public static final long TWO_DIGIT_ADDON
Constant to indicate the two digit addon option.

See Also:
Constant Field Values

FIVE_DIGIT_ADDON

public static final long FIVE_DIGIT_ADDON
Constant to indicate the five digit addon option.

See Also:
Constant Field Values

CHECK_DIGIT_TRANSMIT

public static final long CHECK_DIGIT_TRANSMIT
Constant to indicate reporting of the bar code check digit.

See Also:
Constant Field Values
Constructor Detail

EAN13

public EAN13()
Constructs a new EAN13 object.


EAN13

public EAN13(long options)
      throws InvalidSymbologyException
Constructs a new EAN13 object with the symbology options provided.

The options value is either one of the option constants defined by this class, or must be built by bitwise OR'ing together (that is, using the long "|" operator) two or more of those option constants.

Parameters:
options - the symbology options mask
Throws:
InvalidSymbologyException - thrown if the received options are invalid for this symbology
Method Detail

getName

public java.lang.String getName()
Returns the symbology name.

Specified by:
getName in class Symbology
Returns:
The name of the symbology.

getType

public int getType()
Returns the symbology type.

Specified by:
getType in class Symbology
Returns:
The type of the symbology.
See Also:
SymbologyType

setOptions

public void setOptions(long options)
                throws InvalidSymbologyException
Sets the configured options for the symbology.

Specified by:
setOptions in class Symbology
Parameters:
options - the symbology options mask
Throws:
InvalidSymbologyException - thrown if the received options are invalid for this symbology


Copyright © 2005 SAP AG. All Rights Reserved.