Package org.gbif.api.model.common

Class DOI

java.lang.Object

org.gbif.api.model.common.DOI

All Implemented Interfaces:

Serializable

public class DOI
extends Object
implements Serializable

Class representing a single Digital Object Identifier (DOI) breaking it down to a prefix and suffix. For the syntax of DOI names see the DOI Handbook. All parsing is case-insensitive and resulting components will all be uppercased.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DOI.DoiDeserializer
static class	DOI.DoiSerializer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GBIF_PREFIX	The DOI prefix registered with DataCite to be used by GBIF-issued production DOIs.
static final String	TEST_PREFIX	A DOI prefix provided by DataCite to be used in tests.

Constructor Summary

Constructors

Constructor	Description
DOI()	Do not use this constructor.
DOI(String doi)	Parses a simple DOI string of various forms incl URN, URL or plain DOI names.
DOI(String prefix, String suffix)	Parses a simple DOI string of various forms incl URN, URL or plain DOI names.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDoiName()
String	getDoiString()
String	getPrefix()
String	getSuffix()
URI	getUrl()	See DOI Handbook, Visual presentation and other representation of DOI names.
int	hashCode()
static boolean	isParsable(String source)	Returns true only if the source can be parsed into a DOI.
void	setPrefix(String prefix)
void	setSuffix(String suffix)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

GBIF_PREFIX

public static final String GBIF_PREFIX

The DOI prefix registered with DataCite to be used by GBIF-issued production DOIs.

See Also:

• Constant Field Values

TEST_PREFIX

public static final String TEST_PREFIX

A DOI prefix provided by DataCite to be used in tests.

See Also:

• Constant Field Values

Constructor Details

DOI

public DOI()

Do not use this constructor. Required by JAXB to marshall this object without introducing adapters.

DOI

public DOI(String doi)

Parses a simple DOI string of various forms incl URN, URL or plain DOI names.

Parameters:

doi - the full simple DOI string

Throws:

IllegalArgumentException - if invalid DOI string is passed

DOI

public DOI(String prefix,
 String suffix)

Parses a simple DOI string of various forms incl URN, URL or plain DOI names.

Parameters:

prefix - a simple DOI prefix starting with 10.

suffix - arbitrary suffix part of the DOI

Throws:

IllegalArgumentException - if invalid DOI prefix is given

Method Details

isParsable

public static boolean isParsable(String source)

Returns true only if the source can be parsed into a DOI.

getPrefix

public String getPrefix()

setPrefix

public void setPrefix(String prefix)

getSuffix

public String getSuffix()

setSuffix

public void setSuffix(String suffix)

getUrl

public URI getUrl()

See DOI Handbook, Visual presentation and other representation of DOI names.

Returns:

the resolved DOI using https://doi.org/

Throws:

IllegalStateException - if the encoding of the DOI is not supported

getDoiString

public String getDoiString()

Returns:

the DOI name prefixed with "doi:", as recommended by the DOI Handbook.

getDoiName

public String getDoiName()

Returns:

the pure DOI name without any initial scheme name starting with the prefix, i.e. 10.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object