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

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

public final class Codabar
extends SymbologyLinear

Represents the Codabar Symbology.

Codabar is an older variable length symbology originally used in libraries, photo labs, blood banks, air parcel express applications, shipping companies primarily for tracking and tracing. The format encodes 16 data characters plus four unique start/stop characters. A check digit may also be added to provide an extra measure of security.

Aliases:
Ames Code, USD-4, NW-7, 2 of 7, Monarch
Code Type:
Discrete
Character Set:
0-9, - $ : / . +, and 4 start/stop characters: A B C D
Check Character:
Optional
Barcode Example:
     Codabar Sample

The following options can be set for this symbology:

Editing:
CLSI is a 14 digit standard developed by the CLSI company of Boston and currently used in many libraries around the world. It strips the start/stop characters and inserts a space after the first, fifth, and tenth characters of a 14-character symbol. There are two types of CLSI behavior, OPTIONAL or REQUIRED. A particular scanner will not support both options. Only one CLSI option can be selected.

Required: optional
Used by: Scanner
Default: No editing
Possible values:

CLSI_OPTIONAL:
When a barcode is scanned and the data doesn't comply with the CLSI standard the data is returned without any changes. If the barcode data complies with CLSI, it is formatted following the standard.
CLSI_REQUIRED:
Only barcodes that comply with CLSI standard are scanned.
NOTIS:
Strips the start/stop characters from the decoded symbol.
Check Digit:
Required: optional
Used by: Printer, Scanner
Default: No check digit
Possible values:
CHECK_DIGIT_MOD16:
Module 16 check digit.
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 the CHECK_DIGIT_MOD16 option to be set.

Example: Create a Codabar symbology for the printer with the Mod16 check digit.
 
 	...
 	Codabar codabar = new Codabar(Codabar.CHECK_DIGIT_MOD16);
	...
 
 

Since:
MI 2.5
Author:
Abaco

Field Summary
static long CHECK_DIGIT_MOD16
          Constant to indicate Codabar check digit Mod16 option.
static long CHECK_DIGIT_TRANSMIT
          Constant to indicate reporting of the bar code check digit.
static long CLSI_OPTIONAL
          Constant to indicate CLSI is optional for scanning
static long CLSI_REQUIRED
          Constant to indicate CLIS is required for scanning
static long NOTIS
          Constant to indicate NOTIS formatting.
 
Fields inherited from class com.sap.ip.me.api.pios.symbology.Symbology
options
 
Constructor Summary
Codabar()
          Constructs a new Codabar object.
Codabar(long options)
          Constructs a new Codabar 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

CLSI_OPTIONAL

public static final long CLSI_OPTIONAL
Constant to indicate CLSI is optional for scanning

See Also:
Constant Field Values

NOTIS

public static final long NOTIS
Constant to indicate NOTIS formatting.

See Also:
Constant Field Values

CHECK_DIGIT_MOD16

public static final long CHECK_DIGIT_MOD16
Constant to indicate Codabar check digit Mod16 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

CLSI_REQUIRED

public static final long CLSI_REQUIRED
Constant to indicate CLIS is required for scanning

See Also:
Constant Field Values
Constructor Detail

Codabar

public Codabar()
Constructs a new Codabar object.


Codabar

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