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

java.lang.Object
  com.sap.ip.me.api.pios.symbology.Symbology

Direct Known Subclasses:

Symbology2D, SymbologyLinear

public abstract class Symbology

extends java.lang.Object

Base class for all Symbologies.

A symbology is a protocol for representing information (alphabetic, numeric, or binary). Each symbol has it own rules governing how it is to be read, interpreted and validated.

Barcodes are a combination of numbers, letters and other special characters encoded in bar and space combinations and a number of technical specifications or characteristics to define and separate one symbology from another.

For more information about barcode symbologies and their uses visit the following sites:

• AIM
• Uniform Code Council
• EAN International

Since:

MI 2.5

Author:

Abaco

Field Summary

protected long

options Value that indicates the options set for a symbology.

Constructor Summary

Symbology(long validOptions)
Constructs a new Symbology object.

Method Summary

abstract java.lang.String	getName() Returns the symbology name.
long	getOptions() Returns the configured options mask or symbology options.
abstract int	getType() Returns the symbology type.
abstract void	setOptions(long options) Sets the configured options for the symbology.
void	validateOptions(long options)

Methods inherited from class java.lang.Object

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

Field Detail

options

protected long options

Value that indicates the options set for a symbology. The symbology options mask.

Constructor Detail

Symbology

public Symbology(long validOptions)

Constructs a new Symbology object.

Parameters:

validOptions - a mask containing the valid options for this symbology

Method Detail

getOptions

public long getOptions()

Returns the configured options mask or symbology options.

Returns:

The symbology options mask.

validateOptions

public void validateOptions(long options)
                     throws InvalidSymbologyException

Throws:

InvalidSymbologyException

setOptions

public abstract void setOptions(long options)
                         throws InvalidSymbologyException

Sets the configured options for the symbology.

Parameters:

options - the symbology options mask

Throws:

InvalidSymbologyException - thrown if the received options are invalid for this symbology

getName

public abstract java.lang.String getName()

Returns the symbology name.

Returns:

The name of the symbology.

getType

public abstract int getType()

Returns the symbology type.

Returns:

The type of the symbology.

See Also:

SymbologyType