added descriptions

This commit is contained in:
Miriam Baglioni 2020-08-13 17:17:49 +02:00
parent 3f9c0b897d
commit 7ae1f76a6f
10 changed files with 149 additions and 53 deletions

View File

@ -5,7 +5,8 @@ import java.io.Serializable;
import java.util.Objects; import java.util.Objects;
/** /**
* To store information about the conference or journal where the result has been presented or published. It contains eleven parameters: * 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 * - 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 * eu.dnetlib.dhp.schema.oaf.Journal
* - issnPrinted ot type String to store the journal printed issn. It corresponds to the parameter issnPrinted of * - issnPrinted ot type String to store the journal printed issn. It corresponds to the parameter issnPrinted of
@ -18,9 +19,12 @@ import java.util.Objects;
* - iss of type String to store the journal issue. It corresponds to the parameter iss 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 * - 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 * - 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 * - edition of type String to store the edition of the journal or conference proceeding. It corresponds to the
* - conferenceplace of type String to store the place of the conference. It corresponds to the parameter conferenceplace of eu.dnetlib.dhp.schema.oaf.Journal * parameter edition 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 * - 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 { public class Container implements Serializable {

View File

@ -7,18 +7,24 @@ import java.util.List;
/** /**
* Represents the manifestations (i.e. different versions) of the result. For example: the pre-print and the published * 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: * 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 isntance to be dumped * - license of type String to store the license applied to the instance. It corresponds to the value of the licence in
* - accessright of type eu.dnetlib.dhp.schema.dump.oaf.AccessRight to store the accessright of the instance. It is mapped as specified above * the instance to be dumped
* - 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 * - accessright of type eu.dnetlib.dhp.schema.dump.oaf.AccessRight to store the accessright of the instance.
* - 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 agaist the hostedby parameter of the instance to be dumped and * - 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 * - key corresponds to hostedby.key
* - value corresponds to hostedby.value * - 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 * - url of type List<String> list of locations where the instance is accessible. It corresponds to url of the instance
* - 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 * 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 * - key corresponds to collectedfrom.key
* - value corresponds to collectedfrom.value * - value corresponds to collectedfrom.value
* - publicationdate of type String to store the publication date of the instance ;// dateofacceptance; * - 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 * - 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 { public class Instance implements Serializable {

View File

@ -4,7 +4,8 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable; import java.io.Serializable;
/** /**
* Indicates the process that produced (or provided) the information, and the trust associated to the information. It has two parameters: * 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, * - provenance of type String to store the provenance of the information,
* - trust of type String to store the trust associated to the information * - trust of type String to store the trust associated to the information
*/ */

View File

@ -10,43 +10,76 @@ import eu.dnetlib.dhp.schema.dump.oaf.community.Project;
* To represent the dumped result. It will be extended in the dump for Research Communities - * To represent the dumped result. It will be extended in the dump for Research Communities -
* Research Initiative/Infrastructures. It has the following parameters: * 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. * - author of type List<eu.dnetlib.dhpschema.dump.oaf.Author> to describe the authors of a result.
* For each author is applied a dump as described previously * 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 * - type of type String to represent the category of the result. Possible values are publication, dataset, software,
* - language of type eu.dnetlib.dhp.schema.dump.oaf.Qualifier to store information about the language of the result. It is dumped as * 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 * - code corresponds to language.classid
* - value corresponds to language.classname * - 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 as described above * - country of type List<eu.dnetlib.dhp.schema.dump.oaf.Country> to store the country list to which the result is
* - 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 as described above * associated. For each country in the result respresented in the internal model one country in the external model
* - 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" * is produces
* - 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" * - subjects of type List<eu.dnetlib.dhp.dump.oaf.Subject> to store the subjects for the result. For each subject in
* - 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 * the result represented in the internal model one subject in the external model is produced
* - publicationdate of type String to store the pubblication date. It corresponds to dateofacceptance.value in the result represented in the internal model * - maintitle of type String to store the main title of the result. It corresponds to the value of the first title in
* - publisher of type String to store information about the publisher. It corresponds to publisher.value of the result represented in the intrenal model * the resul to be dumped having classid equals to "main title"
* - embargoenddate of type String to store the embargo end date. It corresponds to embargoenddate.value of the result represented in the internal model * - subtitle of type String to store the subtitle of the result. It corresponds to the value of the first title in the
* - 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 * 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 * - 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 * - 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 * - 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 and it is dumped as descriveb above * - bestaccessright of type eu.dnetlib.dhp.schema.dump.oaf.AccessRight to store informatin about the openest access
* - externalReference of type List<ExternalReference>. It will not be described here. ExternalReference to be changed in the mapping * right associated to the manifestations of this research results. It corresponds to the same parameter in the result
* - 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 and it is mapped as described previously * 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 and it is mapped as described prevoiusly * - instance of type List<eu.dnetlib.dhp.schema.dump.oaf.Instance> to store all the instances associated to the result.
* - 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 * It corresponds to the same parameter in 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 * - container of type eu.dnetlib.dhp.schema/dump.oaf.Container (only for result of type publication). It corresponds
* - 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 * to the parameter journal 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 * - documentationUrl of type List<String> (only for results of type software) to store the URLs to the software
* - 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 * documentation. It corresponds to the list of documentationUrl.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 * - codeRepositoryUrl of type String (only for results of type software) to store the URL to the repository with the
* - 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 * source code. It corresponds to codeRepositoryUrl.value of 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 * - programmingLanguage of type String (only for results of type software) to store the programming language. It
* - 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 produces ad described above * corresponds to programmingLanguaga.classid of the result represented in the internal model
* - 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 * - contactperson of type List<String> (only for results of type other) to store the contact person for this result.
* - 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 * It corresponds to the list of contactperson.value 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: * - 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 * - 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 * - 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 * - dateofcollection of type String to store information about the time OpenAIRE collected the record. It corresponds
* - 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 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 { public class Result implements Serializable {

View File

@ -8,9 +8,14 @@ import eu.dnetlib.dhp.schema.dump.oaf.Result;
/** /**
* extends eu.dnetlib.dhp.schema.dump.oaf.Result with the following parameters: * 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 and the description is provided afterwards * - projects of type List<eu.dnetlib.dhp.schema.dump.oaf.community.Project> to store the list of projects related
* - 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 as described above. * to the result. The information is added after the result is mapped to the external model
* - 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 as described for the dump of the same element within th instance. * - 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 { public class CommunityResult extends Result {

View File

@ -8,10 +8,17 @@ import eu.dnetlib.dhp.schema.dump.oaf.Provenance;
import eu.dnetlib.dhp.schema.dump.oaf.Qualifier; 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: * Reference to a relevant research infrastructure, initiative or community (RI/RC) among those collaborating with OpenAIRE.
* - 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 * 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 * - 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 istanziated if the element datainfo.provenanceaction is not null. In this case * - 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 * - provenance corresponds to dataInfo.provenanceaction.classname
* - trust corresponds to dataInfo.trust * - trust corresponds to dataInfo.trust
*/ */

View File

@ -4,7 +4,7 @@ package eu.dnetlib.dhp.schema.dump.oaf.community;
import java.io.Serializable; import java.io.Serializable;
/** /**
* to store information about the funder funding the project related to the result. It has the following parameters: * 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). * - 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) * - name of type String to store the funder name (e.c. Akademy of Finland)
* - fundingStream of type String to store the funding stream * - fundingStream of type String to store the funding stream

View File

@ -6,13 +6,17 @@ import java.io.Serializable;
import eu.dnetlib.dhp.schema.dump.oaf.Provenance; 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. The way used to do it will be described afterwards. Project class has the following parameters: * 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 * - id of type String to store the OpenAIRE id for the Project
* - code of type String to store the grant agreement * - code of type String to store the grant agreement
* - acronym of type String to store the acronym for the project * - acronym of type String to store the acronym for the project
* - title of type String to store the title of 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 * - funder of type eu.dnetlib.dhp.schema.dump.oaf.community.Funder to store information about the funder funding
* - 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 * 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 { public class Project implements Serializable {

View File

@ -8,6 +8,39 @@ import eu.dnetlib.dhp.schema.dump.oaf.Container;
import eu.dnetlib.dhp.schema.dump.oaf.ControlledField; import eu.dnetlib.dhp.schema.dump.oaf.ControlledField;
import eu.dnetlib.dhp.schema.dump.oaf.KeyValue; 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
*/
public class Datasource implements Serializable { public class Datasource implements Serializable {
private String id; // string private String id; // string

View File

@ -3,6 +3,9 @@ package eu.dnetlib.dhp.schema.dump.oaf.graph;
import java.io.Serializable; import java.io.Serializable;
/**
* To store information about the funder funding the project related to the result. It has the following parameters:
*/
public class Funder implements Serializable { public class Funder implements Serializable {
private String shortName; private String shortName;