From 3f9c0b897d1d78ae3d722493927d46a50b7994d9 Mon Sep 17 00:00:00 2001 From: "miriam.baglioni" Date: Thu, 13 Aug 2020 17:06:49 +0200 Subject: [PATCH] added descriptions --- .../schema/dump/oaf/community/CommunityResult.java | 7 +++++++ .../dhp/schema/dump/oaf/community/Context.java | 14 +++++++++++--- .../dhp/schema/dump/oaf/community/Funder.java | 7 +++++++ .../dhp/schema/dump/oaf/community/Project.java | 9 +++++++++ 4 files changed, 34 insertions(+), 3 deletions(-) diff --git a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityResult.java b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityResult.java index bbdc735da2..7469326569 100644 --- a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityResult.java +++ b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityResult.java @@ -6,6 +6,12 @@ import java.util.List; 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 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 + * - context of type List 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. + * - collectedfrom of type List 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. + */ public class CommunityResult extends Result { private List projects; @@ -37,4 +43,5 @@ public class CommunityResult extends Result { public void setContext(List context) { this.context = context; } + } diff --git a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Context.java b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Context.java index 1c532a4860..0616d4a4bf 100644 --- a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Context.java +++ b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Context.java @@ -1,12 +1,20 @@ package eu.dnetlib.dhp.schema.dump.oaf.community; -import eu.dnetlib.dhp.schema.dump.oaf.Provenance; -import eu.dnetlib.dhp.schema.dump.oaf.Qualifier; - import java.util.List; import java.util.Objects; +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 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 istanziated 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; diff --git a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Funder.java b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Funder.java index d16a7a4d35..39d1bafc2e 100644 --- a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Funder.java +++ b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Funder.java @@ -3,6 +3,13 @@ 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 + */ public class Funder implements Serializable { private String shortName; diff --git a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Project.java b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Project.java index adf88a5fb3..19f35ddffb 100644 --- a/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Project.java +++ b/dhp-schemas/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Project.java @@ -5,6 +5,15 @@ import java.io.Serializable; 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: + * - 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 { private String id;// OpenAIRE id