DOI (Elasticsearch Analysis Standard Number Plugin 1.3.0.0 API)

java.lang.Object
- org.xbib.standardnumber.AbstractStandardNumber
- - org.xbib.standardnumber.DOI

All Implemented Interfaces:

Comparable<DOI>, StandardNumber
```
public class DOI
extends AbstractStandardNumber
implements Comparable<DOI>, StandardNumber
```
ISO 26324: Digital Object Identifier System (DOI) Z39.50 BIB-1 Use Attribute 1094 DOI is an acronym for "digital object identifier", meaning a "digital identifier of an object" rather than an "identifier of a digital object". The DOI system was initiated by the International DOI Foundation in 1998, and initially developed with the collaboration of some participants in ISO/TC46/SC9. Due to its application in the fields of information and documentation and previous collaboration with some ISO/TC46/SC9 participants, it was introduced as a possible work item in 2004 and further developed from 2006 to 2010. The DOI system is designed to work over the Internet. A DOI name is permanently assigned to an object to provide a resolvable persistent network link to current information about that object, including where the object, or information about it, can be found on the Internet. While information about an object can change over time, its DOI name will not change. A DOI name can be resolved within the DOI system to values of one or more types of data relating to the object identified by that DOI name, such as a URL, an e-mail address, other identifiers and descriptive metadata. The DOI system enables the construction of automated services and transactions. Applications of the DOI system include but are not limited to managing information and documentation location and access; managing metadata; facilitating electronic transactions; persistent unique identification of any form of any data; and commercial and non-commercial transactions. The content of an object associated with a DOI name is described unambiguously by DOI metadata, based on a structured extensible data model that enables the object to be associated with metadata of any desired degree of precision and granularity to support description and services. The data model supports interoperability between DOI applications. The scope of the DOI system is not defined by reference to the type of content (format, etc.) of the referent, but by reference to the functionalities it provides and the context of use. The DOI system provides, within networks of DOI applications, for unique identification, persistence, resolution, metadata and semantic interoperability.

Constructor Summary

Constructors
Constructor and Description

DOI()

Constructors
Constructor and Description
`DOI()`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(DOI doi)`
`DOI`	`createChecksum(boolean checksum)` Indicate that a correct check sum should be computed.
`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.
`Collection<String>`	`getTypedVariants()`
`boolean`	`isValid()` Check this number for validity.
`DOI`	`normalize()` Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.
`String`	`normalizedValue()` Return normalized value of this standard number.
`DOI`	`reset()`
`DOI`	`set(CharSequence value)` Set the input value of this standard number.
`String`	`type()` Return the type of this standard number
`DOI`	`verify()` Verify the number.

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

- Constructor Detail
  - DOI
```
public DOI()
```
- Method Detail
  - type
```
public String type()
```
    Description copied from interface: StandardNumber
    
    Return the type of this standard number
    
    Specified by:
    
    type in interface StandardNumber
    
    Returns:
    the type
  - compareTo
```
public int compareTo(DOI doi)
```
    Specified by:
    
    compareTo in interface Comparable<DOI>
  - set
```
public DOI set(CharSequence value)
```
    Description copied from interface: StandardNumber
    
    Set the input value of this standard number. The input must be normalized and verified before being accepted as valid.
    
    Specified by:
    
    set in interface StandardNumber
    
    Parameters:
    value - the raw input value
    
    Returns:
    this standard number
  - createChecksum
```
public DOI createChecksum(boolean checksum)
```
    Description copied from interface: StandardNumber
    
    Indicate that a correct check sum should be computed.
    
    Specified by:
    
    createChecksum in interface StandardNumber
    
    Returns:
    this standard number
  - normalize
```
public DOI normalize()
```
    Description copied from interface: StandardNumber
    
    Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.
    
    Specified by:
    
    normalize in interface StandardNumber
    
    Returns:
    this standard number
  - isValid
```
public boolean isValid()
```
    Description copied from interface: StandardNumber
    
    Check this number for validity.
    
    Specified by:
    
    isValid in interface StandardNumber
    
    Returns:
    true if valid, false otherwise
  - verify
```
public DOI verify()
           throws NumberFormatException
```
    Description copied from interface: StandardNumber
    
    Verify the number.
    
    Specified by:
    
    verify in interface StandardNumber
    
    Returns:
    this standard number if verification was successful
    
    Throws:
    
    NumberFormatException - if verification failed
  - normalizedValue
```
public String normalizedValue()
```
    Description copied from interface: 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 interface StandardNumber
    
    Returns:
    the normalized value
  - format
```
public String format()
```
    Description copied from interface: 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 interface StandardNumber
    
    Returns:
    a formatted value
  - getTypedVariants
```
public Collection<String> getTypedVariants()
```
    Specified by:
    
    getTypedVariants in interface StandardNumber
    
    Overrides:
    
    getTypedVariants in class AbstractStandardNumber
  - reset
```
public DOI reset()
```
    Specified by:
    
    reset in interface StandardNumber

Class DOI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DOI

Method Detail

type

compareTo

set

createChecksum

normalize

isValid

verify

normalizedValue

format

getTypedVariants

reset