org.gbif.api.model.checklistbank

Class Description

java.lang.Object

org.gbif.api.model.checklistbank.Description

All Implemented Interfaces:

NameUsageExtension

public class Description
extends Object
implements NameUsageExtension

Description Model Object represents a taxon description.

See Also:

Description Definition

Constructor Summary

Constructors

Constructor and Description
Description()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getContributor() An entity responsible for making contributions to the textual information provided for a description.
String	getCreator() The author(s) of the textual information provided for a description.
String	getDescription() Any descriptive free text matching the category given as dc:type.
Integer	getKey() A unique GBIF identifier for any description.
Language	getLanguage() ISO 639-1 language code used for the description.
String	getLicense() Official permission to do something with the resource.
String	getSource() Source reference of this description, a URL or full publication citation.
Integer	getSourceTaxonKey() If the source is another name usage this is the taxonKey of that usage.
Integer	getTaxonKey() The name usage "taxon" key this description belongs to.
String	getType() Returns the type used to categorize paragraphs of a taxon description.
int	hashCode()
void	setContributor(String contributor)
void	setCreator(String creator)
void	setDescription(String description)
void	setKey(Integer key)
void	setLanguage(Language language)
void	setLicense(String license)
void	setSource(String source)
void	setSourceTaxonKey(Integer sourceTaxonKey)
void	setTaxonKey(Integer taxonKey)
void	setType(String type)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Description

public Description()

Method Detail

getKey

public Integer getKey()

A unique GBIF identifier for any description. This key is used in the table of contents to retrieve the detailed description.

setKey

public void setKey(Integer key)

getTaxonKey

public Integer getTaxonKey()

The name usage "taxon" key this description belongs to.

Specified by:

getTaxonKey in interface NameUsageExtension

setTaxonKey

public void setTaxonKey(Integer taxonKey)

Specified by:

setTaxonKey in interface NameUsageExtension

getContributor

@Nullable
public String getContributor()

An entity responsible for making contributions to the textual information provided for a description.

Returns:

the contributor

setContributor

public void setContributor(String contributor)

Parameters:

contributor - the contributor to set

getCreator

@Nullable
public String getCreator()

The author(s) of the textual information provided for a description.

Returns:

the creator

setCreator

public void setCreator(String creator)

Parameters:

creator - the creator to set.

getDescription

@Nullable
public String getDescription()

Any descriptive free text matching the category given as dc:type. The text should be either plain text or formatted with basic HTML tags, i.e. h1-4,p,i,b,a,img,ul and li. All other tags should be removed.

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getLanguage

@Nullable
public Language getLanguage()

ISO 639-1 language code used for the description.

Returns:

the language

setLanguage

public void setLanguage(Language language)

Parameters:

language - the language to set

getLicense

@Nullable
public String getLicense()

Official permission to do something with the resource. Please use Creative Commons URIs if you can.

Example: CC-BY

Returns:

the license.

setLicense

public void setLicense(String license)

Parameters:

license - the license to set

getSource

@Nullable
public String getSource()

Source reference of this description, a URL or full publication citation.

Specified by:

getSource in interface NameUsageExtension

Returns:

the source

setSource

public void setSource(String source)

Specified by:

setSource in interface NameUsageExtension

Parameters:

source - the source to set

getSourceTaxonKey

@Nullable
public Integer getSourceTaxonKey()

Description copied from interface: NameUsageExtension

If the source is another name usage this is the taxonKey of that usage. Only useful for the backbone dataset.

Specified by:

getSourceTaxonKey in interface NameUsageExtension

Returns:

The key of the name usage this instance is derived from.

setSourceTaxonKey

public void setSourceTaxonKey(Integer sourceTaxonKey)

Specified by:

setSourceTaxonKey in interface NameUsageExtension

getType

@Nullable
public String getType()

Returns the type used to categorize paragraphs of a taxon description. Given the list of types is so broad, an Enum is not used to maintain it. Rather it is kept as plain text.

Returns:

the type

See Also:

Description type definition

setType

public void setType(String type)

Parameters:

type - the type to set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object