GTIN (standardnumber 1.0.1 API)

java.lang.Object
- org.xbib.standardnumber.StandardNumber
- - org.xbib.standardnumber.GTIN

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<GTIN>
```
public class GTIN
extends StandardNumber
implements java.lang.Cloneable, java.lang.Comparable<GTIN>
```
Global Trade Item Number (GTIN).

GTIN describes a family of GS1 (EAN.UCC) global data structures that employ 14 digits and can be encoded into various types of data carriers.

Currently, GTIN is used exclusively within bar codes, but it could also be used in other data carriers such as radio frequency identification (RFID). The GTIN is only a term and does not impact any existing standards, nor does it place any additional requirements on scanning hardware.

For North American companies, the UPC is an existing form of the GTIN.

Since 2005, EAN International and American UCC merged to GS1 and also EAN and UPC is now named GTIN.

The EAN/UCC-13 code is now officially called GTIN-13 (Global Trade Identifier Number). Former 12-digit UPC codes can be converted into EAN/UCC-13 code by simply adding a preceeding zero.

As of January 1, 2007, the former ISBN numbers have been integrated into the EAN/UCC-13 code. For each old ISBN-10 code, there exists a proper translation into EAN/UCC-13 by adding "978" as prefix.

The family of data structures comprising GTIN include
- GTIN-8 (EAN/UCC-8): this is an 8-digit number
- GTIN-12 (UPC-A): this is a 12-digit number
- GTIN-13 (EAN/UCC-13): this is a 13-digit number
- GTIN-14 (EAN/UCC-14 or ITF-14): this is a 14-digit number
See GTIN info

Field Summary
- Fields inherited from class org.xbib.standardnumber.StandardNumber
  type, value

Constructor Summary

Constructors
Constructor and Description

GTIN()

Constructors
Constructor and Description
`GTIN()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Returns a clone if the implementation is cloneable.
`int`	`compareTo(GTIN gtin)`
`GTIN`	`createChecksum(boolean createWithChecksum)` Indicate that a correct check sum should be computed.
`boolean`	`equals(java.lang.Object object)`
`java.lang.String`	`format()` Return a formatted value of this standard number This is best for human-readable representation, but is not necessarily a format for computation.
`static StandardNumber`	`getInstance(java.lang.Package thePackage, java.lang.ClassLoader classLoader, java.lang.String type)`
`static StandardNumber`	`getInstance(java.lang.String type)`
`java.util.Collection<java.lang.String>`	`getTypedVariants()`
`int`	`hashCode()`
`boolean`	`isValid()` Check this number for validity.
`GTIN`	`normalize()` Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.
`java.lang.String`	`normalizedValue()` Return normalized value of this standard number.
`GTIN`	`reset()`
`GTIN`	`verify()` Verify the number.

Methods inherited from class org.xbib.standardnumber.StandardNumber
set, type

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GTIN
```
public GTIN()
```
- Method Detail
  - compareTo
```
public int compareTo(GTIN gtin)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<GTIN>
  - createChecksum
```
public GTIN createChecksum(boolean createWithChecksum)
```
    Description copied from class: StandardNumber
    
    Indicate that a correct check sum should be computed.
    
    Specified by:
    
    createChecksum in class StandardNumber
    
    Parameters:
    
    createWithChecksum - if checksum is included
    
    Returns:
    
    this standard number
  - normalize
```
public GTIN normalize()
```
    Description copied from class: StandardNumber
    
    Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.
    
    Specified by:
    
    normalize in class StandardNumber
    
    Returns:
    
    this standard number
  - isValid
```
public boolean isValid()
```
    Description copied from class: StandardNumber
    
    Check this number for validity.
    
    Specified by:
    
    isValid in class StandardNumber
    
    Returns:
    
    true if valid, false otherwise
  - verify
```
public GTIN verify()
```
    Description copied from class: StandardNumber
    
    Verify the number.
    
    Specified by:
    
    verify in class StandardNumber
    
    Returns:
    
    this standard number if verification was successful
  - normalizedValue
```
public java.lang.String normalizedValue()
```
    Description copied from class: StandardNumber
    
    Return normalized value of this standard number. In most cases, this is also the canonical form of the standard number. This is a representation without unneccessary characters, useful for computation purposes, like comparing for equivalence.
    
    Specified by:
    
    normalizedValue in class StandardNumber
    
    Returns:
    
    the normalized value
  - format
```
public java.lang.String format()
```
    Description copied from class: StandardNumber
    
    Return a formatted value of this standard number This is best for human-readable representation, but is not necessarily a format for computation.
    
    Specified by:
    
    format in class StandardNumber
    
    Returns:
    
    a formatted value
  - reset
```
public GTIN reset()
```
    Specified by:
    
    reset in class StandardNumber
  - getTypedVariants
```
public java.util.Collection<java.lang.String> getTypedVariants()
```
    Specified by:
    
    getTypedVariants in class StandardNumber
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Returns a clone if the implementation is cloneable.
    
    Returns:
    
    a clone if the implementation is cloneable.
    
    Throws:
    
    java.lang.CloneNotSupportedException - if this is called on an implementation that does not support `Cloneable`
  - getInstance
```
public static StandardNumber getInstance(java.lang.String type)
                                  throws NoSuchStandardNumberException
```
    Throws:
    
    NoSuchStandardNumberException
  - getInstance
```
public static StandardNumber getInstance(java.lang.Package thePackage,
                                         java.lang.ClassLoader classLoader,
                                         java.lang.String type)
                                  throws NoSuchStandardNumberException
```
    Throws:
    
    NoSuchStandardNumberException

Class GTIN

Field Summary

Fields inherited from class org.xbib.standardnumber.StandardNumber

Constructor Summary

Method Summary

Methods inherited from class org.xbib.standardnumber.StandardNumber

Methods inherited from class java.lang.Object

Constructor Detail

GTIN

Method Detail

compareTo

createChecksum

normalize

isValid

verify

normalizedValue

format

reset

getTypedVariants

equals

hashCode

clone

getInstance

getInstance