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

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.Interleaved2Of5

public final class Interleaved2Of5
extends SymbologyLinear

Represents the Interleaved 2 of 5 Symbology.

Interleaved 2 of 5 is a higher-density numeric symbology based upon the Standard 2 of 5 symbology. It is used primarily in the distribution and warehouse industry. The symbology is called "interleaved" because the first numeric data is encoded in the first 5 bars while the second numeric data is encoded in the first 5 spaces that separate the first 5 bars. Thus the first 5 bars and spaces actually encode two characters. This is also why the barcode can only encode an even number of data elements.

Aliases:
I-2/5, I2of5
Code Type:
Continuous
Character Set:
Numeric only (0..9)
Check Character:
Optional
Barcode Example:
     Interleaved 2 of 5 Sample

The following options can be set for this symbology:

Check Digit:
Required: optional
Used by: Printer
Default: No check digit
Possible values:
CHECK_DIGIT_MOD10_USS:
Uniform Symbology Specification (USS) - calculated as a MOD 10 check digit based on 3 - 1 - 3 weightings.
CHECK_DIGIT_MOD10_OPCC:
Optical Product Code Council (OPCC) - calculated as a MOD 10 check digit based on 2 - 1 - 2 weightings.
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. Requires one of the check digit options to be set.

Example: Create a Interleaved2Of5 symbology for the printer with USS check digit.
 
 	...
 	Interleaved2Of5 interleaved2Of5 = new Interleaved2Of5(Interleaved2Of5.CHECK_DIGIT_MOD10_USS);
	...
 
 

Since:
MI 2.5
Author:
Abaco

Field Summary
static long CHECK_DIGIT_MOD10_OPCC
          Constant to indicate check digit mod10 opcc option.
static long CHECK_DIGIT_MOD10_USS
          Constant to indicate check digit mod10 uss option.
static long CHECK_DIGIT_TRANSMIT
          Constant to indicate reporting of the bar code check digit.
 
Fields inherited from class com.sap.ip.me.api.pios.symbology.Symbology
options
 
Constructor Summary
Interleaved2Of5()
          Constructs a new Interleaved2Of5 object.
Interleaved2Of5(long options)
          Constructs a new Interleaved2Of5 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

CHECK_DIGIT_MOD10_USS

public static final long CHECK_DIGIT_MOD10_USS
Constant to indicate check digit mod10 uss option.

See Also:
Constant Field Values

CHECK_DIGIT_MOD10_OPCC

public static final long CHECK_DIGIT_MOD10_OPCC
Constant to indicate check digit mod10 opcc 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

Interleaved2Of5

public Interleaved2Of5()
Constructs a new Interleaved2Of5 object.


Interleaved2Of5

public Interleaved2Of5(long options)
                throws InvalidSymbologyException
Constructs a new Interleaved2Of5 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.