andreas.czerniak
/
BrBETA_dnet-hadoop
forked from D-Net/dnet-hadoop
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added descriptions

This commit is contained in:
Miriam Baglioni 2020-08-13 18:23:24 +02:00
parent 7ae1f76a6f
commit e60a9e49b0
30 changed files with 284 additions and 246 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/APC.java
View File

@ -4,9 +4,8 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
/**
* Used to refer to the Article Processing Charge information. Not dumped in this release. It contains two parameters:
* - currency of type String to store the currency of the APC
* - amount of type String to stores the charged amount
* Used to refer to the Article Processing Charge information. Not dumped in this release. It contains two parameters: -
* currency of type String to store the currency of the APC - amount of type String to stores the charged amount
*/
public class APC implements Serializable {
private String currency;

12
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AccessRight.java
View File

@ -2,12 +2,12 @@
package eu.dnetlib.dhp.schema.dump.oaf;
/**
* AccessRight. Used to represent the result access rights. It extends the eu.dnet.lib.dhp.schema.dump.oaf.Qualifier
* element with a parameter scheme of type String to store the scheme. Values for this element are found against the
* COAR access right scheme. The classid of the element accessright in eu.dnetlib.dhp.schema.oaf.Result is used to
* get the COAR corresponding code whose value will be used to set the code parameter. The COAR label corresponding
* to the COAR code will be used to set the label parameter. The scheme value will always be the one referring to the
* COAR access right scheme
* AccessRight. Used to represent the result access rights. It extends the eu.dnet.lib.dhp.schema.dump.oaf.Qualifier
* element with a parameter scheme of type String to store the scheme. Values for this element are found against the
* COAR access right scheme. The classid of the element accessright in eu.dnetlib.dhp.schema.oaf.Result is used to get
* the COAR corresponding code whose value will be used to set the code parameter. The COAR label corresponding to the
* COAR code will be used to set the label parameter. The scheme value will always be the one referring to the COAR
* access right scheme
*/
public class AccessRight extends Qualifier {

29
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Author.java
View File

@ -5,23 +5,18 @@ import java.io.Serializable;
import java.util.List;
/**
* Used to represent the generic author of the result. It has six parameters:
* - name of type String to store the given name of the author. The value for this parameter corresponds
* to eu.dnetlib.dhp.schema.oaf.Author name
* - surname of type String to store the family name of the author. The value for this parameter corresponds to
* eu.dnetlib.dhp.schema.oaf.Author surname
* - fullname of type String to store the fullname of the author. The value for this parameter corresponds to
* eu.dnetlib.dhp.schema.oaf.Author fullname
* - rank of type Integer to store the rank on the author in the result's authors list. The value for this parameter
* corresponds to eu.dnetlib.dhp.schema.oaf.Author rank
* - pid of type eu.dnetlib.dhp.schema.dump.oaf.Pid to store the persistent identifier for the author. For the moment
* only ORCID identifiers will be dumped.
* - The id element is instantiated by using the following values in the eu.dnetlib.dhp.schema.oaf.Result pid:
* * Qualifier.classid for scheme
* * value for value
* - The provenance element is instantiated only if the dataInfo is set for the pid in the result to be dumped. The provenance element is instantiated by using the following values in the eu.dnetlib.dhp.schema.oaf.Result pid:
* * dataInfo.provenanceaction.classname for provenance
* * dataInfo.trust for trust
* Used to represent the generic author of the result. It has six parameters: - name of type String to store the given
* name of the author. The value for this parameter corresponds to eu.dnetlib.dhp.schema.oaf.Author name - surname of
* type String to store the family name of the author. The value for this parameter corresponds to
* eu.dnetlib.dhp.schema.oaf.Author surname - fullname of type String to store the fullname of the author. The value for
* this parameter corresponds to eu.dnetlib.dhp.schema.oaf.Author fullname - rank of type Integer to store the rank on
* the author in the result's authors list. The value for this parameter corresponds to eu.dnetlib.dhp.schema.oaf.Author
* rank - pid of type eu.dnetlib.dhp.schema.dump.oaf.Pid to store the persistent identifier for the author. For the
* moment only ORCID identifiers will be dumped. - The id element is instantiated by using the following values in the
* eu.dnetlib.dhp.schema.oaf.Result pid: * Qualifier.classid for scheme * value for value - The provenance element is
* instantiated only if the dataInfo is set for the pid in the result to be dumped. The provenance element is
* instantiated by using the following values in the eu.dnetlib.dhp.schema.oaf.Result pid: *
* dataInfo.provenanceaction.classname for provenance * dataInfo.trust for trust
*/
public class Author implements Serializable {

35
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Container.java
View File

@ -5,26 +5,21 @@ import java.io.Serializable;
import java.util.Objects;
/**
* To store information about the conference or journal where the result has been presented or published.
* It contains eleven parameters:
* - name of type String to store the name of the journal or conference. It corresponds to the parameter name of
* eu.dnetlib.dhp.schema.oaf.Journal
* - issnPrinted ot type String to store the journal printed issn. It corresponds to the parameter issnPrinted of
* eu.dnetlib.dhp.schema.oaf.Journal
* - issnOnline of type String to store the journal online issn. It corresponds to the parameter issnOnline of
* eu.dnetlib.dhp.schema.oaf.Journal
* - issnLinking of type String to store the journal linking issn. It corresponds to the parameter issnLinking of
* eu.dnetlib.dhp.schema.oaf.Journal
* - ep of type String to store the end page. It corresponds to the parameter ep of eu.dnetlib.dhp.schema.oaf.Journal
* - iss of type String to store the journal issue. It corresponds to the parameter iss of eu.dnetlib.dhp.schema.oaf.Journal
* - sp of type String to store the start page. It corresponds to the parameter sp of eu.dnetlib.dhp.schema.oaf.Journal
* - vol of type String to store the Volume. It corresponds to the parameter vol of eu.dnetlib.dhp.schema.oaf.Journal
* - edition of type String to store the edition of the journal or conference proceeding. It corresponds to the
* parameter edition of eu.dnetlib.dhp.schema.oaf.Journal
* - conferenceplace of type String to store the place of the conference. It corresponds to the parameter
* conferenceplace of eu.dnetlib.dhp.schema.oaf.Journal
* - conferencedate of type String to store the date of the conference. It corresponds to the parameter conferencedate
* of eu.dnetlib.dhp.schema.oaf.Journal
* To store information about the conference or journal where the result has been presented or published. It contains
* eleven parameters: - name of type String to store the name of the journal or conference. It corresponds to the
* parameter name of eu.dnetlib.dhp.schema.oaf.Journal - issnPrinted ot type String to store the journal printed issn.
* It corresponds to the parameter issnPrinted of eu.dnetlib.dhp.schema.oaf.Journal - issnOnline of type String to store
* the journal online issn. It corresponds to the parameter issnOnline of eu.dnetlib.dhp.schema.oaf.Journal -
* issnLinking of type String to store the journal linking issn. It corresponds to the parameter issnLinking of
* eu.dnetlib.dhp.schema.oaf.Journal - ep of type String to store the end page. It corresponds to the parameter ep of
* eu.dnetlib.dhp.schema.oaf.Journal - iss of type String to store the journal issue. It corresponds to the parameter
* iss of eu.dnetlib.dhp.schema.oaf.Journal - sp of type String to store the start page. It corresponds to the parameter
* sp of eu.dnetlib.dhp.schema.oaf.Journal - vol of type String to store the Volume. It corresponds to the parameter vol
* of eu.dnetlib.dhp.schema.oaf.Journal - edition of type String to store the edition of the journal or conference
* proceeding. It corresponds to the parameter edition of eu.dnetlib.dhp.schema.oaf.Journal - conferenceplace of type
* String to store the place of the conference. It corresponds to the parameter conferenceplace of
* eu.dnetlib.dhp.schema.oaf.Journal - conferencedate of type String to store the date of the conference. It corresponds
* to the parameter conferencedate of eu.dnetlib.dhp.schema.oaf.Journal
*/
public class Container implements Serializable {

6
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/ControlledField.java
View File

@ -4,10 +4,8 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
/**
* To represent the information described by a scheme and a value in that scheme (i.e. pid).
* It has two parameters:
* - scheme of type String to store the scheme
* - value of type String to store the value in that scheme
* To represent the information described by a scheme and a value in that scheme (i.e. pid). It has two parameters: -
* scheme of type String to store the scheme - value of type String to store the value in that scheme
*/
public class ControlledField implements Serializable {
private String scheme;

13
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Country.java
View File

@ -3,13 +3,12 @@ package eu.dnetlib.dhp.schema.dump.oaf;
/**
* Represents the country associated to this result. It extends eu.dnetlib.dhp.schema.dump.oaf.Qualifier with a
* provenance parameter of type eu.dnetlib.dhp.schema.dumo.oaf.Provenance. The country in not mapped if its value in
* the result reprensented in the internal format is Unknown. The value for this element correspond to:
* - code corresponds to the classid of eu.dnetlib.dhp.schema.oaf.Country
* - label corresponds to the classname of eu.dnetlib.dhp.schema.oaf.Country
* - provenance set only if the dataInfo associated to the Country of the result to be dumped is not null. In this case :
* - provenance corresponds to dataInfo.provenanceaction.classid (to be modified with datainfo.provenanceaction.classname)
* - trust corresponds to dataInfo.trust
* provenance parameter of type eu.dnetlib.dhp.schema.dumo.oaf.Provenance. The country in not mapped if its value in the
* result reprensented in the internal format is Unknown. The value for this element correspond to: - code corresponds
* to the classid of eu.dnetlib.dhp.schema.oaf.Country - label corresponds to the classname of
* eu.dnetlib.dhp.schema.oaf.Country - provenance set only if the dataInfo associated to the Country of the result to be
* dumped is not null. In this case : - provenance corresponds to dataInfo.provenanceaction.classid (to be modified with
* datainfo.provenanceaction.classname) - trust corresponds to dataInfo.trust
*/
public class Country extends Qualifier {

8
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/GeoLocation.java
View File

@ -8,10 +8,10 @@ import org.apache.commons.lang3.StringUtils;
import com.fasterxml.jackson.annotation.JsonIgnore;
/**
* Represents the geolocation information. It has three parameters:
* - point of type String to store the point information. It corresponds to eu.dnetlib.dhp.schema.oaf.GeoLocation point
* - box ot type String to store the box information. It corresponds to eu.dnetlib.dhp.schema.oaf.GeoLocation box
* - place of type String to store the place information. It corresponds to eu.dnetlib.dhp.schema.oaf.GeoLocation place
* Represents the geolocation information. It has three parameters: - point of type String to store the point
* information. It corresponds to eu.dnetlib.dhp.schema.oaf.GeoLocation point - box ot type String to store the box
* information. It corresponds to eu.dnetlib.dhp.schema.oaf.GeoLocation box - place of type String to store the place
* information. It corresponds to eu.dnetlib.dhp.schema.oaf.GeoLocation place
*/
public class GeoLocation implements Serializable {

38
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Instance.java
View File

@ -6,25 +6,21 @@ import java.util.List;
/**
* Represents the manifestations (i.e. different versions) of the result. For example: the pre-print and the published
* versions are two manifestations of the same research result. It has the following parameters:
* - license of type String to store the license applied to the instance. It corresponds to the value of the licence in
* the instance to be dumped
* - accessright of type eu.dnetlib.dhp.schema.dump.oaf.AccessRight to store the accessright of the instance.
* - type of type String to store the type of the instance as defined in the corresponding dnet vocabulary
* (dnet:pubication_resource). It corresponds to the instancetype.classname of the instance to be mapped
* - hostedby of type eu.dnetlib.dhp.schema.dump.oaf.KeyValue to store the information about the source from which the
* instance can be viewed or downloaded. It is mapped against the hostedby parameter of the instance to be dumped and
* - key corresponds to hostedby.key
* - value corresponds to hostedby.value
* - url of type List<String> list of locations where the instance is accessible. It corresponds to url of the instance
* to be dumped
* - collectedfrom of type eu.dnetlib.dhp.schema.dump.oaf.KeyValue to store the information about the source from which
* the instance has been collected. It is mapped against the collectedfrom parameter of the instance to be dumped and
* - key corresponds to collectedfrom.key
* - value corresponds to collectedfrom.value
* - publicationdate of type String to store the publication date of the instance ;// dateofacceptance;
* - refereed of type String to store information abour tthe review status of the instance. Possible values are
* 'Unknown', 'nonPeerReviewed', 'peerReviewed'. It corresponds to refereed.classname of the instance to be dumped
* versions are two manifestations of the same research result. It has the following parameters: - license of type
* String to store the license applied to the instance. It corresponds to the value of the licence in the instance to be
* dumped - accessright of type eu.dnetlib.dhp.schema.dump.oaf.AccessRight to store the accessright of the instance. -
* type of type String to store the type of the instance as defined in the corresponding dnet vocabulary
* (dnet:pubication_resource). It corresponds to the instancetype.classname of the instance to be mapped - hostedby of
* type eu.dnetlib.dhp.schema.dump.oaf.KeyValue to store the information about the source from which the instance can be
* viewed or downloaded. It is mapped against the hostedby parameter of the instance to be dumped and - key corresponds
* to hostedby.key - value corresponds to hostedby.value - url of type List<String> list of locations where the instance
* is accessible. It corresponds to url of the instance to be dumped - collectedfrom of type
* eu.dnetlib.dhp.schema.dump.oaf.KeyValue to store the information about the source from which the instance has been
* collected. It is mapped against the collectedfrom parameter of the instance to be dumped and - key corresponds to
* collectedfrom.key - value corresponds to collectedfrom.value - publicationdate of type String to store the
* publication date of the instance ;// dateofacceptance; - refereed of type String to store information abour tthe
* review status of the instance. Possible values are 'Unknown', 'nonPeerReviewed', 'peerReviewed'. It corresponds to
* refereed.classname of the instance to be dumped
*/
public class Instance implements Serializable {
@ -34,11 +30,11 @@ public class Instance implements Serializable {
private String type;
private KeyValue hostedby;
private KeyValue hostedby;
private List<String> url;
private KeyValue collectedfrom;
private KeyValue collectedfrom;
private String publicationdate;// dateofacceptance;

5
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/KeyValue.java
View File

@ -8,9 +8,8 @@ import org.apache.commons.lang3.StringUtils;
import com.fasterxml.jackson.annotation.JsonIgnore;
/**
* To represent the information described by a key and a value. It has two parameters:
* - key to store the key (generally the OpenAIRE id for some entity)
* - value to store the value (generally the OpenAIRE name for the key)
* To represent the information described by a key and a value. It has two parameters: - key to store the key (generally
* the OpenAIRE id for some entity) - value to store the value (generally the OpenAIRE name for the key)
*/
public class KeyValue implements Serializable {

6
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Pid.java
View File

@ -4,9 +4,9 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
/**
* To represent the generic persistent identifier. It has two parameters:
* - id of type eu.dnetlib.dhp.schema.dump.oaf.ControlledField to store the scheme and value of the Persistent Identifier.
* - provenance of type eu.dnetlib.dhp.schema.dump.oaf.Provenance to store the provenance and trust of the information
* To represent the generic persistent identifier. It has two parameters: - id of type
* eu.dnetlib.dhp.schema.dump.oaf.ControlledField to store the scheme and value of the Persistent Identifier. -
* provenance of type eu.dnetlib.dhp.schema.dump.oaf.Provenance to store the provenance and trust of the information
*/
public class Pid implements Serializable {
private ControlledField id;

7
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Provenance.java
View File

@ -4,10 +4,9 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
/**
* Indicates the process that produced (or provided) the information, and the trust associated to the information.
* It has two parameters:
* - provenance of type String to store the provenance of the information,
* - trust of type String to store the trust associated to the information
* Indicates the process that produced (or provided) the information, and the trust associated to the information. It
* has two parameters: - provenance of type String to store the provenance of the information, - trust of type String to
* store the trust associated to the information
*/
public class Provenance implements Serializable {
private String provenance;

6
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Qualifier.java
View File

@ -8,9 +8,9 @@ import org.apache.commons.lang3.StringUtils;
import com.fasterxml.jackson.annotation.JsonIgnore;
/**
* To represent the information described by a code and a value It has two parameters:
* - code to store the code (generally the classid of the eu.dnetlib.dhp.schema.oaf.Qualifier element)
* - label to store the label (generally the classname of the eu.dnetlib.dhp.schema.oaf.Qualifier element
* To represent the information described by a code and a value It has two parameters: - code to store the code
* (generally the classid of the eu.dnetlib.dhp.schema.oaf.Qualifier element) - label to store the label (generally the
* classname of the eu.dnetlib.dhp.schema.oaf.Qualifier element
*/
public class Qualifier implements Serializable {

130
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Result.java
View File

@ -7,79 +7,63 @@ import java.util.List;
import eu.dnetlib.dhp.schema.dump.oaf.community.Project;
/**
* To represent the dumped result. It will be extended in the dump for Research Communities -
* Research Initiative/Infrastructures. It has the following parameters:
* - author of type List<eu.dnetlib.dhpschema.dump.oaf.Author> to describe the authors of a result.
* For each author in the result represented in the internal model one author in the esternal model is produced.
* - type of type String to represent the category of the result. Possible values are publication, dataset, software,
* other. It corresponds to resulttype.classname of the dumped result
* - language of type eu.dnetlib.dhp.schema.dump.oaf.Qualifier to store information about the language of the result.
* It is dumped as
* - code corresponds to language.classid
* - value corresponds to language.classname
* - country of type List<eu.dnetlib.dhp.schema.dump.oaf.Country> to store the country list to which the result is
* associated. For each country in the result respresented in the internal model one country in the external model
* is produces
* - subjects of type List<eu.dnetlib.dhp.dump.oaf.Subject> to store the subjects for the result. For each subject in
* the result represented in the internal model one subject in the external model is produced
* - maintitle of type String to store the main title of the result. It corresponds to the value of the first title in
* the resul to be dumped having classid equals to "main title"
* - subtitle of type String to store the subtitle of the result. It corresponds to the value of the first title in the
* resul to be dumped having classid equals to "subtitle"
* - description of type List<String> to store the description of the result. It corresponds to the list of
* description.value in the result represented in the internal model
* - publicationdate of type String to store the pubblication date. It corresponds to dateofacceptance.value in the
* result represented in the internal model
* - publisher of type String to store information about the publisher. It corresponds to publisher.value of the result
* represented in the intrenal model
* - embargoenddate of type String to store the embargo end date. It corresponds to embargoenddate.value of the result
* represented in the internal model
* - source of type List<String> See definition of Dublin Core field dc:source. It corresponds to the list of
* source.value in the result represented in the internal model
* - format of type List<String> It corresponds to the list of format.value in the result represented in the internal model
* - contributor of type List<String> to represent contributors for this result. It corresponds to the list of
* contributor.value in the result represented in the internal model
* - coverage of type String. It corresponds to the list of coverage.value in the result represented in the internal model
* - bestaccessright of type eu.dnetlib.dhp.schema.dump.oaf.AccessRight to store informatin about the openest access
* right associated to the manifestations of this research results. It corresponds to the same parameter in the result
* represented in the internal model
* - instance of type List<eu.dnetlib.dhp.schema.dump.oaf.Instance> to store all the instances associated to the result.
* It corresponds to the same parameter in the result represented in the internal model
* - container of type eu.dnetlib.dhp.schema/dump.oaf.Container (only for result of type publication). It corresponds
* to the parameter journal of the result represented in the internal model
* - documentationUrl of type List<String> (only for results of type software) to store the URLs to the software
* documentation. It corresponds to the list of documentationUrl.value of the result represented in the internal model
* - codeRepositoryUrl of type String (only for results of type software) to store the URL to the repository with the
* source code. It corresponds to codeRepositoryUrl.value of the result represented in the internal model
* - programmingLanguage of type String (only for results of type software) to store the programming language. It
* corresponds to programmingLanguaga.classid of the result represented in the internal model
* - contactperson of type List<String> (only for results of type other) to store the contact person for this result.
* It corresponds to the list of contactperson.value of the result represented in the internal model
* - contactgroup of type List<String> (only for results of type other) to store the information for the contact group.
* It corresponds to the list of contactgroup.value of the result represented in the internal model
* - tool of type List<String> (only fro results of type other) to store information about tool useful for the
* interpretation and/or re-used of the research product. It corresponds to the list of tool.value in the result
* represented in the internal modelt
* - size of type String (only for results of type dataset) to store the size of the dataset. It corresponds to
* size.value in the result represented in the internal model
* - version of type String (only for results of type dataset) to store the version. It corresponds to version.value of
* the result represented in the internal model
* - geolocation fo type List<eu.dnetlib.dhp.schema.dump.oaf.GeoLocation> (only for results of type dataset) to store
* geolocation information. For each geolocation element in the result represented in the internal model a GeoLocation
* in the external model il produced
* - id of type String to store the OpenAIRE id of the result. It corresponds to the id of the result represented in
* the internal model
* - originalId of type List<String> to store the original ids of the result. It corresponds to the originalId of the
* result represented in the internal model
* - pid of type List<eu.dnetlib.dhp.schema.dump.oaf.ControlledField> to store the persistent identifiers for the result.
* For each pid in the results represented in the internal model one pid in the external model is produced.
* The value correspondence is:
* - scheme corresponds to pid.qualifier.classid of the result represented in the internal model
* - value corresponds to the pid.value of the result represented in the internal model
* - dateofcollection of type String to store information about the time OpenAIRE collected the record. It corresponds
* to dateofcollection of the result represented in the internal model
* - lasteupdatetimestamp of type String to store the timestamp of the last update of the record. It corresponds to
* lastupdatetimestamp of the resord represented in the internal model
* To represent the dumped result. It will be extended in the dump for Research Communities - Research
* Initiative/Infrastructures. It has the following parameters: - author of type
* List<eu.dnetlib.dhpschema.dump.oaf.Author> to describe the authors of a result. For each author in the result
* represented in the internal model one author in the esternal model is produced. - type of type String to represent
* the category of the result. Possible values are publication, dataset, software, other. It corresponds to
* resulttype.classname of the dumped result - language of type eu.dnetlib.dhp.schema.dump.oaf.Qualifier to store
* information about the language of the result. It is dumped as - code corresponds to language.classid - value
* corresponds to language.classname - country of type List<eu.dnetlib.dhp.schema.dump.oaf.Country> to store the country
* list to which the result is associated. For each country in the result respresented in the internal model one country
* in the external model is produces - subjects of type List<eu.dnetlib.dhp.dump.oaf.Subject> to store the subjects for
* the result. For each subject in the result represented in the internal model one subject in the external model is
* produced - maintitle of type String to store the main title of the result. It corresponds to the value of the first
* title in the resul to be dumped having classid equals to "main title" - subtitle of type String to store the subtitle
* of the result. It corresponds to the value of the first title in the resul to be dumped having classid equals to
* "subtitle" - description of type List<String> to store the description of the result. It corresponds to the list of
* description.value in the result represented in the internal model - publicationdate of type String to store the
* pubblication date. It corresponds to dateofacceptance.value in the result represented in the internal model -
* publisher of type String to store information about the publisher. It corresponds to publisher.value of the result
* represented in the intrenal model - embargoenddate of type String to store the embargo end date. It corresponds to
* embargoenddate.value of the result represented in the internal model - source of type List<String> See definition of
* Dublin Core field dc:source. It corresponds to the list of source.value in the result represented in the internal
* model - format of type List<String> It corresponds to the list of format.value in the result represented in the
* internal model - contributor of type List<String> to represent contributors for this result. It corresponds to the
* list of contributor.value in the result represented in the internal model - coverage of type String. It corresponds
* to the list of coverage.value in the result represented in the internal model - bestaccessright of type
* eu.dnetlib.dhp.schema.dump.oaf.AccessRight to store informatin about the openest access right associated to the
* manifestations of this research results. It corresponds to the same parameter in the result represented in the
* internal model - instance of type List<eu.dnetlib.dhp.schema.dump.oaf.Instance> to store all the instances associated
* to the result. It corresponds to the same parameter in the result represented in the internal model - container of
* type eu.dnetlib.dhp.schema/dump.oaf.Container (only for result of type publication). It corresponds to the parameter
* journal of the result represented in the internal model - documentationUrl of type List<String> (only for results of
* type software) to store the URLs to the software documentation. It corresponds to the list of documentationUrl.value
* of the result represented in the internal model - codeRepositoryUrl of type String (only for results of type
* software) to store the URL to the repository with the source code. It corresponds to codeRepositoryUrl.value of the
* result represented in the internal model - programmingLanguage of type String (only for results of type software) to
* store the programming language. It corresponds to programmingLanguaga.classid of the result represented in the
* internal model - contactperson of type List<String> (only for results of type other) to store the contact person for
* this result. It corresponds to the list of contactperson.value of the result represented in the internal model -
* contactgroup of type List<String> (only for results of type other) to store the information for the contact group. It
* corresponds to the list of contactgroup.value of the result represented in the internal model - tool of type
* List<String> (only fro results of type other) to store information about tool useful for the interpretation and/or
* re-used of the research product. It corresponds to the list of tool.value in the result represented in the internal
* modelt - size of type String (only for results of type dataset) to store the size of the dataset. It corresponds to
* size.value in the result represented in the internal model - version of type String (only for results of type
* dataset) to store the version. It corresponds to version.value of the result represented in the internal model -
* geolocation fo type List<eu.dnetlib.dhp.schema.dump.oaf.GeoLocation> (only for results of type dataset) to store
* geolocation information. For each geolocation element in the result represented in the internal model a GeoLocation
* in the external model il produced - id of type String to store the OpenAIRE id of the result. It corresponds to the
* id of the result represented in the internal model - originalId of type List<String> to store the original ids of the
* result. It corresponds to the originalId of the result represented in the internal model - pid of type
* List<eu.dnetlib.dhp.schema.dump.oaf.ControlledField> to store the persistent identifiers for the result. For each pid
* in the results represented in the internal model one pid in the external model is produced. The value correspondence
* is: - scheme corresponds to pid.qualifier.classid of the result represented in the internal model - value corresponds
* to the pid.value of the result represented in the internal model - dateofcollection of type String to store
* information about the time OpenAIRE collected the record. It corresponds to dateofcollection of the result
* represented in the internal model - lasteupdatetimestamp of type String to store the timestamp of the last update of
* the record. It corresponds to lastupdatetimestamp of the resord represented in the internal model
*/
public class Result implements Serializable {

14
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Subject.java
View File

@ -4,14 +4,12 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
/**
* To represent keywords associated to the result. It has two parameters:
* - subject of type eu.dnetlib.dhp.schema.dump.oaf.ControlledField to describe the subject. It mapped as:
* - schema it corresponds to qualifier.classid of the dumped subject
* - value it corresponds to the subject value
* - provenance of type eu.dnetlib.dhp.schema.dump.oaf.Provenance to represent the provenance of the subject.
* It is dumped only if dataInfo is not null. In this case:
* - provenance corresponds to dataInfo.provenanceaction.classname
* - trust corresponds to dataInfo.trust
* To represent keywords associated to the result. It has two parameters: - subject of type
* eu.dnetlib.dhp.schema.dump.oaf.ControlledField to describe the subject. It mapped as: - schema it corresponds to
* qualifier.classid of the dumped subject - value it corresponds to the subject value - provenance of type
* eu.dnetlib.dhp.schema.dump.oaf.Provenance to represent the provenance of the subject. It is dumped only if dataInfo
* is not null. In this case: - provenance corresponds to dataInfo.provenanceaction.classname - trust corresponds to
* dataInfo.trust
*/
public class Subject implements Serializable {
private ControlledField subject;

17
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityResult.java
View File

@ -7,15 +7,14 @@ import eu.dnetlib.dhp.schema.dump.oaf.KeyValue;
import eu.dnetlib.dhp.schema.dump.oaf.Result;
/**
* extends eu.dnetlib.dhp.schema.dump.oaf.Result with the following parameters:
* - projects of type List<eu.dnetlib.dhp.schema.dump.oaf.community.Project> to store the list of projects related
* to the result. The information is added after the result is mapped to the external model
* - context of type List<eu.dnetlib.dhp.schema/dump.oaf.community.Context> to store information about the RC RI
* related to the result. For each context in the result represented in the internal model one context in the
* external model is produced
* - collectedfrom of type List<eu.dnetliv.dhp.schema.dump.oaf.KeyValue> to store information about the sources
* from which the record has been collected. For each collectedfrom in the result represented in the internal
* model one collectedfrom in the external model is produced
* extends eu.dnetlib.dhp.schema.dump.oaf.Result with the following parameters: - projects of type
* List<eu.dnetlib.dhp.schema.dump.oaf.community.Project> to store the list of projects related to the result. The
* information is added after the result is mapped to the external model - context of type
* List<eu.dnetlib.dhp.schema/dump.oaf.community.Context> to store information about the RC RI related to the result.
* For each context in the result represented in the internal model one context in the external model is produced -
* collectedfrom of type List<eu.dnetliv.dhp.schema.dump.oaf.KeyValue> to store information about the sources from which
* the record has been collected. For each collectedfrom in the result represented in the internal model one
* collectedfrom in the external model is produced
*/
public class CommunityResult extends Result {

23
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Context.java
View File

@ -8,19 +8,16 @@ import eu.dnetlib.dhp.schema.dump.oaf.Provenance;
import eu.dnetlib.dhp.schema.dump.oaf.Qualifier;
/**
* Reference to a relevant research infrastructure, initiative or community (RI/RC) among those collaborating with OpenAIRE.
* It extend eu.dnetlib.dhp.shema.dump.oaf.Qualifier with a parameter provenance of type
* List<eu.dnetlib.dhp.schema.dump.oaf.Provenance> to store the provenances of the association between the result
* and the RC/RI. The values for this element correspond to:
* - code: it corresponds to the id of the context in the result to be mapped.
* If the context id refers to a RC/RI and contains '::' only the part of the id before the first "::"
* will be used as value for code
* - label it corresponds to the label associated to the id. The information id taken from the profile of the RC/RI
* - provenance it is set only if the dataInfo associated to the contenxt element of the result to be dumped
* is not null. For each dataInfo one instance of type eu.dnetlib.dhp.schema.dump.oaf.Provenance
* is instantiated if the element datainfo.provenanceaction is not null. In this case
* - provenance corresponds to dataInfo.provenanceaction.classname
* - trust corresponds to dataInfo.trust
* Reference to a relevant research infrastructure, initiative or community (RI/RC) among those collaborating with
* OpenAIRE. It extend eu.dnetlib.dhp.shema.dump.oaf.Qualifier with a parameter provenance of type
* List<eu.dnetlib.dhp.schema.dump.oaf.Provenance> to store the provenances of the association between the result and
* the RC/RI. The values for this element correspond to: - code: it corresponds to the id of the context in the result
* to be mapped. If the context id refers to a RC/RI and contains '::' only the part of the id before the first "::"
* will be used as value for code - label it corresponds to the label associated to the id. The information id taken
* from the profile of the RC/RI - provenance it is set only if the dataInfo associated to the contenxt element of the
* result to be dumped is not null. For each dataInfo one instance of type eu.dnetlib.dhp.schema.dump.oaf.Provenance is
* instantiated if the element datainfo.provenanceaction is not null. In this case - provenance corresponds to
* dataInfo.provenanceaction.classname - trust corresponds to dataInfo.trust
*/
public class Context extends Qualifier {
private List<Provenance> provenance;

9
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Funder.java
View File

@ -4,11 +4,10 @@ package eu.dnetlib.dhp.schema.dump.oaf.community;
import java.io.Serializable;
/**
* To store information about the funder funding the project related to the result. It has the following parameters:
* - shortName of type String to store the funder short name (e.c. AKA).
* - name of type String to store the funder name (e.c. Akademy of Finland)
* - fundingStream of type String to store the funding stream
* - jurisdiction of type String to store the jurisdiction of the funder
* To store information about the funder funding the project related to the result. It has the following parameters: -
* shortName of type String to store the funder short name (e.c. AKA). - name of type String to store the funder name
* (e.c. Akademy of Finland) - fundingStream of type String to store the funding stream - jurisdiction of type String to
* store the jurisdiction of the funder
*/
public class Funder implements Serializable {
private String shortName;

17
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Project.java
View File

@ -7,16 +7,13 @@ import eu.dnetlib.dhp.schema.dump.oaf.Provenance;
/**
* To store information about the project related to the result. This information is not directly mapped from the result
* represented in the internal model because it is not there. The mapped result will be enriched with project information
* derived by relation between results and projects. Project class has the following parameters:
* - id of type String to store the OpenAIRE id for the Project
* - code of type String to store the grant agreement
* - acronym of type String to store the acronym for the project
* - title of type String to store the title of the project
* - funder of type eu.dnetlib.dhp.schema.dump.oaf.community.Funder to store information about the funder funding
* the project
* - provenance of type eu.dnetlib.dhp.schema.dump.oaf.Provenance to store information about the. provenance of the
* association between the result and the project
* represented in the internal model because it is not there. The mapped result will be enriched with project
* information derived by relation between results and projects. Project class has the following parameters: - id of
* type String to store the OpenAIRE id for the Project - code of type String to store the grant agreement - acronym of
* type String to store the acronym for the project - title of type String to store the title of the project - funder of
* type eu.dnetlib.dhp.schema.dump.oaf.community.Funder to store information about the funder funding the project -
* provenance of type eu.dnetlib.dhp.schema.dump.oaf.Provenance to store information about the. provenance of the
* association between the result and the project
*/
public class Project implements Serializable {

54
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Datasource.java
View File

@ -9,37 +9,29 @@ import eu.dnetlib.dhp.schema.dump.oaf.ControlledField;
import eu.dnetlib.dhp.schema.dump.oaf.KeyValue;
/**
* To store information about the datasource OpenAIRE collects information from. It contains the following parameters:
* - id of type String to store the OpenAIRE id for the datasource. It corresponds to the parameter id of the
* datasource represented in the internal model
* - originalId of type List<String> to store the list of original ids associated to the datasource. It corresponds
* to the parameter originalId of the datasource represented in the internal model. The null values are filtered out
* - pid of type List<eu.dnetlib.shp.schema.dump.oaf.ControlledField> to store the persistent identifiers for the
* datasource. For each pid in the datasource represented in the internal model one pid in the external model is
* produced as :
* - schema corresponds to pid.qualifier.classid of the datasource represented in the internal model
* - value corresponds to pid.value of the datasource represented in the internal model
* - datasourceType of type eu.dnetlib.dhp.schema.dump.oaf.ControlledField to store the datasource type
* (e.g. pubsrepository::institutional, Institutional Repository) as in the dnet vocabulary
* dnet:datasource_typologies. It corresponds to datasourcetype of the datasource represented in the internal
* model and :
* - code corresponds to datasourcetype.classid
* - value corresponds to datasourcetype.classname
* - openairecompatibility of type String to store information about the OpenAIRE compatibility of the ingested
* results (which guidelines they are compliant to). It corresponds to openairecompatibility.classname of the
* datasource represented in the internal model
* - officialname of type Sgtring to store the official name of the datasource. It correspond to officialname.value
* of the datasource represented in the internal model
* - englishname of type String to store the English name of the datasource. It corresponds to englishname.value of
* the datasource represented in the internal model
* - websiteurl of type String to store the URL of the website of the datasource. It corresponds to websiteurl.value
* of the datasource represented in the internal model
* - logourl of type String to store the URL of the logo for the datasource. It corresponds to logourl.value of the
* datasource represented in the internal model
* - dateofvalidation of type String to store the data of validation against the guidelines for the datasource
* records. It corresponds to dateofvalidation.value of the datasource represented in the internal model
* - description of type String to store the description for the datasource. It corresponds to description.value of
* the datasource represented in the internal model
* To store information about the datasource OpenAIRE collects information from. It contains the following parameters: -
* id of type String to store the OpenAIRE id for the datasource. It corresponds to the parameter id of the datasource
* represented in the internal model - originalId of type List<String> to store the list of original ids associated to
* the datasource. It corresponds to the parameter originalId of the datasource represented in the internal model. The
* null values are filtered out - pid of type List<eu.dnetlib.shp.schema.dump.oaf.ControlledField> to store the
* persistent identifiers for the datasource. For each pid in the datasource represented in the internal model one pid
* in the external model is produced as : - schema corresponds to pid.qualifier.classid of the datasource represented in
* the internal model - value corresponds to pid.value of the datasource represented in the internal model -
* datasourceType of type eu.dnetlib.dhp.schema.dump.oaf.ControlledField to store the datasource type (e.g.
* pubsrepository::institutional, Institutional Repository) as in the dnet vocabulary dnet:datasource_typologies. It
* corresponds to datasourcetype of the datasource represented in the internal model and : - code corresponds to
* datasourcetype.classid - value corresponds to datasourcetype.classname - openairecompatibility of type String to
* store information about the OpenAIRE compatibility of the ingested results (which guidelines they are compliant to).
* It corresponds to openairecompatibility.classname of the datasource represented in the internal model - officialname
* of type Sgtring to store the official name of the datasource. It correspond to officialname.value of the datasource
* represented in the internal model - englishname of type String to store the English name of the datasource. It
* corresponds to englishname.value of the datasource represented in the internal model - websiteurl of type String to
* store the URL of the website of the datasource. It corresponds to websiteurl.value of the datasource represented in
* the internal model - logourl of type String to store the URL of the logo for the datasource. It corresponds to
* logourl.value of the datasource represented in the internal model - dateofvalidation of type String to store the data
* of validation against the guidelines for the datasource records. It corresponds to dateofvalidation.value of the
* datasource represented in the internal model - description of type String to store the description for the
* datasource. It corresponds to description.value of the datasource represented in the internal model
*/
public class Datasource implements Serializable {

4
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Funder.java
View File

@ -5,6 +5,10 @@ import java.io.Serializable;
/**
* To store information about the funder funding the project related to the result. It has the following parameters:
* - private String shortName to store the short name of the funder (e.g. AKA)
* - private String name to store information about the name of the funder (e.g. Akademy of Finland)
* - private Fundings funding_stream to store the fundingstream
* - private String jurisdiction to store information about the jurisdiction of the funder
*/
public class Funder implements Serializable {

9
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Fundings.java
View File

@ -3,6 +3,15 @@ package eu.dnetlib.dhp.schema.dump.oaf.graph;
import java.io.Serializable;
/**
* To store inforamtion about the funding stream. It has two parameters:
* - private String id to store the id of the fundings stream. The id is created by appending the shortname of the
* funder to the name of each level in the xml representing the fundng stream. For example: if the funder is the
* European Commission, the funding level 0 name is FP7, the funding level 1 name is SP3 and the funding level 2 name is
* PEOPLE then the id will be: EC::FP7::SP3::PEOPLE
* - private String description to describe the funding stream. It is created by concatenating the description of each funding
* level so for the example above the description would be: SEVENTH FRAMEWORK PROGRAMME - SP3-People - Marie-Curie Actions
*/
public class Fundings implements Serializable {
private String id;

6
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Granted.java
View File

@ -4,6 +4,12 @@ package eu.dnetlib.dhp.schema.dump.oaf.graph;
import java.io.Serializable;
import java.util.Optional;
/**
* To describe the funded amount. It has the following parameters:
* - private String currency to store the currency of the fund
* - private float totalcost to store the total cost of the project
* - private float fundedamount to store the funded amount by the funder
*/
public class Granted implements Serializable {
private String currency;
private float totalcost;

9
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Node.java
View File

@ -3,6 +3,15 @@ package eu.dnetlib.dhp.schema.dump.oaf.graph;
import java.io.Serializable;
/**
* To represent the generic node in a relation. It has the following parameters:
* - private String id the openaire id of the entity in the relation
* - private String type the type of the entity in the relation.
*
* Consider the generic relation between a Result R and a Project P, the node representing R will have
* as id the id of R and as type result, while the node representing the project will have as id the id of the project
* and as type project
*/
public class Node implements Serializable {
private String id;
private String type;

11
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Organization.java
View File

@ -10,6 +10,17 @@ import eu.dnetlib.dhp.schema.dump.oaf.KeyValue;
import eu.dnetlib.dhp.schema.dump.oaf.Qualifier;
import eu.dnetlib.dhp.schema.dump.oaf.community.Project;
/**
* To represent the generic organizaiton. It has the following parameters:
* - private String legalshortname to store the legalshortname of the organizaiton
* - private String legalname to store the legal name of the organization
* - private String websiteurl to store the websiteurl of the organization
* - private List<String> alternativenames to store the alternative names of the organization
* - private Qualifier country to store the country of the organization
* - private String id to store the id of the organization
* - private List<ControlledField> pid to store the list of pids for the organization
*/
public class Organization implements Serializable {
private String legalshortname;
private String legalname;

5
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Programme.java
View File

@ -3,6 +3,11 @@ package eu.dnetlib.dhp.schema.dump.oaf.graph;
import java.io.Serializable;
/**
* To store information about the ec programme for the project. It has the following parameters:
* - private String code to store the code of the programme
* - private String description to store the description of the programme
*/
public class Programme implements Serializable {
private String code;
private String description;

23
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Project.java
View File

@ -9,12 +9,31 @@ import eu.dnetlib.dhp.schema.dump.oaf.KeyValue;
/**
* This is the class representing the Project in the model used for the dumps of the whole graph. At the moment the dump
* of the Projects differs from the other dumps because we do not create relations between Funders (Organization) and
* Projects but to take the information about the Funder within the Project representation. We also removed the
* Projects but we put the information about the Funder within the Project representation. We also removed the
* collected from element from the Project. No relation between the Project and the Datasource entity from which it is
* collected will be created. We will never create relations between Project and Datasource. In case some relation will
* be extracted from the Project they will refer the Funder and will be of type ( organization -> funds -> project,
* project -> isFundedBy -> organization) We also removed the duration parameter because the most of times it is set to
* 0
* 0. It has the following parameters:
* - private String id to store the id of the project (OpenAIRE id)
* - private String websiteurl to store the websiteurl of the project
* - private String code to store the grant agreement of the project
* - private String acronym to store the acronym of the project
* - private String title to store the tile of the project
* - private String startdate to store the start date
* - private String enddate to store the end date
* - private String callidentifier to store the call indentifier
* - private String keywords to store the keywords
* - private boolean openaccessmandateforpublications to store if the project must accomplish to the open access mandate
* for publications. This value will be set to true if one of the field in the project represented in the internal model
* is set to true
* - private boolean openaccessmandatefordataset to store if the project must accomplish to the open access mandate for
* dataset. It is set to the value in the corresponding filed of the project represented in the internal model
* - private List<String> subject to store the list of subjects of the project
* - private List<Funder> funding to store the list of funder of the project
* - private String summary to store the summary of the project
* - private Granted granted to store the granted amount
* - private List<Programme> programme to store the list of programmes the project is related to
*/
public class Project implements Serializable {

8
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/RelType.java
View File

@ -3,6 +3,14 @@ package eu.dnetlib.dhp.schema.dump.oaf.graph;
import java.io.Serializable;
/**
* To represent the semantics of the generic relation between two entities. It has the following parameters:
* - private String name to store the semantics of the relation (i.e. isAuthorInstitutionOf). It corresponds to the
* relclass parameter in the relation represented in the internal model
* represented in the internal model
* - private String type to store the type of the relation (i.e. affiliation). It corresponds to the subreltype parameter
* of the relation represented in theinternal model
*/
public class RelType implements Serializable {
private String name; // relclass
private String type; // subreltype

7
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Relation.java
View File

@ -6,6 +6,13 @@ import java.util.Objects;
import eu.dnetlib.dhp.schema.dump.oaf.Provenance;
/**
* To represent the gereric relation between two entities. It has the following parameters:
* - private Node source to represent the entity source of the relation
* - private Node target to represent the entity target of the relation
* - private RelType reltype to represent the semantics of the relation
* - private Provenance provenance to represent the provenance of the relation
*/
public class Relation implements Serializable {
private Node source;
private Node target;

4
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/ResearchCommunity.java
View File

@ -3,6 +3,10 @@ package eu.dnetlib.dhp.schema.dump.oaf.graph;
import java.util.List;
/**
* To represent RC entities. It extends eu.dnetlib.dhp.dump.oaf.grap.ResearchInitiative by adding the parameter subject
* to store the list of subjects related to the community
*/
public class ResearchCommunity extends ResearchInitiative {
private List<String> subject;

10
dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/ResearchInitiative.java
View File

@ -3,6 +3,16 @@ package eu.dnetlib.dhp.schema.dump.oaf.graph;
import java.io.Serializable;
/**
* To represent entity of type RC/RI. It has the following parameters, which are mostly derived by the profile
* - private String id to store the openaire id for the entity. Is has as code 00 and will be created as
* 00|context_____::md5(originalId)
* private String originalId to store the id of the context as provided in the profile (i.e. mes)
* private String name to store the name of the context (got from the label attribute in the context definition)
* private String type to store the type of the context (i.e.: research initiative or research community)
* private String description to store the description of the context as given in the profile
* private String zenodo_community to store the zenodo community associated to the context (main zenodo community)
*/
public class ResearchInitiative implements Serializable {
private String id; // openaireId
private String originalId; // context id