DataCiteJson (GSON 4.2.3 API)

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

All Implemented Interfaces:

ICleanable, IDocument
```
public class DataCiteJson
extends Object
implements IDocument, ICleanable
```
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

Constructor Summary

Constructors
Constructor and Description
`DataCiteJson()` Deprecated.
`DataCiteJson(String sourceId)` This constructor set the source identifier of the document which allows for persisting it when one of its values change.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clean()` Cleans the object, making it compatible with the ElasticSearch index.
`List<AlternateIdentifier>`	`getAlternateIdentifiers()` Returns identifiers other than the primary Identifier applied to the resource being registered.
`List<Contributor>`	`getContributors()` Returns the institutions or persons responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
`List<Creator>`	`getCreators()` Returns the main researchers involved in producing the data, or the authors of the publication, in priority order.
`List<AbstractDate>`	`getDates()` Returns different dates relevant to the work.
`List<Description>`	`getDescriptions()` Returns all additional information that does not fit in any of the other categories.
`List<String>`	`getFormats()` Returns technical format of the resource.
`List<FundingReference>`	`getFundingReferences()` Returns information about financial support (funding) for the resource being registered.
`List<GeoLocation>`	`getGeoLocations()` Returns the spatial regions or named places where the data was gathered or about which the data is focused.
`Identifier`	`getIdentifier()` Returns a unique identifier of the resource.
`String`	`getLanguage()` Returns the primary language of the resource.
`short`	`getPublicationYear()` Returns the year when the data was or will be made publicly available.
`String`	`getPublisher()` Returns the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
`List<RelatedIdentifier>`	`getRelatedIdentifiers()` Returns identifiers of related resources.
`String`	`getRepositoryIdentifier()` Returns the unique but human readable name of the repository.
`List<ResearchData>`	`getResearchDataList()` Returns downloadable source data files.
`List<AbstractResearch>`	`getResearchDisciplines()` Retrieves the list of human readable names of the research disciplines, meaning the topics or domains that this document covers.
`ResourceType`	`getResourceType()` Returns a description of the resource.
`List<Rights>`	`getRightsList()` Returns any rights information for this resource.
`List<String>`	`getSizes()` Returns unstructured size information about the resource.
`String`	`getSourceId()` Returns an identifier of the source of the document.
`List<Subject>`	`getSubjects()` Returns subjects, keywords, classification codes, or key phrases describing the resource.
`List<Title>`	`getTitles()` Returns names or titles by which the resource is known.
`String`	`getVersion()` Returns the version number of the resource.
`List<WebLink>`	`getWebLinks()` Returns links to the data provider's website.
`void`	`setAlternateIdentifiers(List<AlternateIdentifier> alternateIdentifiers)` Changes identifiers other than the primary Identifier applied to the resource being registered.
`void`	`setContributors(List<Contributor> contributors)` Changes the institutions or persons responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
`void`	`setCreators(List<Creator> creators)` Changes the main researchers involved in producing the data, or the authors of the publication.
`void`	`setDates(List<AbstractDate> dates)` Changes dates relevant to the work.
`void`	`setDescriptions(List<Description> descriptions)` Changes all additional information that does not fit in any of the other categories.
`void`	`setFormats(List<String> formats)` Changes technical format of the resource.
`void`	`setFundingReferences(List<FundingReference> fundingReferences)` Changes information about financial support (funding) for the resource being registered.
`void`	`setGeoLocations(List<GeoLocation> geoLocations)` Changes the spatial regions or named places where the data was gathered or about which the data is focused.
`void`	`setIdentifier(Identifier identifier)` Changes the unique identifier of the resource.
`void`	`setLanguage(String language)` Changes the primary language of the resource.
`void`	`setPublicationYear(short publicationYear)` Changes the year when the data was or will be made publicly available.
`void`	`setPublisher(String publisher)` Changes the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource
`void`	`setRelatedIdentifiers(List<RelatedIdentifier> relatedIdentifiers)` Changes the identifiers of related resources.
`void`	`setRepositoryIdentifier(String repositoryIdentifier)` Changes the unique but human readable name of the repository.
`void`	`setResearchDataList(List<ResearchData> files)` Changes the downloadable source data files.
`void`	`setResearchDisciplines(List<AbstractResearch> researchDisciplines)` Changes the list of human readable names of the research disciplines, meaning the topics or domains that this document covers.
`void`	`setResourceType(ResourceType resourceType)` Changes the description of the resource.
`void`	`setRightsList(List<Rights> rightsList)` Changes rights information for this resource.
`void`	`setSizes(List<String> sizes)` Changes the unstructured size information about the resource.
`void`	`setSubjects(List<Subject> subjects)` Changes the subjects, keywords, classification codes, and key phrases describing the resource.
`void`	`setTitles(List<Title> titles)` Changes names or titles by which the resource is known.
`void`	`setVersion(String version)` Changes the version number of the resource.
`void`	`setWebLinks(List<WebLink> webLinks)` Changes the links to the data provider's website.

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

- Constructor Detail
  - DataCiteJson
```
public DataCiteJson(String sourceId)
```
    This constructor set the source identifier of the document which allows for persisting it when one of its values change.
    
    Parameters:
    
    sourceId - a unique identifier of the source from which the document was retrieved
  - DataCiteJson
```
@Deprecated
public DataCiteJson()
```
    Deprecated.
    
    This constructor does not set a sourceId. As a fallback, a hash code of the harvested document is returned as a source identifier, causing any reference to this document in the index to be lost if any field value is updated.
- Method Detail
  - getSourceId
```
public String getSourceId()
```
    Returns an identifier of the source of the document. If no such identifier was set, a hash value of the JSON representation of this document is used as a fallback, causing any reference to this document in the index to be lost if any field value is updated.
    
    Specified by:
    
    getSourceId in interface IDocument
    
    Returns:
    
    a unique identifier of the source from which the document was retrieved
  - getIdentifier
```
public Identifier getIdentifier()
```
    Returns a unique identifier of the resource.
    
    Returns:
    
    a unique identifier of the resource
  - setIdentifier
```
public void setIdentifier(Identifier identifier)
```
    Changes the unique identifier of the resource.
    
    Parameters:
    
    identifier - a unique identifier of the resource
  - getPublisher
```
public String getPublisher()
```
    Returns the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
    
    Returns:
    
    the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource
  - setPublisher
```
public void setPublisher(String publisher)
```
    Changes the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource
    
    Parameters:
    
    publisher - the name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource
  - getVersion
```
public String getVersion()
```
    Returns the version number of the resource.
    
    Returns:
    
    the version number of the resource
  - setVersion
```
public void setVersion(String version)
```
    Changes the version number of the resource.
    
    Parameters:
    
    version - the version number of the resource
  - getLanguage
```
public String getLanguage()
```
    Returns the primary language of the resource.
    
    Returns:
    
    the primary language of the resource
  - setLanguage
```
public void setLanguage(String language)
```
    Changes the primary language of the resource. Allowed values are taken from IETF BCP 47, ISO 639-1 language codes.
    
    Parameters:
    
    language - the primary language of the resource
  - getPublicationYear
```
public short getPublicationYear()
```
    Returns the year when the data was or will be made publicly available.
    
    Returns:
    
    the year when the data was or will be made publicly available
  - setPublicationYear
```
public void setPublicationYear(short publicationYear)
```
    Changes the year when the data was or will be made publicly available.
    
    Parameters:
    
    publicationYear - the year when the data was or will be made publicly available
  - getResourceType
```
public ResourceType getResourceType()
```
    Returns a description of the resource.
    
    Returns:
    
    a description of the resource
  - setResourceType
```
public void setResourceType(ResourceType resourceType)
```
    Changes the description of the resource.
    
    Parameters:
    
    resourceType - a description of the resource
  - getRepositoryIdentifier
```
public String getRepositoryIdentifier()
```
    Returns the unique but human readable name of the repository.
    e.g. Sea Around Us, FAOSTAT
    
    Returns:
    
    a unique but human readable name of the repository
  - 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
  - getResearchDisciplines
```
public List<AbstractResearch> getResearchDisciplines()
```
    Retrieves the list of human readable names of the research disciplines, meaning the topics or domains that this document covers.
    
    Returns:
    
    a list of human readable names of the research disciplines
  - setResearchDisciplines
```
public void setResearchDisciplines(List<AbstractResearch> researchDisciplines)
```
    Changes the list of human readable names of the research disciplines, meaning the topics or domains that this document covers.
    
    Parameters:
    
    researchDisciplines - a list of human readable names of the research disciplines
  - getSizes
```
public List<String> getSizes()
```
    Returns unstructured size information about the resource.
    
    Returns:
    
    unstructured size information about the resource
  - setSizes
```
public void setSizes(List<String> sizes)
```
    Changes the unstructured size information about the resource.
    e.g. "15 pages", "6 MB"
    
    Parameters:
    
    sizes - unstructured size information about the resource
  - getFormats
```
public List<String> getFormats()
```
    Returns technical format of the resource.
    
    Returns:
    
    technical format of the resource
  - setFormats
```
public void setFormats(List<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
  - getCreators
```
public List<Creator> getCreators()
```
    Returns the main researchers involved in producing the data, or the authors of the publication, in priority order.
    
    Returns:
    
    the main researchers and/or the authors of the publication
  - setCreators
```
public void setCreators(List<Creator> creators)
```
    Changes the main researchers involved in producing the data, or the authors of the publication.
    
    Parameters:
    
    creators - the main researchers and/or the authors of the publication
  - getTitles
```
public List<Title> getTitles()
```
    Returns names or titles by which the resource is known.
    
    Returns:
    
    names or titles by which the resource is known
  - setTitles
```
public void setTitles(List<Title> titles)
```
    Changes names or titles by which the resource is known.
    
    Parameters:
    
    titles - names or titles by which the resource is known
  - getDescriptions
```
public List<Description> getDescriptions()
```
    Returns all additional information that does not fit in any of the other categories.
    
    Returns:
    
    all additional information
  - setDescriptions
```
public void setDescriptions(List<Description> descriptions)
```
    Changes all additional information that does not fit in any of the other categories.
    
    Parameters:
    
    descriptions - all additional information
  - getSubjects
```
public List<Subject> getSubjects()
```
    Returns subjects, keywords, classification codes, or key phrases describing the resource.
    
    Returns:
    
    subjects, keywords, classification codes, or key phrases describing the resource
  - setSubjects
```
public void setSubjects(List<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
  - getContributors
```
public List<Contributor> getContributors()
```
    Returns the institutions or persons responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
    
    Returns:
    
    institutions or persons responsible for contributing to the development of the resource
  - setContributors
```
public void setContributors(List<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
  - getDates
```
public List<AbstractDate> getDates()
```
    Returns different dates relevant to the work.
    
    Returns:
    
    dates relevant to the work
  - setDates
```
public void setDates(List<AbstractDate> dates)
```
    Changes dates relevant to the work.
    
    Parameters:
    
    dates - dates relevant to the work
  - getGeoLocations
```
public List<GeoLocation> getGeoLocations()
```
    Returns the spatial regions or named places where the data was gathered or about which the data is focused.
    
    Returns:
    
    spatial regions and/or named places
  - setGeoLocations
```
public void setGeoLocations(List<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
  - getRelatedIdentifiers
```
public List<RelatedIdentifier> getRelatedIdentifiers()
```
    Returns identifiers of related resources.
    
    Returns:
    
    identifiers of related resources
  - setRelatedIdentifiers
```
public void setRelatedIdentifiers(List<RelatedIdentifier> relatedIdentifiers)
```
    Changes the identifiers of related resources. These must be globally unique identifiers.
    
    Parameters:
    
    relatedIdentifiers - identifiers of related resources
  - getAlternateIdentifiers
```
public List<AlternateIdentifier> getAlternateIdentifiers()
```
    Returns identifiers other than the primary Identifier applied to the resource being registered.
    
    Returns:
    
    identifiers other than the primary Identifier
  - setAlternateIdentifiers
```
public void setAlternateIdentifiers(List<AlternateIdentifier> alternateIdentifiers)
```
    Changes identifiers other than the primary Identifier applied to the resource being registered.
    
    Parameters:
    
    alternateIdentifiers - identifiers other than the primary Identifier
  - getRightsList
```
public List<Rights> getRightsList()
```
    Returns any rights information for this resource.
    
    Returns:
    
    rights information for this resource
  - setRightsList
```
public void setRightsList(List<Rights> rightsList)
```
    Changes rights information for this resource.
    
    Parameters:
    
    rightsList - rights information for this resource
  - getFundingReferences
```
public List<FundingReference> getFundingReferences()
```
    Returns information about financial support (funding) for the resource being registered.
    
    Returns:
    
    information about financial support
  - setFundingReferences
```
public void setFundingReferences(List<FundingReference> fundingReferences)
```
    Changes information about financial support (funding) for the resource being registered.
    
    Parameters:
    
    fundingReferences - information about financial support
  - getWebLinks
```
public List<WebLink> getWebLinks()
```
    Returns links to the data provider's website.
    
    Returns:
    
    links to the data provider's website
  - setWebLinks
```
public void setWebLinks(List<WebLink> webLinks)
```
    Changes the links to the data provider's website.
    
    Parameters:
    
    webLinks - links to the data provider's website
  - getResearchDataList
```
public List<ResearchData> getResearchDataList()
```
    Returns downloadable source data files.
    
    Returns:
    
    downloadable files
  - setResearchDataList
```
public void setResearchDataList(List<ResearchData> files)
```
    Changes the downloadable source data files.
    
    Parameters:
    
    files - downloadable files
  - clean
```
public void clean()
```
    Description copied from interface: ICleanable
    
    Cleans the object, making it compatible with the ElasticSearch index.
    
    Specified by:
    
    clean in interface ICleanable

Class DataCiteJson

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataCiteJson

DataCiteJson

Method Detail

getSourceId

getIdentifier

setIdentifier

getPublisher

setPublisher

getVersion

setVersion

getLanguage

setLanguage

getPublicationYear

setPublicationYear

getResourceType

setResourceType

getRepositoryIdentifier

setRepositoryIdentifier

getResearchDisciplines

setResearchDisciplines

getSizes

setSizes

getFormats

setFormats

getCreators

setCreators

getTitles

setTitles

getDescriptions

setDescriptions

getSubjects

setSubjects

getContributors

setContributors

getDates

setDates

getGeoLocations

setGeoLocations

getRelatedIdentifiers

setRelatedIdentifiers

getAlternateIdentifiers

setAlternateIdentifiers

getRightsList

setRightsList

getFundingReferences

setFundingReferences

getWebLinks

setWebLinks

getResearchDataList

setResearchDataList

clean