added descriptions

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

@@ -3,6 +3,11 @@ 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
+ */
 public class APC implements Serializable {
 	private String currency;
 	private String amount;

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

@@ -1,6 +1,14 @@
 
 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
+ */
 public class AccessRight extends Qualifier {
 
 	private String scheme;

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

@@ -4,6 +4,25 @@ package eu.dnetlib.dhp.schema.dump.oaf;
 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
+ */
 public class Author implements Serializable {
 
 	private String fullname;

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

@@ -4,6 +4,24 @@ package eu.dnetlib.dhp.schema.dump.oaf;
 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
+ */
 public class Container implements Serializable {
 
 	private String name;

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

@@ -3,8 +3,12 @@ package eu.dnetlib.dhp.schema.dump.oaf;
 
 import java.io.Serializable;
 
-import eu.dnetlib.dhp.schema.oaf.StructuredProperty;
+/**
-
+ * 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;
 	private String value;

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

@@ -1,6 +1,16 @@
 
 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
+ */
 public class Country extends Qualifier {
 
 	private Provenance provenance;

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

@@ -7,6 +7,12 @@ 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
+ */
 public class GeoLocation implements Serializable {
 
 	private String point;

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

@@ -4,6 +4,22 @@ package eu.dnetlib.dhp.schema.dump.oaf;
 import java.io.Serializable;
 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 isntance to be dumped
+ * - accessright of type eu.dnetlib.dhp.schema.dump.oaf.AccessRight to store the accessright of the instance. It is mapped as specified above
+ * - 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 agaist 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 {
 
 	private String license;

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

@@ -7,6 +7,11 @@ 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;

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

@@ -3,6 +3,11 @@ 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
+ */
 public class Pid implements Serializable {
 	private ControlledField id;
 	private Provenance provenance;

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

@@ -3,6 +3,11 @@ 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
+ */
 public class Provenance implements Serializable {
 	private String provenance;
 	private String trust;

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

@@ -7,6 +7,11 @@ 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
+ */
 public class Qualifier implements Serializable {
 
 	private String code; // the classid in the Qualifier

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

@@ -6,6 +6,48 @@ 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 is applied a dump as described previously
+ * - 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 as described above
+ * - 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
+ * - 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 and it is dumped as descriveb above
+ * - externalReference of type List<ExternalReference>. It will not be described here. ExternalReference to be changed in the mapping
+ * - 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
+ * - 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
+ * - 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 produces ad described above
+ * - 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 {
 
 	private List<Author> author;

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

@@ -3,6 +3,16 @@ 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
+ */
 public class Subject implements Serializable {
 	private ControlledField subject;
 	private Provenance provenance;