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

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

public final class Code128
extends SymbologyLinear

Represents the Code 128 symbology.

Code 128 is variable-length, high-density format capable of encoding all ASCII characters, all extended ASCII characters and 4 non-data function characters. It allows numeric data to be represented in a compact, double-density mode, two data digits for every symbol character. It has three subsets: A, B & C, which are just different ways of interpreting the data encoded by the bar code. This symbol is used in the shipping industry for inventory ID and tracking purposes, distribution applications and serialized carton tracking.

Aliases:
USS Code 128, SSCC-18 and SCC-14
Code Type:
Continuous
Character Set:
All ASCII and extended ASCII characters plus 4 non-data function characters
Check Character:
Mandatory
Barcode Example:
     Code 128 Sample

The following options can be set for this symbology:

Starting code set:
Required: optional
Used by: Printer
Default: Determine starting code set automatically
Possible values:
AUTO:
The starting code set is determined automatically.
A:
Start the barcode with code set A. Code set A encodes all uppercase and ASCII control characters.
B:
Start the barcode with code set B. Code set B encodes all uppercase and lowercase characters as well as printable characters from the space (32) to DEL (127).
C:
Start the barcode with code set C. Code set C encodes numeric digit pairs 00 through 99.

Example: Create a Code128 symbology for the printer with the starting code set A.
 
 	...
 	Code128 code128 = new Code128(Code128.A);
	...
 
 

Since:
MI 2.5
Author:
Abaco

Field Summary
static long A
          Constant to indicate a barcode that starts with code set A option.
static long AUTO
          Constant to indicate a barcode where the code set is determined automatically option.
static long B
          Constant to indicate a barcode that starts with code set B option.
static long C
          Constant to indicate a barcode that starts with code set C option.
 
Fields inherited from class com.sap.ip.me.api.pios.symbology.Symbology
options
 
Constructor Summary
Code128()
          Constructs a new Code128 object.
Code128(long options)
          Constructs a new Code128 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

AUTO

public static final long AUTO
Constant to indicate a barcode where the code set is determined automatically option.

See Also:
Constant Field Values

A

public static final long A
Constant to indicate a barcode that starts with code set A option.

See Also:
Constant Field Values

B

public static final long B
Constant to indicate a barcode that starts with code set B option.

See Also:
Constant Field Values

C

public static final long C
Constant to indicate a barcode that starts with code set C option.

See Also:
Constant Field Values
Constructor Detail

Code128

public Code128()
Constructs a new Code128 object.


Code128

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