Package org.gbif.api.model.registry

Class Dataset

java.lang.Object

org.gbif.api.model.registry.Dataset

All Implemented Interfaces:

Serializable, Commentable, Contactable, Endpointable, Identifiable, LenientEquals<Dataset>, MachineTaggable, NetworkEntity, Taggable

public class Dataset
extends Object
implements NetworkEntity, Contactable, Endpointable, MachineTaggable, Taggable, Identifiable, Commentable, LenientEquals<Dataset>

A GBIF dataset which provides occurrence data, checklist data, sampling event data or metadata. This Dataset class is covering all the GBIF metadata profile v1.3, but only a few properties are kept in the database table:

• key
• parentDatasetKey
• duplicateOfDatasetKey
• version
• installationKey
• publishingOrganizationKey
• publishingOrganizationName
• networkKeys
• license
• maintenanceUpdateFrequency
• external
• numConstituents
• type
• subtype
• title
• alias
• abbreviation
• description
• language
• homepage
• logoUrl
• citation
• rights
• lockedForAutoUpdate
• createdBy
• modifiedBy
• created
• modified
• deleted

See Also:

• GBIF EML Profile XML Schema
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dataset.DwcA	Metadata of dataset that has been published as a Darwin Core Archive (DwC-A).

Constructor Summary

Constructors

Constructor	Description
Dataset()

Method Summary

Modifier and Type	Method	Description
void	addEndpoint(Endpoint endpoint)
void	addMachineTag(MachineTag machineTag)
boolean	equals(Object o)
@Size(min=1,max=50) String	getAbbreviation()	TODO: Document what this is TODO: are both alias & abbreviation needed?
String	getAcknowledgements()
String	getAdditionalInfo()
@Size(min=2,max=50) String	getAlias()	TODO: Document what this is
List<Citation>	getBibliographicCitations()
Set<String>	getCategory()
@Valid Citation	getCitation()	The exact form of how to cite this dataset.
List<Collection>	getCollections()
List<Comment>	getComments()
List<Contact>	getContacts()
List<CitationContact>	getContactsCitation()	A generated list of contacts used in the citation text when it is generated by the GBIF API.
Set<Country>	getCountryCoverage()
Date	getCreated()
String	getCreatedBy()
List<CuratorialUnitComposite>	getCuratorialUnits()
List<DataDescription>	getDataDescriptions()
Language	getDataLanguage()
Date	getDeleted()
String	getDescription()
DOI	getDoi()
UUID	getDuplicateOfDatasetKey()	If a dataset is registered with GBIF through more than one place we'll mark all but one as a duplicate by pointing it to the canonical dataset.
@Valid Dataset.DwcA	getDwca()
List<Endpoint>	getEndpoints()
String	getGeographicCoverageDescription()
List<GeospatialCoverage>	getGeographicCoverages()
String	getGettingStarted()
URI	getHomepage()
List<Identifier>	getIdentifiers()
@NotNull UUID	getInstallationKey()
String	getIntroduction()
UUID	getKey()
List<KeywordCollection>	getKeywordCollections()
@NotNull Language	getLanguage()
License	getLicense()	Persisted in the database table.
URI	getLogoUrl()
List<MachineTag>	getMachineTags()
String	getMaintenanceDescription()	A description of the maintenance frequency of this resource.
MaintenanceUpdateFrequency	getMaintenanceUpdateFrequency()	Persisted in the database table.
Date	getModified()
String	getModifiedBy()
List<UUID>	getNetworkKeys()	Networks in which this dataset is a constituent.
@javax.validation.constraints.Min(0L) int	getNumConstituents()
UUID	getParentDatasetKey()
Project	getProject()
Date	getPubDate()
@NotNull UUID	getPublishingOrganizationKey()
String	getPublishingOrganizationName()
String	getPurpose()
@Size(min=1) String	getRights()	Any kind of (copy)rights/IPR statements that apply to the datasets data.
SamplingDescription	getSamplingDescription()
String	getShortName()
DatasetSubtype	getSubtype()
List<Tag>	getTags()
List<TaxonomicCoverages>	getTaxonomicCoverages()
List<TemporalCoverage>	getTemporalCoverages()
String	getTitle()
@NotNull DatasetType	getType()
String	getVersion()
int	hashCode()
boolean	isExternal()
boolean	isLockedForAutoUpdate()
boolean	lenientEquals(Dataset other)	Only checks the persisted properties, excluding the server controlled fields (key, created, license etc).
void	setAbbreviation(String abbreviation)	Persisted in the database table.
void	setAcknowledgements(String acknowledgements)
void	setAdditionalInfo(String additionalInfo)
void	setAlias(String alias)	Persisted in the database table.
void	setBibliographicCitations(List<Citation> bibliographicCitations)
void	setCategory(Set<String> category)
void	setCitation(Citation citation)	Persisted in the database table.
void	setCollections(List<Collection> collections)
void	setComments(List<Comment> comments)
void	setContacts(List<Contact> contacts)
void	setContactsCitation(List<CitationContact> contactsCitation)
void	setCountryCoverage(Set<Country> countryCoverage)
void	setCreated(Date created)	Autoassigned in the database table, ignored when persisted.
void	setCreatedBy(String createdBy)	Persisted in the database table.
void	setCuratorialUnits(List<CuratorialUnitComposite> curatorialUnits)
void	setDataDescriptions(List<DataDescription> dataDescriptions)
void	setDataLanguage(Language dataLanguage)
void	setDeleted(Date deleted)	Persisted in the database table.
void	setDescription(String description)	Persisted in the database table.
void	setDoi(DOI doi)
void	setDuplicateOfDatasetKey(UUID duplicateOfDatasetKey)	Persisted in the database table.
void	setDwca(Dataset.DwcA dwca)
void	setEndpoints(List<Endpoint> endpoints)
void	setExternal(boolean external)	Persisted in the database table.
void	setGeographicCoverageDescription(String geographicCoverageDescription)
void	setGeographicCoverages(List<GeospatialCoverage> geographicCoverages)
void	setGettingStarted(String gettingStarted)
void	setHomepage(URI homepage)	Persisted in the database table.
void	setIdentifiers(List<Identifier> identifiers)
void	setInstallationKey(UUID installationKey)	Persisted in the database table.
void	setIntroduction(String introduction)
void	setKey(UUID key)	Persisted in the database table.
void	setKeywordCollections(List<KeywordCollection> keywordCollections)
void	setLanguage(Language language)	Persisted in the database table.
void	setLicense(License license)	Persisted in the database table.
void	setLockedForAutoUpdate(boolean lockedForAutoUpdate)	Persisted in the database table.
void	setLogoUrl(URI logoUrl)	Persisted in the database table.
void	setMachineTags(List<MachineTag> machineTags)
void	setMaintenanceDescription(String maintenanceDescription)
void	setMaintenanceUpdateFrequency(MaintenanceUpdateFrequency maintenanceUpdateFrequency)	Persisted in the database table.
void	setModified(Date modified)	Persisted in the database table.
void	setModifiedBy(String modifiedBy)	Persisted in the database table.
void	setNetworkKeys(List<UUID> networkKeys)
void	setNumConstituents(int numConstituents)	Not persisted in the database table, but calculated on the fly.
void	setParentDatasetKey(UUID parentDatasetKey)	Persisted in the database table.
void	setProject(Project project)
void	setPubDate(Date pubDate)
void	setPublishingOrganizationKey(UUID publishingOrganizationKey)	Persisted in the database table.
void	setPublishingOrganizationName(String publishingOrganizationName)
void	setPurpose(String purpose)
void	setRights(String rights)	Persisted in the database table.
void	setSamplingDescription(SamplingDescription samplingDescription)
void	setShortName(String shortName)
void	setSubtype(DatasetSubtype subtype)	Persisted in the database table.
void	setTags(List<Tag> tags)
void	setTaxonomicCoverages(List<TaxonomicCoverages> taxonomicCoverages)
void	setTemporalCoverages(List<TemporalCoverage> temporalCoverages)
void	setTitle(String title)	Persisted in the database table.
void	setType(DatasetType type)	Persisted in the database table.
void	setVersion(String version)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Dataset

public Dataset()

Method Details

getKey

public UUID getKey()

Specified by:

getKey in interface NetworkEntity

setKey

public void setKey(UUID key)

Persisted in the database table.

Specified by:

setKey in interface NetworkEntity

getVersion

@Nullable
public String getVersion()

setVersion

public void setVersion(String version)

getTitle

public String getTitle()

Specified by:

getTitle in interface NetworkEntity

setTitle

public void setTitle(String title)

Persisted in the database table.

Specified by:

setTitle in interface NetworkEntity

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface NetworkEntity

setDescription

public void setDescription(String description)

Persisted in the database table.

Specified by:

setDescription in interface NetworkEntity

getCreated

public Date getCreated()

Specified by:

getCreated in interface NetworkEntity

setCreated

public void setCreated(Date created)

Autoassigned in the database table, ignored when persisted.

Specified by:

setCreated in interface NetworkEntity

getModified

public Date getModified()

Specified by:

getModified in interface NetworkEntity

setModified

public void setModified(Date modified)

Persisted in the database table.

Specified by:

setModified in interface NetworkEntity

getDeleted

@Nullable
public Date getDeleted()

Specified by:

getDeleted in interface NetworkEntity

setDeleted

public void setDeleted(Date deleted)

Persisted in the database table.

Specified by:

setDeleted in interface NetworkEntity

getParentDatasetKey

@Nullable
public UUID getParentDatasetKey()

setParentDatasetKey

public void setParentDatasetKey(UUID parentDatasetKey)

Persisted in the database table.

getDuplicateOfDatasetKey

@Nullable
public UUID getDuplicateOfDatasetKey()

If a dataset is registered with GBIF through more than one place we'll mark all but one as a duplicate by pointing it to the canonical dataset. That is done using this field. If it is null then this is not a known duplicate.

setDuplicateOfDatasetKey

public void setDuplicateOfDatasetKey(UUID duplicateOfDatasetKey)

Persisted in the database table.

getInstallationKey

@NotNull
public @NotNull UUID getInstallationKey()

setInstallationKey

public void setInstallationKey(UUID installationKey)

Persisted in the database table.

getPublishingOrganizationKey

@NotNull
public @NotNull UUID getPublishingOrganizationKey()

setPublishingOrganizationKey

public void setPublishingOrganizationKey(UUID publishingOrganizationKey)

Persisted in the database table.

getPublishingOrganizationName

@Nullable
public String getPublishingOrganizationName()

setPublishingOrganizationName

public void setPublishingOrganizationName(String publishingOrganizationName)

getNetworkKeys

public List<UUID> getNetworkKeys()

Networks in which this dataset is a constituent.

setNetworkKeys

public void setNetworkKeys(List<UUID> networkKeys)

getMaintenanceUpdateFrequency

@Nullable
public MaintenanceUpdateFrequency getMaintenanceUpdateFrequency()

Persisted in the database table.

Returns:

the frequency with which changes are made to the dataset

setMaintenanceUpdateFrequency

public void setMaintenanceUpdateFrequency(MaintenanceUpdateFrequency maintenanceUpdateFrequency)

Persisted in the database table.

getMaintenanceDescription

public String getMaintenanceDescription()

A description of the maintenance frequency of this resource.

Returns:

the description of the maintenance frequency of this resource

setMaintenanceDescription

public void setMaintenanceDescription(String maintenanceDescription)

getLicense

public License getLicense()

Persisted in the database table.
Note for backwards compatibility, we cannot apply @NotNull to license. Otherwise existing users of our API would have to ensure Dataset objects always populate license.
In the Registry DB, Dataset.license defaults to CC-BY 4.0. Therefore license must be excluded from lenientEquals method.

Returns:

the License applied to the dataset

See Also:

• POR-3133

setLicense

public void setLicense(License license)

Persisted in the database table. Can be interpreted from EML.intellectualRights using machine readable format:

 
 <intellectualRights>
   <para>This work is licensed under a <ulink url="http://creativecommons.org/licenses/by/4.0/legalcode"><citetitle>Creative Commons Attribution (CC-BY) 4.0 License</citetitle></ulink>.</para>
 </intellectualRights>
 
 

getDoi

public DOI getDoi()

Returns:

the primary DOI for this dataset regardless if issued by GBIF or publisher

setDoi

public void setDoi(DOI doi)

isExternal

public boolean isExternal()

setExternal

public void setExternal(boolean external)

Persisted in the database table.

getNumConstituents

@Min(0L)
public @javax.validation.constraints.Min(0L) int getNumConstituents()

setNumConstituents

public void setNumConstituents(int numConstituents)

Not persisted in the database table, but calculated on the fly.

getType

@NotNull
public @NotNull DatasetType getType()

setType

public void setType(DatasetType type)

Persisted in the database table.

getSubtype

@Nullable
public DatasetSubtype getSubtype()

setSubtype

public void setSubtype(DatasetSubtype subtype)

Persisted in the database table.

getShortName

@Nullable
public String getShortName()

setShortName

public void setShortName(String shortName)

getAlias

@Nullable
@Size(min=2,
      max=50)
public @Size(min=2,max=50) String getAlias()

TODO: Document what this is

setAlias

public void setAlias(String alias)

Persisted in the database table.

getAbbreviation

@Nullable
@Size(min=1,
      max=50)
public @Size(min=1,max=50) String getAbbreviation()

TODO: Document what this is TODO: are both alias & abbreviation needed?

setAbbreviation

public void setAbbreviation(String abbreviation)

Persisted in the database table.

getLanguage

@NotNull
public @NotNull Language getLanguage()

setLanguage

public void setLanguage(Language language)

Persisted in the database table.

getHomepage

@Nullable
public URI getHomepage()

setHomepage

public void setHomepage(URI homepage)

Persisted in the database table.

getLogoUrl

@Nullable
public URI getLogoUrl()

setLogoUrl

public void setLogoUrl(URI logoUrl)

Persisted in the database table.

getCitation

@Nullable
@Valid
public @Valid Citation getCitation()

The exact form of how to cite this dataset.

setCitation

public void setCitation(Citation citation)

Persisted in the database table.

getContactsCitation

@Nullable
public List<CitationContact> getContactsCitation()

A generated list of contacts used in the citation text when it is generated by the GBIF API.

setContactsCitation

public void setContactsCitation(List<CitationContact> contactsCitation)

getRights

@Nullable
@Size(min=1)
public @Size(min=1) String getRights()

Any kind of (copy)rights/IPR statements that apply to the datasets data.

setRights

public void setRights(String rights)

Persisted in the database table.

isLockedForAutoUpdate

public boolean isLockedForAutoUpdate()

setLockedForAutoUpdate

public void setLockedForAutoUpdate(boolean lockedForAutoUpdate)

Persisted in the database table.

getCreatedBy

public String getCreatedBy()

Specified by:

getCreatedBy in interface NetworkEntity

setCreatedBy

public void setCreatedBy(String createdBy)

Persisted in the database table.

Specified by:

setCreatedBy in interface NetworkEntity

getModifiedBy

public String getModifiedBy()

Specified by:

getModifiedBy in interface NetworkEntity

setModifiedBy

public void setModifiedBy(String modifiedBy)

Persisted in the database table.

Specified by:

setModifiedBy in interface NetworkEntity

getContacts

public List<Contact> getContacts()

Specified by:

getContacts in interface Contactable

setContacts

public void setContacts(List<Contact> contacts)

Specified by:

setContacts in interface Contactable

getEndpoints

public List<Endpoint> getEndpoints()

Specified by:

getEndpoints in interface Endpointable

setEndpoints

public void setEndpoints(List<Endpoint> endpoints)

Specified by:

setEndpoints in interface Endpointable

addEndpoint

public void addEndpoint(Endpoint endpoint)

Specified by:

addEndpoint in interface Endpointable

getMachineTags

public List<MachineTag> getMachineTags()

Specified by:

getMachineTags in interface MachineTaggable

setMachineTags

public void setMachineTags(List<MachineTag> machineTags)

Specified by:

setMachineTags in interface MachineTaggable

addMachineTag

public void addMachineTag(MachineTag machineTag)

Specified by:

addMachineTag in interface MachineTaggable

getTags

public List<Tag> getTags()

Specified by:

getTags in interface Taggable

setTags

public void setTags(List<Tag> tags)

Specified by:

setTags in interface Taggable

getIdentifiers

public List<Identifier> getIdentifiers()

Specified by:

getIdentifiers in interface Identifiable

setIdentifiers

public void setIdentifiers(List<Identifier> identifiers)

Specified by:

setIdentifiers in interface Identifiable

getComments

public List<Comment> getComments()

Specified by:

getComments in interface Commentable

setComments

public void setComments(List<Comment> comments)

Specified by:

setComments in interface Commentable

getBibliographicCitations

public List<Citation> getBibliographicCitations()

setBibliographicCitations

public void setBibliographicCitations(List<Citation> bibliographicCitations)

getCuratorialUnits

public List<CuratorialUnitComposite> getCuratorialUnits()

setCuratorialUnits

public void setCuratorialUnits(List<CuratorialUnitComposite> curatorialUnits)

getTaxonomicCoverages

public List<TaxonomicCoverages> getTaxonomicCoverages()

setTaxonomicCoverages

public void setTaxonomicCoverages(List<TaxonomicCoverages> taxonomicCoverages)

getGeographicCoverageDescription

public String getGeographicCoverageDescription()

setGeographicCoverageDescription

public void setGeographicCoverageDescription(String geographicCoverageDescription)

getGeographicCoverages

public List<GeospatialCoverage> getGeographicCoverages()

setGeographicCoverages

public void setGeographicCoverages(List<GeospatialCoverage> geographicCoverages)

getTemporalCoverages

public List<TemporalCoverage> getTemporalCoverages()

setTemporalCoverages

public void setTemporalCoverages(List<TemporalCoverage> temporalCoverages)

getKeywordCollections

public List<KeywordCollection> getKeywordCollections()

setKeywordCollections

public void setKeywordCollections(List<KeywordCollection> keywordCollections)

getProject

public Project getProject()

setProject

public void setProject(Project project)

getSamplingDescription

public SamplingDescription getSamplingDescription()

setSamplingDescription

public void setSamplingDescription(SamplingDescription samplingDescription)

getCountryCoverage

public Set<Country> getCountryCoverage()

setCountryCoverage

public void setCountryCoverage(Set<Country> countryCoverage)

getCollections

public List<Collection> getCollections()

setCollections

public void setCollections(List<Collection> collections)

getDataDescriptions

public List<DataDescription> getDataDescriptions()

setDataDescriptions

public void setDataDescriptions(List<DataDescription> dataDescriptions)

getDataLanguage

public Language getDataLanguage()

setDataLanguage

public void setDataLanguage(Language dataLanguage)

getPurpose

public String getPurpose()

setPurpose

public void setPurpose(String purpose)

getIntroduction

@Nullable
public String getIntroduction()

setIntroduction

public void setIntroduction(String introduction)

getGettingStarted

@Nullable
public String getGettingStarted()

setGettingStarted

public void setGettingStarted(String gettingStarted)

getAcknowledgements

@Nullable
public String getAcknowledgements()

setAcknowledgements

public void setAcknowledgements(String acknowledgements)

getAdditionalInfo

public String getAdditionalInfo()

setAdditionalInfo

public void setAdditionalInfo(String additionalInfo)

getPubDate

public Date getPubDate()

setPubDate

public void setPubDate(Date pubDate)

getDwca

@Nullable
@Valid
public @Valid Dataset.DwcA getDwca()

setDwca

public void setDwca(Dataset.DwcA dwca)

getCategory

public Set<String> getCategory()

setCategory

public void setCategory(Set<String> category)

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

lenientEquals

public boolean lenientEquals(Dataset other)

Only checks the persisted properties, excluding the server controlled fields (key, created, license etc). Does not include the nested properties.

Specified by:

lenientEquals in interface LenientEquals<Dataset>

Parameters:

other - To compare against

Returns:

true if...