diff --git a/pom.xml b/pom.xml
index 5e5131c..4e549de 100644
--- a/pom.xml
+++ b/pom.xml
@@ -137,7 +137,23 @@
maven-dependency-plugin3.0.0
+
+ org.codehaus.mojo
+ exec-maven-plugin
+ 3.0.0
+
+
+
+ com.fasterxml.jackson.core
+ jackson-databind
+ ${dhp.jackson.version}
+
+
+
+
+
+
@@ -229,6 +245,19 @@
${scala.version}
+
+ org.codehaus.mojo
+ exec-maven-plugin
+
+ true
+ eu.dnetlib.dhp.schema.dump.ExecCreateSchemas
+
+ eu.dnetlib.dhp.schema.dump.oaf.GraphResult;eu.dnetlib.dhp.schema.dump.oaf.graph.Organization;eu.dnetlib.dhp.schema.dump.oaf.graph.Project
+
+
+
+
+
@@ -364,13 +393,14 @@
com.github.victoolsjsonschema-generator${jsonschemagenerator.version}
- test
+
com.github.imifoujsonschema-module-addon1.2.1
+
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/ExecCreateSchemas.java b/src/main/java/eu/dnetlib/dhp/schema/dump/ExecCreateSchemas.java
new file mode 100644
index 0000000..ca520cc
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/ExecCreateSchemas.java
@@ -0,0 +1,75 @@
+package eu.dnetlib.dhp.schema.dump;
+
+import java.io.*;
+import java.lang.reflect.Type;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.github.imifou.jsonschema.module.addon.AddonModule;
+import com.github.victools.jsonschema.generator.*;
+
+import eu.dnetlib.dhp.schema.dump.oaf.community.CommunityResult;
+import eu.dnetlib.dhp.schema.dump.oaf.graph.*;
+
+public class ExecCreateSchemas {
+ final static String DIRECTORY = "/eu/dnetlib/dhp/schema/oaf/dump/jsonschemas/";
+ SchemaGenerator generator;
+
+ private void init(){
+
+ AddonModule module = new AddonModule();
+ SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(
+ new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT),
+ SchemaVersion.DRAFT_7,
+ OptionPreset.PLAIN_JSON)
+ .with(module)
+ .with(Option.SCHEMA_VERSION_INDICATOR)
+ .without(Option.NONPUBLIC_NONSTATIC_FIELDS_WITHOUT_GETTERS);
+ SchemaGeneratorConfig config = configBuilder.build();
+ generator = new SchemaGenerator(config);
+ }
+
+ private void generate(Type targetType, String directory, String filename) throws IOException {
+ JsonNode jsonSchema = generator.generateSchema(targetType);
+
+ String dir = Paths.get(Paths.get(getClass().getResource("/").getPath()).toAbsolutePath() + directory).toString();
+
+ if(!Files.exists(Paths.get(dir))){
+ Files.createDirectories(Paths.get(dir));
+ }
+
+ if(!Files.exists(Paths.get(dir + "/" + filename))) {
+ Files.createFile(Paths.get(dir + "/" + filename));
+ }
+
+ File f = new File(dir + "/" + filename);
+
+ try(PrintWriter writer = new PrintWriter(new BufferedWriter(new FileWriter(f)))) {
+ writer.println(new ObjectMapper().writerWithDefaultPrettyPrinter().writeValueAsString(jsonSchema));
+ }
+
+
+ }
+ public static void main(String[] args) throws IOException {
+
+ ExecCreateSchemas ecs = new ExecCreateSchemas();
+ ecs.init();
+ ecs.generate(GraphResult.class, DIRECTORY , "result_schema.json");
+ ecs.generate(ResearchCommunity.class, DIRECTORY , "community_infrastructure_schema.json");
+ ecs.generate(Datasource.class, DIRECTORY , "datasource_schema.json");
+ ecs.generate(Project.class, DIRECTORY , "project_schema.json");
+ ecs.generate(Relation.class, DIRECTORY , "relation_schema.json");
+ ecs.generate(Organization.class, DIRECTORY , "organization_schema.json");
+
+ ecs.generate(CommunityResult.class, DIRECTORY , "community_result_schema.json");
+
+
+
+
+
+ }
+}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AlternateIdentifier.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AlternateIdentifier.java
new file mode 100644
index 0000000..e48a564
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AlternateIdentifier.java
@@ -0,0 +1,40 @@
+package eu.dnetlib.dhp.schema.dump.oaf;
+
+import java.io.Serializable;
+
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
+public class AlternateIdentifier implements Serializable {
+ @JsonSchema(description="The scheme of the identifier. It can be a persistent identifier (i.e. doi). If it is present in the alternate identifiers " +
+ "it means it has not been forged by an authority for that pid. For example we collect metadata from an institutional repository that provides " +
+ "as identifier for the result also the doi")
+ private String scheme;
+
+ @JsonSchema(description="The value expressed in the scheme")
+ private String value;
+
+ public String getScheme() {
+ return scheme;
+ }
+
+ public void setScheme(String scheme) {
+ this.scheme = scheme;
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ public void setValue(String value) {
+ this.value = value;
+ }
+
+ public static AlternateIdentifier newInstance(String scheme, String value) {
+ AlternateIdentifier cf = new AlternateIdentifier();
+
+ cf.setScheme(scheme);
+ cf.setValue(value);
+
+ return cf;
+ }
+}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Author.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Author.java
index ef035a1..c26bdd2 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Author.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Author.java
@@ -3,6 +3,8 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
* 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
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AuthorPid.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AuthorPid.java
new file mode 100644
index 0000000..e77a078
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AuthorPid.java
@@ -0,0 +1,54 @@
+
+package eu.dnetlib.dhp.schema.dump.oaf;
+
+import java.io.Serializable;
+
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
+/**
+ * To represent the generic persistent identifier. It has two parameters:
+ * - id of type
+ * eu.dnetlib.dhp.schema.dump.oaf.AuthorPidSchemeValue 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 AuthorPid implements Serializable {
+
+ private AuthorPidSchemeValue id;
+
+ @JsonSchema(description="The reason why the pid was associated to the author")
+ private Provenance provenance;
+
+ public AuthorPidSchemeValue getId() {
+ return id;
+ }
+
+ public void setId(AuthorPidSchemeValue pid) {
+ this.id = pid;
+ }
+
+ public Provenance getProvenance() {
+ return provenance;
+ }
+
+ public void setProvenance(Provenance provenance) {
+ this.provenance = provenance;
+ }
+
+ public static AuthorPid newInstance(AuthorPidSchemeValue pid, Provenance provenance) {
+ AuthorPid p = new AuthorPid();
+ p.id = pid;
+ p.provenance = provenance;
+
+ return p;
+ }
+
+ public static AuthorPid newInstance(AuthorPidSchemeValue pid) {
+ AuthorPid p = new AuthorPid();
+ p.id = pid;
+
+ return p;
+ }
+
+
+}
+
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AuthorPidSchemeValue.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AuthorPidSchemeValue.java
new file mode 100644
index 0000000..3e22c9f
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/AuthorPidSchemeValue.java
@@ -0,0 +1,39 @@
+package eu.dnetlib.dhp.schema.dump.oaf;
+
+import java.io.Serializable;
+
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
+public class AuthorPidSchemeValue implements Serializable {
+
+ @JsonSchema(description="The author's pid scheme. OpenAIRE currently supports 'ORCID'")
+ private String scheme;
+
+ @JsonSchema(description="The author's pid value in that scheme (i.e. 0000-1111-2222-3333)")
+ private String value;
+
+ public String getScheme() {
+ return scheme;
+ }
+
+ public void setScheme(String scheme) {
+ this.scheme = scheme;
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ public void setValue(String value) {
+ this.value = value;
+ }
+
+ public static AuthorPidSchemeValue newInstance(String scheme, String value) {
+ AuthorPidSchemeValue cf = new AuthorPidSchemeValue();
+
+ cf.setScheme(scheme);
+ cf.setValue(value);
+
+ return cf;
+ }
+}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/BestAccessRight.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/BestAccessRight.java
index 71a3c34..6ae9b54 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/BestAccessRight.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/BestAccessRight.java
@@ -1,16 +1,26 @@
package eu.dnetlib.dhp.schema.dump.oaf;
+import java.io.Serializable;
+
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
- * BestAccessRight. Used to represent the result best 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
+ * BestAccessRight. Used to represent the result best access rights. 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 BestAccessRight extends Qualifier {
+public class BestAccessRight implements Serializable {
+ @JsonSchema(description="COAR access mode code: http://vocabularies.coar-repositories.org/documentation/access_rights/")
+ private String code; // the classid in the Qualifier
+
+ @JsonSchema(description="Label for the access mode")
+ private String label; // the classname in the Qualifier
+
+ @JsonSchema(description="Scheme of reference for access right code. Always set to COAR access rights vocabulary: http://vocabularies.coar-repositories.org/documentation/access_rights/")
private String scheme;
public String getScheme() {
@@ -21,11 +31,29 @@ public class BestAccessRight extends Qualifier {
this.scheme = scheme;
}
+ public String getCode() {
+ return code;
+ }
+
+ public void setCode(String code) {
+ this.code = code;
+ }
+
+ public String getLabel() {
+ return label;
+ }
+
+ public void setLabel(String label) {
+ this.label = label;
+ }
+
+
public static BestAccessRight newInstance(String code, String label, String scheme) {
BestAccessRight ar = new BestAccessRight();
- ar.setCode(code);
- ar.setLabel(label);
- ar.setScheme(scheme);
+ ar.code = code ;
+ ar.label = label;
+ ar.scheme = scheme;
return ar;
}
}
+
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Container.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Container.java
index ad9ea48..bef5f74 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Container.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Container.java
@@ -3,6 +3,8 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
* 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
@@ -22,6 +24,7 @@ import java.io.Serializable;
*/
public class Container implements Serializable {
+ @JsonSchema(description="Name of the journal or conference")
private String name;
private String issnPrinted;
@@ -30,14 +33,19 @@ public class Container implements Serializable {
private String issnLinking;
+ @JsonSchema(description="End page")
private String ep;
+ @JsonSchema(description="Journal issue number")
private String iss;
+ @JsonSchema(description="Start page")
private String sp;
+ @JsonSchema(description = "Volume")
private String vol;
+ @JsonSchema(description="Edition of the journal or conference proceeding")
private String edition;
private String conferenceplace;
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Country.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Country.java
index 3ab4d90..0cf58b3 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Country.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Country.java
@@ -1,8 +1,12 @@
package eu.dnetlib.dhp.schema.dump.oaf;
+import java.io.Serializable;
+
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
- * Represents the country associated to this result. It extends eu.dnetlib.dhp.schema.dump.oaf.Qualifier with a
+ * Represents the country associated to the generic entity. 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
@@ -10,28 +14,36 @@ package eu.dnetlib.dhp.schema.dump.oaf;
* 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 {
+public class Country implements Serializable {
+ @JsonSchema(description="ISO 3166-1 alpha-2 country code (i.e. IT)")
+ private String code; // the classid in the Qualifier
- private Provenance provenance;
+ @JsonSchema(description="The label for that code (i.e. Italy)")
+ private String label; // the classname in the Qualifier
- public Provenance getProvenance() {
- return provenance;
+ public String getCode() {
+ return code;
}
- public void setProvenance(Provenance provenance) {
- this.provenance = provenance;
+ public void setCode(String code) {
+ this.code = code;
}
- public static Country newInstance(String code, String label, Provenance provenance) {
+ public String getLabel() {
+ return label;
+ }
+
+ public void setLabel(String label) {
+ this.label = label;
+ }
+
+ public static Country newInstance(String code, String label) {
Country c = new Country();
- c.setProvenance(provenance);
c.setCode(code);
c.setLabel(label);
return c;
}
- public static Country newInstance(String code, String label, String provenance, String trust) {
- return newInstance(code, label, Provenance.newInstance(provenance, trust));
- }
+
}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Funder.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Funder.java
index 16cab22..674b8b3 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Funder.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Funder.java
@@ -3,11 +3,17 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
public class Funder implements Serializable {
+
+ @JsonSchema(description = "The short name of the funder (EC)")
private String shortName;
+ @JsonSchema(description = "The name of the funder (European Commission)")
private String name;
+ @JsonSchema(description = "Geographical jurisdiction (e.g. for European Commission is EU, for Croatian Science Foundation is HR)")
private String jurisdiction;
public String getJurisdiction() {
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Instance.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Instance.java
index a13af02..b8b2fbc 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Instance.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Instance.java
@@ -1,8 +1,14 @@
+
package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
import java.util.List;
+import org.apache.commons.lang3.StringUtils;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
* 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
@@ -22,24 +28,37 @@ import java.util.List;
*/
public class Instance implements Serializable {
- private List measures;
+ @JsonSchema(description = "Measures computed for this instance, for example Bip!Finder ones")
+ private List measures;
- private List pid;
+ private List pid;
- private List alternateIdentifier;
+ @JsonSchema(description = "All the identifiers other than pids forged by an authorithy for the pid type (i.e. Crossref for DOIs")
+ private List alternateIdentifier;
private String license;
+ @JsonSchema(description = "The accessRights for this materialization of the result")
private AccessRight accessright;
+ @JsonSchema(description = "The specific sub-type of this instance (see https://api.openaire.eu/vocabularies/dnet:result_typologies following the links)")
private String type;
+ @JsonSchema(description = "URLs to the instance. They may link to the actual full-text or to the landing page at the hosting source. ")
private List url;
+ @JsonSchema(description = "The money spent to make this book or article available in Open Access. Source for this information is the OpenAPC initiative.")
private APC articleprocessingcharge;
+ @JsonSchema(description = "Date of the research product")
private String publicationdate;// dateofacceptance;
+
+ @JsonSchema(description = "If this instance has been peer-reviewed or not. Allowed values are peerReviewed, " +
+ "nonPeerReviewed, UNKNOWN (as defined in https://api.openaire.eu/vocabularies/dnet:review_levels)")
private String refereed; // peer-review status
+
+
+
public String getLicense() {
return license;
}
@@ -96,27 +115,30 @@ public class Instance implements Serializable {
this.articleprocessingcharge = articleprocessingcharge;
}
- public List getPid() {
+ public List getPid() {
return pid;
}
- public void setPid(List pid) {
+ public void setPid(List pid) {
this.pid = pid;
}
- public List getAlternateIdentifier() {
+ public List getAlternateIdentifier() {
return alternateIdentifier;
}
- public void setAlternateIdentifier(List alternateIdentifier) {
+ public void setAlternateIdentifier(List alternateIdentifier) {
this.alternateIdentifier = alternateIdentifier;
}
- public List getMeasures() {
+ public List getMeasures() {
return measures;
}
- public void setMeasures(List measures) {
+ public void setMeasures(List measures) {
this.measures = measures;
}
-}
\ No newline at end of file
+}
+
+
+
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/KeyValue.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/KeyValue.java
deleted file mode 100644
index 849aa4d..0000000
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/KeyValue.java
+++ /dev/null
@@ -1,48 +0,0 @@
-
-package eu.dnetlib.dhp.schema.dump.oaf;
-
-import java.io.Serializable;
-
-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)
- */
-public class KeyValue implements Serializable {
-
- private String key;
-
- private String value;
-
- public String getKey() {
- return key;
- }
-
- public void setKey(String key) {
- this.key = key;
- }
-
- public String getValue() {
- return value;
- }
-
- public void setValue(String value) {
- this.value = value;
- }
-
- public static KeyValue newInstance(String key, String value) {
- KeyValue inst = new KeyValue();
- inst.key = key;
- inst.value = value;
- return inst;
- }
-
- @JsonIgnore
- public boolean isBlank() {
- return StringUtils.isBlank(key) && StringUtils.isBlank(value);
- }
-
-}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Language.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Language.java
new file mode 100644
index 0000000..6d4de35
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Language.java
@@ -0,0 +1,37 @@
+package eu.dnetlib.dhp.schema.dump.oaf;
+
+import java.io.Serializable;
+
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
+public class Language implements Serializable {
+
+ @JsonSchema(description="alpha-3/ISO 639-2 code of the language")
+ private String code; // the classid in the Qualifier
+
+ @JsonSchema(description="Language label in English")
+ private String label; // the classname in the Qualifier
+
+ public String getCode() {
+ return code;
+ }
+
+ public void setCode(String code) {
+ this.code = code;
+ }
+
+ public String getLabel() {
+ return label;
+ }
+
+ public void setLabel(String label) {
+ this.label = label;
+ }
+
+ public static Language newInstance(String code, String value) {
+ Language qualifier = new Language();
+ qualifier.setCode(code);
+ qualifier.setLabel(value);
+ return qualifier;
+ }
+}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Measure.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Measure.java
new file mode 100644
index 0000000..4c86001
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Measure.java
@@ -0,0 +1,45 @@
+package eu.dnetlib.dhp.schema.dump.oaf;
+
+import java.io.Serializable;
+
+import org.apache.commons.lang3.StringUtils;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
+public class Measure implements Serializable {
+ @JsonSchema(description = "The measure (i.e. popularity)")
+ private String key;
+
+ @JsonSchema(description = "The value for that measure")
+ private String value;
+
+ public String getKey() {
+ return key;
+ }
+
+ public void setKey(String key) {
+ this.key = key;
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ public void setValue(String value) {
+ this.value = value;
+ }
+
+ public static Measure newInstance(String key, String value) {
+ Measure inst = new Measure();
+ inst.key = key;
+ inst.value = value;
+ return inst;
+ }
+
+ @JsonIgnore
+ public boolean isBlank() {
+ return StringUtils.isBlank(key) && StringUtils.isBlank(value);
+ }
+
+}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Project.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Project.java
index 00cd7a0..fc7472b 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Project.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Project.java
@@ -3,6 +3,8 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
* This class to store the common information about the project that will be dumped for community and for the whole
* graph - private String id to store the id of the project (OpenAIRE id) - private String code to store the grant
@@ -10,9 +12,13 @@ import java.io.Serializable;
* the tile of the project
*/
public class Project implements Serializable {
+ @JsonSchema(description = "The OpenAIRE id for the project")
protected String id;// OpenAIRE id
+
+ @JsonSchema(description = "The grant agreement number")
protected String code;
+ @JsonSchema(description = "The acronym of the project")
protected String acronym;
protected String title;
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Provenance.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Provenance.java
index 28fb3aa..2870ba5 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Provenance.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Provenance.java
@@ -3,6 +3,8 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
* 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
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Result.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Result.java
index e5ee9b2..c7d2d22 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Result.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Result.java
@@ -4,6 +4,8 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
import java.util.List;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
* 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
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/ResultCountry.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/ResultCountry.java
new file mode 100644
index 0000000..df2650b
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/ResultCountry.java
@@ -0,0 +1,40 @@
+package eu.dnetlib.dhp.schema.dump.oaf;
+
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
+/**
+ * Represents the country associated to the generic result. It extends eu.dnetlib.dhp.schema.dump.oaf.Country with a
+ * provenance parameter of type eu.dnetlib.dhp.schema.dumo.oaf.Provenance. The country is 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 ResultCountry extends Country {
+
+ @JsonSchema(description="Why this result is associated to the country.")
+ private Provenance provenance;
+
+ public Provenance getProvenance() {
+ return provenance;
+ }
+
+ public void setProvenance(Provenance provenance) {
+ this.provenance = provenance;
+ }
+
+ public static ResultCountry newInstance(String code, String label, Provenance provenance) {
+ ResultCountry c = new ResultCountry();
+ c.setProvenance(provenance);
+ c.setCode(code);
+ c.setLabel(label);
+ return c;
+ }
+
+ public static ResultCountry newInstance(String code, String label, String provenance, String trust) {
+ return newInstance(code, label, Provenance.newInstance(provenance, trust));
+ }
+}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/ResultPid.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/ResultPid.java
new file mode 100644
index 0000000..f95d06e
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/ResultPid.java
@@ -0,0 +1,41 @@
+package eu.dnetlib.dhp.schema.dump.oaf;
+
+import java.io.Serializable;
+
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
+public class ResultPid implements Serializable {
+ @JsonSchema(description="The scheme of the persistent identifier for the result (i.e. doi). " +
+ "If the pid is here it means the information for the pid has been collected from an authority for " +
+ "that pid type (i.e. Crossref/Datacite for doi). The set of authoritative pid is: doi when collected from Crossref or Datacite " +
+ "pmid when collected from EuroPubmed, arxiv when collected from arXiv, handle from the repositories")
+ private String scheme;
+
+ @JsonSchema(description="The value expressed in the scheme (i.e. 10.1000/182)")
+ private String value;
+
+ public String getScheme() {
+ return scheme;
+ }
+
+ public void setScheme(String scheme) {
+ this.scheme = scheme;
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ public void setValue(String value) {
+ this.value = value;
+ }
+
+ public static ResultPid newInstance(String scheme, String value) {
+ ResultPid cf = new ResultPid();
+
+ cf.setScheme(scheme);
+ cf.setValue(value);
+
+ return cf;
+ }
+}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Subject.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Subject.java
index 5c4bbef..204e37a 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Subject.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/Subject.java
@@ -3,6 +3,8 @@ package eu.dnetlib.dhp.schema.dump.oaf;
import java.io.Serializable;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
* 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
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/SubjectSchemeValue.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/SubjectSchemeValue.java
new file mode 100644
index 0000000..9228088
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/SubjectSchemeValue.java
@@ -0,0 +1,39 @@
+package eu.dnetlib.dhp.schema.dump.oaf;
+
+import java.io.Serializable;
+
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
+public class SubjectSchemeValue implements Serializable {
+ @JsonSchema(description="OpenAIRE subject classification scheme (https://api.openaire.eu/vocabularies/dnet:subject_classification_typologies).")
+ private String scheme;
+
+ @JsonSchema(description="The value for the subject in the selected scheme. When the scheme is 'keyword', it means that the subject is free-text (i.e. not a term from a controlled vocabulary).")
+ private String value;
+
+ public String getScheme() {
+ return scheme;
+ }
+
+ public void setScheme(String scheme) {
+ this.scheme = scheme;
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ public void setValue(String value) {
+ this.value = value;
+ }
+
+ public static SubjectSchemeValue newInstance(String scheme, String value) {
+ SubjectSchemeValue cf = new SubjectSchemeValue();
+
+ cf.setScheme(scheme);
+ cf.setValue(value);
+
+ return cf;
+ }
+
+}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CfHbKeyValue.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CfHbKeyValue.java
new file mode 100644
index 0000000..68bda2d
--- /dev/null
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CfHbKeyValue.java
@@ -0,0 +1,46 @@
+package eu.dnetlib.dhp.schema.dump.oaf.community;
+
+import java.io.Serializable;
+
+import org.apache.commons.lang3.StringUtils;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
+public class CfHbKeyValue implements Serializable {
+
+ @JsonSchema(description = "the OpenAIRE identifier of the data source")
+ private String key;
+
+ @JsonSchema(description = "the name of the data source")
+ private String value;
+
+ public String getKey() {
+ return key;
+ }
+
+ public void setKey(String key) {
+ this.key = key;
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ public void setValue(String value) {
+ this.value = value;
+ }
+
+ public static CfHbKeyValue newInstance(String key, String value) {
+ CfHbKeyValue inst = new CfHbKeyValue();
+ inst.key = key;
+ inst.value = value;
+ return inst;
+ }
+
+ @JsonIgnore
+ public boolean isBlank() {
+ return StringUtils.isBlank(key) && StringUtils.isBlank(value);
+ }
+
+}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityInstance.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityInstance.java
index 6a605d7..5e5a87e 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityInstance.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityInstance.java
@@ -1,8 +1,9 @@
package eu.dnetlib.dhp.schema.dump.oaf.community;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
import eu.dnetlib.dhp.schema.dump.oaf.Instance;
-import eu.dnetlib.dhp.schema.dump.oaf.KeyValue;
/**
* It extends eu.dnetlib.dhp.dump.oaf.Instance with values related to the community dump. In the Result dump this
@@ -15,22 +16,25 @@ import eu.dnetlib.dhp.schema.dump.oaf.KeyValue;
* collectedfrom.key - value corresponds to collectedfrom.value
*/
public class CommunityInstance extends Instance {
- private KeyValue hostedby;
- private KeyValue collectedfrom;
+ @JsonSchema(description = "Information about the source from which the instance can be viewed or downloaded.")
+ private CfHbKeyValue hostedby;
- public KeyValue getHostedby() {
+ @JsonSchema(description = "Information about the source from which the record has been collected")
+ private CfHbKeyValue collectedfrom;
+
+ public CfHbKeyValue getHostedby() {
return hostedby;
}
- public void setHostedby(KeyValue hostedby) {
+ public void setHostedby(CfHbKeyValue hostedby) {
this.hostedby = hostedby;
}
- public KeyValue getCollectedfrom() {
+ public CfHbKeyValue getCollectedfrom() {
return collectedfrom;
}
- public void setCollectedfrom(KeyValue collectedfrom) {
+ public void setCollectedfrom(CfHbKeyValue collectedfrom) {
this.collectedfrom = collectedfrom;
}
}
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityResult.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityResult.java
index d32247f..9decf82 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityResult.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/CommunityResult.java
@@ -5,7 +5,6 @@ import java.util.List;
import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
-import eu.dnetlib.dhp.schema.dump.oaf.KeyValue;
import eu.dnetlib.dhp.schema.dump.oaf.Result;
/**
@@ -22,11 +21,14 @@ import eu.dnetlib.dhp.schema.dump.oaf.Result;
*/
public class CommunityResult extends Result {
+ @JsonSchema(description = "List of projects (i.e. grants) that (co-)funded the production ofn the research results")
private List projects;
+ @JsonSchema(description = "Reference to a relevant research infrastructure, initiative or community (RI/RC) among those collaborating with OpenAIRE. Please see https://connect.openaire.eu")
private List context;
- protected List collectedfrom;
+ @JsonSchema(description = "Information about the sources from which the record has been collected")
+ protected List collectedfrom;
@JsonSchema(description = "Each instance is one specific materialisation or version of the result. For example, you can have one result with three instance: one is the pre-print, one is the post-print, one is te published version")
private List instance;
@@ -39,11 +41,11 @@ public class CommunityResult extends Result {
this.instance = instance;
}
- public List getCollectedfrom() {
+ public List getCollectedfrom() {
return collectedfrom;
}
- public void setCollectedfrom(List collectedfrom) {
+ public void setCollectedfrom(List collectedfrom) {
this.collectedfrom = collectedfrom;
}
@@ -64,3 +66,5 @@ public class CommunityResult extends Result {
}
}
+
+
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Context.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Context.java
index d4c1d40..79c1647 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Context.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Context.java
@@ -6,8 +6,9 @@ import java.util.Objects;
import java.util.Optional;
import java.util.stream.Collectors;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
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
@@ -21,7 +22,14 @@ import eu.dnetlib.dhp.schema.dump.oaf.Qualifier;
* 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 {
+public class Context {
+ @JsonSchema(description="Code identifying the RI/RC")
+ private String code;
+
+ @JsonSchema(description="Label of the RI/RC")
+ private String label;
+
+ @JsonSchema(description = "Why this result is associated to the RI/RC.")
private List provenance;
public List getProvenance() {
@@ -32,6 +40,23 @@ public class Context extends Qualifier {
this.provenance = provenance;
}
+ public String getCode() {
+ return code;
+ }
+
+ public void setCode(String code) {
+ this.code = code;
+ }
+
+ public String getLabel() {
+ return label;
+ }
+
+ public void setLabel(String label) {
+ this.label = label;
+ }
+
+
@Override
public int hashCode() {
final String p = Optional.ofNullable(getProvenance())
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Funder.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Funder.java
index 5ea0d12..5e17e0c 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Funder.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Funder.java
@@ -1,6 +1,8 @@
package eu.dnetlib.dhp.schema.dump.oaf.community;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
/**
* 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
@@ -9,6 +11,7 @@ package eu.dnetlib.dhp.schema.dump.oaf.community;
*/
public class Funder extends eu.dnetlib.dhp.schema.dump.oaf.Funder {
+ @JsonSchema(description = "Stream of funding (e.g. for European Commission can be H2020 or FP7)")
private String fundingStream;
public String getFundingStream() {
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Project.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Project.java
index eed0ae8..88c5216 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Project.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/community/Project.java
@@ -1,6 +1,8 @@
package eu.dnetlib.dhp.schema.dump.oaf.community;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
import eu.dnetlib.dhp.schema.dump.oaf.Provenance;
/**
@@ -13,6 +15,7 @@ import eu.dnetlib.dhp.schema.dump.oaf.Provenance;
*/
public class Project extends eu.dnetlib.dhp.schema.dump.oaf.Project {
+ @JsonSchema(description = "Information about the funder funding the project")
private Funder funder;
private Provenance provenance;
diff --git a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Datasource.java b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Datasource.java
index 62a32a0..3c2a7b3 100644
--- a/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Datasource.java
+++ b/src/main/java/eu/dnetlib/dhp/schema/dump/oaf/graph/Datasource.java
@@ -4,8 +4,9 @@ package eu.dnetlib.dhp.schema.dump.oaf.graph;
import java.io.Serializable;
import java.util.List;
+import com.github.imifou.jsonschema.module.addon.annotation.JsonSchema;
+
import eu.dnetlib.dhp.schema.dump.oaf.Container;
-import eu.dnetlib.dhp.schema.dump.oaf.ControlledField;
/**
* To store information about the datasource OpenAIRE collects information from. It contains the following parameters: -
@@ -33,70 +34,91 @@ import eu.dnetlib.dhp.schema.dump.oaf.ControlledField;
* datasource. It corresponds to description.value of the datasource represented in the internal model
*/
public class Datasource implements Serializable {
-
+ @JsonSchema(description = "The OpenAIRE id of the data source")
private String id; // string
+ @JsonSchema(description = "Original identifiers for the datasource")
private List originalId; // list string
- private List pid; // list
+ @JsonSchema(description = "Persistent identifiers of the datasource")
+ private List pid; // list
- private ControlledField datasourcetype; // value
+ @JsonSchema(description = "The type of the datasource. See https://api.openaire.eu/vocabularies/dnet:datasource_typologies")
+ private DatasourceSchemeValue datasourcetype; // value
+ @JsonSchema(description = "OpenAIRE guidelines the data source comply with. See also https://guidelines.openaire.eu.")
private String openairecompatibility; // value
+ @JsonSchema(description = "The official name of the datasource")
private String officialname; // string
+ @JsonSchema(description = "The English name of the datasource")
private String englishname; // string
private String websiteurl; // string
private String logourl; // string
+ @JsonSchema(description = "The date of last validation against the OpenAIRE guidelines for the datasource records")
private String dateofvalidation; // string
private String description; // description
+ @JsonSchema(description = "List of subjects associated to the datasource")
private List subjects; // List
// opendoar specific fields (od*)
+ @JsonSchema(description = "The languages present in the data source's content, as defined by OpenDOAR.")
private List languages; // odlanguages List
+ @JsonSchema(description = "Types of content in the data source, as defined by OpenDOAR")
private List contenttypes; // odcontent types List
// re3data fields
+ @JsonSchema(description = "Releasing date of the data source, as defined by re3data.org")
private String releasestartdate; // string
+ @JsonSchema(description = "Date when the data source went offline or stopped ingesting new research data. As defined by re3data.org")
private String releaseenddate; // string
+ @JsonSchema(description = "The URL of a mission statement describing the designated community of the data source. As defined by re3data.org")
private String missionstatementurl; // string
- // {open, restricted or closed}
+ @JsonSchema(description = "Type of access to the data source, as defined by re3data.org. Possible values: " +
+ "{open, restricted, closed}")
private String accessrights; // databaseaccesstype string
// {open, restricted or closed}
+ @JsonSchema(description = "Type of data upload. As defined by re3data.org: one of {open, restricted,closed}")
private String uploadrights; // datauploadtype string
- // {feeRequired, registration, other}
+ @JsonSchema(description = "Access restrinctions to the data source, as defined by re3data.org. One of {feeRequired, registration, other}")
private String databaseaccessrestriction; // string
- // {feeRequired, registration, other}
+ @JsonSchema(description = "Upload restrictions applied by the datasource, as defined by re3data.org. One of {feeRequired, registration, other}")
private String datauploadrestriction; // string
+ @JsonSchema(description = "As defined by redata.org: 'yes' if the data source supports versioning, 'no' otherwise.")
private Boolean versioning; // boolean
+ @JsonSchema(description = "The URL of the data source providing information on how to cite its items. As defined by re3data.org.")
private String citationguidelineurl; // string
// {yes, no, uknown}
-
+ @JsonSchema(description = "The persistent identifier system that is used by the data source. As defined by re3data.org")
private String pidsystems; // string
+ @JsonSchema(description = "The certificate, seal or standard the data source complies with. As defined by re3data.org.")
private String certificates; // string
- private List