DataCiteJson (GSON 6.0.4 API)

java.lang.Object
- de.gerdiproject.json.datacite.DataCiteJson

All Implemented Interfaces:

IDocument
```
public class DataCiteJson
extends Object
implements IDocument
```
A JSON object representing an extended DataCite document, representing core metadata properties chosen for an accurate and consistent identification of a resource for citation. The resource that is being identified can be of any kind, but it is typically a dataset. It may include not only numerical data, but any other research data outputs. The metadata schema is extended by fields that are required by GeRDI features. Source: https://schema.datacite.org/meta/kernel-4.1/doc/DataCite-MetadataKernel_v4.1.pdf

Author:

Mathis Neumann, Robin Weiss, Ingo Thomsen

Constructor Summary

Constructors
Constructor and Description

DataCiteJson(String sourceId)
Constructor that sets up the GeRDI extension.

Constructors
Constructor and Description
`DataCiteJson(String sourceId)` Constructor that sets up the GeRDI extension.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAlternateIdentifiers(Collection<AlternateIdentifier> alternateIdentifiers)` Changes identifiers other than the primary Identifier applied to the resource being registered.
`void`	`addContributors(Collection<Contributor> contributors)` Changes the institutions or persons responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
`void`	`addCreators(Collection<Creator> creators)` Sets the main researchers involved in producing the data, or the authors of the publication, sorted by priority (most important as first element).
`void`	`addDates(Collection<AbstractDate> dates)` Changes dates relevant to the work.
`void`	`addDescriptions(Collection<Description> descriptions)` Changes all additional information that does not fit in any of the other categories.
`void`	`addExtension(IDataCiteExtension extension)` Adds an IDataCiteExtension to the metadata.
`void`	`addFormats(Collection<String> formats)` Changes technical format of the resource.
`void`	`addFundingReferences(Collection<FundingReference> fundingReferences)` Changes information about financial support (funding) for the resource being registered.
`void`	`addGeoLocations(Collection<GeoLocation> geoLocations)` Changes the spatial regions or named places where the data was gathered or about which the data is focused.
`void`	`addRelatedIdentifiers(Collection<RelatedIdentifier> relatedIdentifiers)` Changes the identifiers of related resources.
`void`	`addResearchData(Collection<ResearchData> researchDataList)` Changes the downloadable source data files.
`void`	`addResearchDisciplines(Collection<AbstractResearch> researchDisciplines)` Changes the set of human readable names of the research disciplines, meaning the topics or domains that this document covers.
`void`	`addRights(Collection<Rights> rightsList)` Changes rights information for this resource.
`void`	`addSizes(Collection<String> sizes)` Changes the unstructured size information about the resource.
`void`	`addSubjects(Collection<Subject> subjects)` Changes the subjects, keywords, classification codes, and key phrases describing the resource.
`void`	`addTitles(Collection<Title> titles)` Changes names or titles by which the resource is known.
`void`	`addWebLinks(Collection<WebLink> webLinks)` Changes the links to the data provider's website.
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`Set<AlternateIdentifier>`	`getAlternateIdentifiers()` Retrieves the identifiers other than the primary Identifier applied to the resource being registered.
`Set<Contributor>`	`getContributors()` Retrieves institutions or persons responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
`List<Creator>`	`getCreators()` Retrieves the main researchers involved in producing the data, or the authors of the publication, in priority order.
`Set<AbstractDate>`	`getDates()` Retrieves the different dates relevant to the work.
`Set<Description>`	`getDescriptions()` Retrieves all additional information that does not fit in any of the other categories.
`DataCiteExtensions`	`getExtensions()` Retrieves discipline specific metadata extensions.
`Set<String>`	`getFormats()` Retrieves the technical format of the resource.
`Set<FundingReference>`	`getFundingReferences()` Retrieves information about financial support (funding) for the resource being registered.
`Set<GeoLocation>`	`getGeoLocations()` Retrieves spatial regions or named places where the data was gathered or about which the data is focused.
`Identifier`	`getIdentifier()` Retrieves the unique string that identifies the resource.
`String`	`getLanguage()` Retrieves the primary language of the resource.
`Integer`	`getPublicationYear()` Retrieves the year when the data was or will be made publicly available.
`Publisher`	`getPublisher()` Retrieves the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
`Set<RelatedIdentifier>`	`getRelatedIdentifiers()` Retrieves identifiers of related resources.
`String`	`getRepositoryIdentifier()` Retrieves a unique, human readable name of the repository.
`Set<ResearchData>`	`getResearchDataList()` Retrieves references to downloadable research data.
`Set<AbstractResearch>`	`getResearchDisciplines()` Retrieves a set of human readable names of the research disciplines, i.e.
`ResourceType`	`getResourceType()` Retrieves the description of the resource.
`Set<Rights>`	`getRightsList()` Retrieves rights information for this resource.
`Set<String>`	`getSizes()` Retrieves unstructured information about the resource size, duration, or extent.
`@NonNull String`	`getSourceId()` Retrieves the identifier of the source of the document.
`Set<Subject>`	`getSubjects()` Retrieves subjects, keywords, classification codes, or key phrases describing the resource.
`Set<Title>`	`getTitles()` Retrieves the names or title by which the resource is known.
`String`	`getVersion()` Retrieves the version number of the resource.
`Set<WebLink>`	`getWebLinks()` Retrieves weblinks related to the resource.
`int`	`hashCode()`
`void`	`setIdentifier(Identifier identifier)` Sets the unique string that identifies the resource.
`void`	`setLanguage(String language)` Sets the primary language of the resource.
`void`	`setPublicationYear(Integer publicationYear)` Sets the year when the data was or will be made publicly available.
`void`	`setPublisher(Publisher publisher)` Sets the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
`void`	`setPublisher(String publisherName)` Deprecated. use the other setter that accepts Publisher instead of String
`void`	`setRepositoryIdentifier(String repositoryIdentifier)` Changes the unique but human readable name of the repository.
`void`	`setResourceType(ResourceType resourceType)` Sets the description of the resource.
`void`	`setVersion(String version)` Sets the version number of the resource.
`String`	`toJson()` Returns a JSON representation of the document.
`String`	`toString()`

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

- Constructor Detail
  - DataCiteJson
```
public DataCiteJson(String sourceId)
             throws IllegalArgumentException
```
    Constructor that sets up the GeRDI extension.
    
    Parameters:
    
    sourceId - a unique identifier of the source from which the document was retrieved
    
    Throws:
    
    IllegalArgumentException
- Method Detail
  - addSizes
```
public void addSizes(Collection<String> sizes)
```
    Changes the unstructured size information about the resource.
    e.g. "15 pages", "6 MB"
    
    Parameters:
    
    sizes - unstructured size information about the resource
  - addFormats
```
public void addFormats(Collection<String> formats)
```
    Changes technical format of the resource. Use file extension or MIME type where possible.
    e.g. PDF, XML, application/pdf, text/xml
    
    Parameters:
    
    formats - technical format of the resource
  - addCreators
```
public void addCreators(Collection<Creator> creators)
```
    Sets the main researchers involved in producing the data, or the authors of the publication, sorted by priority (most important as first element). Duplicate entries are ignored.
    
    Parameters:
    
    creators - the main researchers and/or the authors of the publication
  - addTitles
```
public void addTitles(Collection<Title> titles)
```
    Changes names or titles by which the resource is known.
    
    Parameters:
    
    titles - names or titles by which the resource is known
  - addDescriptions
```
public void addDescriptions(Collection<Description> descriptions)
```
    Changes all additional information that does not fit in any of the other categories.
    
    Parameters:
    
    descriptions - all additional information
  - addSubjects
```
public void addSubjects(Collection<Subject> subjects)
```
    Changes the subjects, keywords, classification codes, and key phrases describing the resource.
    
    Parameters:
    
    subjects - subjects, keywords, classification codes, or key phrases describing the resource
  - addContributors
```
public void addContributors(Collection<Contributor> contributors)
```
    Changes the institutions or persons responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
    
    Parameters:
    
    contributors - institutions or persons responsible for contributing to the development of the resource
  - addDates
```
public void addDates(Collection<AbstractDate> dates)
```
    Changes dates relevant to the work.
    
    Parameters:
    
    dates - dates relevant to the work
  - addGeoLocations
```
public void addGeoLocations(Collection<GeoLocation> geoLocations)
```
    Changes the spatial regions or named places where the data was gathered or about which the data is focused.
    
    Parameters:
    
    geoLocations - spatial regions and/or named places
  - addRelatedIdentifiers
```
public void addRelatedIdentifiers(Collection<RelatedIdentifier> relatedIdentifiers)
```
    Changes the identifiers of related resources. These must be globally unique identifiers.
    
    Parameters:
    
    relatedIdentifiers - identifiers of related resources
  - addAlternateIdentifiers
```
public void addAlternateIdentifiers(Collection<AlternateIdentifier> alternateIdentifiers)
```
    Changes identifiers other than the primary Identifier applied to the resource being registered.
    
    Parameters:
    
    alternateIdentifiers - identifiers other than the primary Identifier
  - addRights
```
public void addRights(Collection<Rights> rightsList)
```
    Changes rights information for this resource.
    
    Parameters:
    
    rightsList - rights information for this resource
  - addFundingReferences
```
public void addFundingReferences(Collection<FundingReference> fundingReferences)
```
    Changes information about financial support (funding) for the resource being registered.
    
    Parameters:
    
    fundingReferences - information about financial support
  - addWebLinks
```
public void addWebLinks(Collection<WebLink> webLinks)
```
    Changes the links to the data provider's website.
    
    Parameters:
    
    webLinks - links to the data provider's website
  - addResearchData
```
public void addResearchData(Collection<ResearchData> researchDataList)
```
    Changes the downloadable source data files.
    
    Parameters:
    
    researchDataList - downloadable files
  - addResearchDisciplines
```
public void addResearchDisciplines(Collection<AbstractResearch> researchDisciplines)
```
    Changes the set of human readable names of the research disciplines, meaning the topics or domains that this document covers.
    
    Parameters:
    
    researchDisciplines - a collection of human readable names of the research disciplines
  - setRepositoryIdentifier
```
public void setRepositoryIdentifier(String repositoryIdentifier)
```
    Changes the unique but human readable name of the repository.
    
    Parameters:
    
    repositoryIdentifier - a unique but human readable name of the repository
  - addExtension
```
public void addExtension(IDataCiteExtension extension)
```
    Adds an IDataCiteExtension to the metadata.
    
    Parameters:
    
    extension - the extension to be added
  - setPublisher
```
public void setPublisher(Publisher publisher)
```
    Sets the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role.
    
    Parameters:
    
    publisher - the publisher
  - setPublisher
```
@Deprecated
public void setPublisher(String publisherName)
```
    Deprecated. use the other setter that accepts Publisher instead of String
    
    Sets the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role.
    
    Parameters:
    
    publisherName - the name of the publisher
  - toJson
```
public String toJson()
```
    Description copied from interface: IDocument
    
    Returns a JSON representation of the document.
    
    Specified by:
    
    toJson in interface IDocument
    
    Returns:
    
    a JSON representation of the document
  - getSourceId
```
@NonNull
public @NonNull String getSourceId()
```
    Retrieves the identifier of the source of the document. The identifier must be unique within the context of the harvester that generates it.
    
    Specified by:
    
    getSourceId in interface IDocument
    
    Returns:
    
    the identifier of the source of the document
  - getIdentifier
```
public Identifier getIdentifier()
```
    Retrieves the unique string that identifies the resource.
    
    Returns:
    
    the unique string that identifies the resource
  - getCreators
```
public List<Creator> getCreators()
```
    Retrieves the main researchers involved in producing the data, or the authors of the publication, in priority order.
    
    Returns:
    
    the main researchers involved in producing the data, or the authors of the publication, in priority order
  - getTitles
```
public Set<Title> getTitles()
```
    Retrieves the names or title by which the resource is known.
    
    Returns:
    
    the names or title by which the resource is known
  - getPublisher
```
public Publisher getPublisher()
```
    Retrieves the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role.
    
    Returns:
    
    the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource
  - getPublicationYear
```
public Integer getPublicationYear()
```
    Retrieves the year when the data was or will be made publicly available. Integer is used instead of the primitive type in order to exclude the publicationYear from the JSON if it was not explicitly set.
    
    Returns:
    
    the year when the data was or will be made publicly available
  - getResourceType
```
public ResourceType getResourceType()
```
    Retrieves the description of the resource.
    
    Returns:
    
    the description of the resource
  - getSubjects
```
public Set<Subject> getSubjects()
```
    Retrieves subjects, keywords, classification codes, or key phrases describing the resource.
    
    Returns:
    
    the subjects, keywords, classification codes, or key phrases
  - getContributors
```
public Set<Contributor> getContributors()
```
    Retrieves institutions or persons responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
    
    Returns:
    
    institutions or persons
  - getDates
```
public Set<AbstractDate> getDates()
```
    Retrieves the different dates relevant to the work.
    
    Returns:
    
    the different dates relevant to the work
  - getLanguage
```
public String getLanguage()
```
    Retrieves the primary language of the resource.
    e.g. de, en-US
    
    Returns:
    
    the primary language of the resource
  - getAlternateIdentifiers
```
public Set<AlternateIdentifier> getAlternateIdentifiers()
```
    Retrieves the identifiers other than the primary Identifier applied to the resource being registered. AlternateIdentifier should be used for another identifier of the same instance (same location, same file).
    
    Returns:
    
    the identifiers other than the primary Identifier applied to the resource being registered
  - getRelatedIdentifiers
```
public Set<RelatedIdentifier> getRelatedIdentifiers()
```
    Retrieves identifiers of related resources. These must be globally unique identifiers.
    
    Returns:
    
    the identifiers of related resources
  - getSizes
```
public Set<String> getSizes()
```
    Retrieves unstructured information about the resource size, duration, or extent.
    e.g. "15 pages", "6 MB", "15 seconds"
    
    Returns:
    
    unstructured information about the resource size, duration, or extent
  - getFormats
```
public Set<String> getFormats()
```
    Retrieves the technical format of the resource.
    e.g. PDF, XML, application/pdf, text/xml
    
    Returns:
    
    the technical format of the resource
  - getVersion
```
public String getVersion()
```
    Retrieves the version number of the resource.
    
    Returns:
    
    the version number of the resource
  - getRightsList
```
public Set<Rights> getRightsList()
```
    Retrieves rights information for this resource.
    
    Returns:
    
    any rights information for this resource
  - getDescriptions
```
public Set<Description> getDescriptions()
```
    Retrieves all additional information that does not fit in any of the other categories.
    
    Returns:
    
    additional information that does not fit in any of the other categories
  - getGeoLocations
```
public Set<GeoLocation> getGeoLocations()
```
    Retrieves spatial regions or named places where the data was gathered or about which the data is focused.
    
    Returns:
    
    the spatial regions or named places where the data was gathered or about which the data is focused
  - getFundingReferences
```
public Set<FundingReference> getFundingReferences()
```
    Retrieves information about financial support (funding) for the resource being registered.
    
    Returns:
    
    information about funding for the resource being registered
  - getRepositoryIdentifier
```
public String getRepositoryIdentifier()
```
    Retrieves a unique, human readable name of the repository.
    e.g. Sea Around Us, FAOSTAT
    
    Returns:
    
    a unique, human readable name of the repository
  - getWebLinks
```
public Set<WebLink> getWebLinks()
```
    Retrieves weblinks related to the resource.
    
    Returns:
    
    weblinks related to the resource
  - getResearchDataList
```
public Set<ResearchData> getResearchDataList()
```
    Retrieves references to downloadable research data.
    
    Returns:
    
    references to downloadable research data
  - getResearchDisciplines
```
public Set<AbstractResearch> getResearchDisciplines()
```
    Retrieves a set of human readable names of the research disciplines, i.e. the topics or domains that this document covers.
    e.g. Computer Science, Geography
    
    Returns:
    
    the research disciplines to which the document belongs
  - getExtensions
```
public DataCiteExtensions getExtensions()
```
    Retrieves discipline specific metadata extensions.
    
    Returns:
    
    discipline specific metadata extensions
  - setIdentifier
```
public void setIdentifier(Identifier identifier)
```
    Sets the unique string that identifies the resource.
    
    Parameters:
    
    identifier - the unique string that identifies the resource
  - setPublicationYear
```
public void setPublicationYear(Integer publicationYear)
```
    Sets the year when the data was or will be made publicly available. Integer is used instead of the primitive type in order to exclude the publicationYear from the JSON if it was not explicitly set.
    
    Parameters:
    
    publicationYear - the year when the data was or will be made publicly available
  - setResourceType
```
public void setResourceType(ResourceType resourceType)
```
    Sets the description of the resource.
    
    Parameters:
    
    resourceType - the description of the resource
  - setLanguage
```
public void setLanguage(String language)
```
    Sets the primary language of the resource.
    e.g. de, en-US
    Allowed values are taken from IETF BCP 47, ISO 639-1 language codes.
    
    Parameters:
    
    language - the primary language of the resource
  - setVersion
```
public void setVersion(String version)
```
    Sets the version number of the resource. If the primary resource has changed the version number increases.
    
    Parameters:
    
    version - the version number of the resource
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DataCiteJson

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataCiteJson

Method Detail

addSizes

addFormats

addCreators

addTitles

addDescriptions

addSubjects

addContributors

addDates

addGeoLocations

addRelatedIdentifiers

addAlternateIdentifiers

addRights

addFundingReferences

addWebLinks

addResearchData

addResearchDisciplines

setRepositoryIdentifier

addExtension

setPublisher

setPublisher

toJson

getSourceId

getIdentifier

getCreators

getTitles

getPublisher

getPublicationYear

getResourceType

getSubjects

getContributors

getDates

getLanguage

getAlternateIdentifiers

getRelatedIdentifiers

getSizes

getFormats

getVersion

getRightsList

getDescriptions

getGeoLocations

getFundingReferences

getRepositoryIdentifier

getWebLinks

getResearchDataList

getResearchDisciplines

getExtensions

setIdentifier

setPublicationYear

setResourceType

setLanguage

setVersion

equals

canEqual

hashCode

toString