Package com.digimarc.dms.payload

Enum Class Payload.GS1_AI_Representation

java.lang.Object

java.lang.Enum<Payload.GS1_AI_Representation>

com.digimarc.dms.payload.Payload.GS1_AI_Representation

All Implemented Interfaces:

Payload.Representation, Serializable, Comparable<Payload.GS1_AI_Representation>, Constable

Enclosing class:

Payload

public static enum Payload.GS1_AI_Representation
extends Enum<Payload.GS1_AI_Representation>
implements Payload.Representation

GS1_AI_Representation contains representations that correspond to standard GS1 AI (Application Identifier) values. The values are all returned as Strings except where noted.

Note that all GS1 data can be retrieved from a code using the Payload.getGS1Data() method.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GS1_AI_ItemCount	GS1 Item Count Representation contains an item count value for AI 30.
GS1_AI_Price	GS1 Price Representation contains a price value for AI 3922.
GS1_AI_SellByDate	GS1 Sell By Date Representation contains a sell by date value for AI 16.
GS1_AI_WeightKg	GS1 Weight in Kilograms Representation contains a weight value for AI 3102 & 3103.
GS1_AI_WeightLb	GS1 Weight in Pounds Representation contains a weight value for AI 3202 & 3203.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	mBaseName
protected final String	mField
protected final int	mId

Method Summary

Modifier and Type	Method	Description
int	getId()
String	getName()
static Payload.GS1_AI_Representation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Payload.GS1_AI_Representation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GS1_AI_Price

public static final Payload.GS1_AI_Representation GS1_AI_Price

GS1 Price Representation contains a price value for AI 3922. The value is returned as a BigDecimal object. This representation is valid for DataBar barcodes and some Digimarc Barcode for Thermal Labels.

Type: BigDecimal

GS1_AI_WeightLb

public static final Payload.GS1_AI_Representation GS1_AI_WeightLb

GS1 Weight in Pounds Representation contains a weight value for AI 3202 & 3203. The value is returned as a BigDecimal object. This representation is valid for DataBar barcodes and some Digimarc Barcode for Thermal Labels.

Note: The value returned by this method may not match the exact string value of the weight AI substring in the source DataBar string. In the case of AI 3202 a zero is removed from the front of the string and appended to the read of the source AI substring to provide the documented three digits of precision. This does mean that the representation value may differ from the AI parsed out of the source AI string. If this is a concern we suggest you use the Payload.getGS1Data() (String)} method to query the specific AI and precision you are looking for.

Type: BigDecimal

GS1_AI_WeightKg

public static final Payload.GS1_AI_Representation GS1_AI_WeightKg

GS1 Weight in Kilograms Representation contains a weight value for AI 3102 & 3103. The value is returned as a BigDecimal object. This representation is valid for DataBar barcodes and some Digimarc Barcode for Thermal Labels.

Note: The value returned by this method may not match the exact string value of the weight AI substring in the source DataBar string. In the case of AI 3202 a zero is removed from the front of the string and appended to the read of the source AI substring to provide the documented three digits of precision. This does mean that the representation value may differ from the AI parsed out of the source AI string. If this is a concern we suggest you use the Payload.getGS1Data() (String)} method to query the specific AI and precision you are looking for.

Type: BigDecimal

GS1_AI_SellByDate

public static final Payload.GS1_AI_Representation GS1_AI_SellByDate

GS1 Sell By Date Representation contains a sell by date value for AI 16. The value is returned as a Calendar object. This representation is valid for DataBar barcodes and some Digimarc Barcode for Thermal Labels.

Type: Calendar

GS1_AI_ItemCount

public static final Payload.GS1_AI_Representation GS1_AI_ItemCount

GS1 Item Count Representation contains an item count value for AI 30. This representation is valid for DataBar barcodes and some Digimarc Barcode for Thermal Labels.

Type: Integer

Field Details

mBaseName

protected final String mBaseName

See Also:

• Constant Field Values

mField

protected final String mField

mId

protected final int mId

Method Details

values

public static Payload.GS1_AI_Representation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Payload.GS1_AI_Representation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getName

@NonNull
public String getName()

Specified by:

getName in interface Payload.Representation

getId

public int getId()

Specified by:

getId in interface Payload.Representation