Merge pull request 'Align Solr JSON records to the explore portal requirements' (#38) from solr_json_model into master

Reviewed-on: #38

CHANGES.md

@@ -4,6 +4,7 @@
 
 | **Version** | **Changes**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | **Readiness** |
 |-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| 6.1.1       | [Graph model] </br> <ul><li>Introduced constants used in the DOIBoost dismission.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | beta          |
 | 6.1.0       | [Graph model] </br> <ul><li>Introduced model classes to provide a JSON representation of records embedding information from the related entities.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | beta          |
 | 5.17.3      | [Graph model] </br> <ul><li>added result level textual field to store the transformative agreement information.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | beta          |
 | 4.17.3      | [Graph model] </br> <ul><li>moved context at the level of the entity. </li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | beta          |

pom.xml

@@ -5,7 +5,7 @@
     <groupId>eu.dnetlib.dhp</groupId>
     <artifactId>dhp-schemas</artifactId>
     <packaging>jar</packaging>
-    <version>6.1.1-SNAPSHOT</version>
+    <version>6.1.3-SNAPSHOT</version>
 
     <licenses>
         <license>

src/main/java/eu/dnetlib/dhp/schema/oaf/AccessRight.java

@@ -1,15 +1,13 @@
 
 package eu.dnetlib.dhp.schema.oaf;
 
-import java.util.Objects;
-import java.util.Optional;
-
 /**
  * This class models the access rights of research products.
  */
 public class AccessRight extends Qualifier {
 
 	private static final long serialVersionUID = -8945177777173510134L;
+
 	private OpenAccessRoute openAccessRoute;
 
 	public OpenAccessRoute getOpenAccessRoute() {

src/main/java/eu/dnetlib/dhp/schema/oaf/Context.java

@@ -3,7 +3,6 @@ package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
 import java.util.List;
-import java.util.Objects;
 
 public class Context implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/DataInfo.java

@@ -2,7 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
 
 public class DataInfo implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/EoscIfGuidelines.java

@@ -1,12 +1,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
-import java.util.Optional;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-
-import org.apache.commons.lang3.StringUtils;
 
 /**
  * Describes a reference to the EOSC Interoperability Framework (IF) Guidelines

src/main/java/eu/dnetlib/dhp/schema/oaf/ExternalReference.java

@@ -3,7 +3,6 @@ package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
 import java.util.List;
-import java.util.Objects;
 
 public class ExternalReference implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/ExtraInfo.java

@@ -2,7 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
 
 public class ExtraInfo implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/GeoLocation.java

@@ -2,11 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
-
-import org.apache.commons.lang3.StringUtils;
-
-import com.fasterxml.jackson.annotation.JsonIgnore;
 
 public class GeoLocation implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/H2020Classification.java

@@ -2,7 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
 
 /**
  * To store information about the classification for the project. The classification depends on the programme. For example

src/main/java/eu/dnetlib/dhp/schema/oaf/H2020Programme.java

@@ -2,7 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
 
 /**
  * To store information about the ec programme for the project. It has the following parameters:

src/main/java/eu/dnetlib/dhp/schema/oaf/Instance.java

@@ -3,9 +3,6 @@ package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
 import java.util.List;
-import java.util.Optional;
-
-import com.google.common.base.Joiner;
 
 public class Instance implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/Journal.java

@@ -2,7 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
 
 public class Journal implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/KeyValue.java

@@ -2,13 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
-import java.util.Optional;
-
-import org.apache.commons.lang3.StringUtils;
-
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.google.common.base.Joiner;
 
 public class KeyValue implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/Measure.java

@@ -4,8 +4,6 @@ package eu.dnetlib.dhp.schema.oaf;
 import java.io.Serializable;
 import java.util.List;
 
-import com.google.common.base.Objects;
-
 /**
  * Represent a measure, must be further described by a system available resource providing name and descriptions.
  */

src/main/java/eu/dnetlib/dhp/schema/oaf/OAIProvenance.java

@@ -2,7 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
 
 public class OAIProvenance implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/Oaf.java

@@ -2,12 +2,7 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Collection;
 import java.util.List;
-import java.util.Objects;
-import java.util.Optional;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
 public abstract class Oaf implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/OafEntity.java

@@ -3,7 +3,6 @@ package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
 import java.util.*;
-import java.util.stream.Collectors;
 
 public abstract class OafEntity extends Oaf implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/Organization.java

@@ -6,6 +6,10 @@ import java.util.List;
 
 public class Organization extends OafEntity implements Serializable {
 
+	public enum OrganizationType {
+		Archive, Company, Education, Facility, Government, Healthcare, Nonprofit, Other, Unknown
+	}
+
 	private static final long serialVersionUID = -9048723860770504113L;
 
 	private Field<String> legalshortname;
@@ -40,6 +44,8 @@ public class Organization extends OafEntity implements Serializable {
 
 	private Qualifier country;
 
+	private OrganizationType organizationType;
+
 	public Field<String> getLegalshortname() {
 		return legalshortname;
 	}
@@ -169,4 +175,11 @@ public class Organization extends OafEntity implements Serializable {
 		this.country = country;
 	}
 
+	public OrganizationType getOrganizationType() {
+		return organizationType;
+	}
+
+	public void setOrganizationType(OrganizationType organizationType) {
+		this.organizationType = organizationType;
+	}
 }

src/main/java/eu/dnetlib/dhp/schema/oaf/OriginDescription.java

@@ -2,7 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
 
 public class OriginDescription implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/oaf/Project.java

@@ -4,8 +4,6 @@ package eu.dnetlib.dhp.schema.oaf;
 import java.io.Serializable;
 import java.util.List;
 
-import org.apache.commons.lang3.StringUtils;
-
 public class Project extends OafEntity implements Serializable {
 
 	private static final long serialVersionUID = 5783959097903529424L;

src/main/java/eu/dnetlib/dhp/schema/oaf/Qualifier.java

@@ -2,12 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
-import java.util.Optional;
-
-import org.apache.commons.lang3.builder.EqualsBuilder;
-
-import com.google.common.base.Joiner;
 
 public class Qualifier implements Serializable {
 	private static final long serialVersionUID = 6632548656644563076L;

src/main/java/eu/dnetlib/dhp/schema/oaf/Relation.java

@@ -1,15 +1,10 @@
 
 package eu.dnetlib.dhp.schema.oaf;
 
-import static com.google.common.base.Preconditions.checkArgument;
-
-import java.text.ParseException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 
-import eu.dnetlib.dhp.schema.common.ModelSupport;
-
 /**
  * Relation models any edge between two nodes in the OpenAIRE graph. It has a source id and a target id pointing to
  * graph node identifiers and it is further characterised by the semantic of the link through the fields relType,

src/main/java/eu/dnetlib/dhp/schema/oaf/StructuredProperty.java

@@ -2,12 +2,6 @@
 package eu.dnetlib.dhp.schema.oaf;
 
 import java.io.Serializable;
-import java.util.Objects;
-import java.util.Optional;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-
-import org.apache.commons.lang3.StringUtils;
 
 public class StructuredProperty implements Serializable {
 

src/main/java/eu/dnetlib/dhp/schema/solr/AccessRight.java

@@ -10,23 +10,34 @@ public class AccessRight implements Serializable {
 
 	private static final long serialVersionUID = 7995566912611238604L;
 
-	private String value;
+	private String code;
+
+	private String label;
 
 	private OpenAccessRoute openAccessRoute;
 
-	public static AccessRight newInstance(String value, OpenAccessRoute openAccessRoute) {
+	public static AccessRight newInstance(String code, String label, OpenAccessRoute openAccessRoute) {
 		AccessRight accessRight = new AccessRight();
-		accessRight.setValue(value);
+		accessRight.setCode(code);
+		accessRight.setLabel(label);
 		accessRight.setOpenAccessRoute(openAccessRoute);
 		return accessRight;
 	}
 
-	public String getValue() {
-		return value;
+	public String getCode() {
+		return code;
 	}
 
-	public void setValue(String value) {
-		this.value = value;
+	public void setCode(String code) {
+		this.code = code;
+	}
+
+	public String getLabel() {
+		return label;
+	}
+
+	public void setLabel(String label) {
+		this.label = label;
 	}
 
 	public OpenAccessRoute getOpenAccessRoute() {

src/main/java/eu/dnetlib/dhp/schema/solr/Measure.java

@@ -1,10 +1,36 @@
 package eu.dnetlib.dhp.schema.solr;
 
 import java.io.Serializable;
+import java.util.List;
 
 public class Measure implements Serializable {
 
     private static final long serialVersionUID = 57939927121851504L;
 
-    //TODO define me!
+    private String id;
+
+    private List<CodeLabel> unit;
+
+    public static Measure newInstance(String id, List<CodeLabel> unit) {
+        Measure m = new Measure();
+        m.setId(id);
+        m.setUnit(unit);
+        return m;
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public List<CodeLabel> getUnit() {
+        return unit;
+    }
+
+    public void setUnit(List<CodeLabel> unit) {
+        this.unit = unit;
+    }
 }

src/main/java/eu/dnetlib/dhp/schema/solr/Pid.java

@@ -6,25 +6,20 @@ public class Pid implements Serializable {
 
     private static final long serialVersionUID = -943684282582228545L;
 
-    private String type;
-
     private String value;
 
-    public static Pid newInstance(String type, String value) {
+    private String typeCode;
+
+    private String typeLabel;
+
+    public static Pid newInstance(String value, String typeCode, String typeLabel) {
         Pid p = new Pid();
-        p.setType(type);
         p.setValue(value);
+        p.setTypeCode(typeCode);
+        p.setTypeLabel(typeLabel);
         return p;
     }
 
-    public String getType() {
-        return type;
-    }
-
-    public void setType(String type) {
-        this.type = type;
-    }
-
     public String getValue() {
         return value;
     }
@@ -32,4 +27,20 @@ public class Pid implements Serializable {
     public void setValue(String value) {
         this.value = value;
     }
+
+    public String getTypeCode() {
+        return typeCode;
+    }
+
+    public void setTypeCode(String typeCode) {
+        this.typeCode = typeCode;
+    }
+
+    public String getTypeLabel() {
+        return typeLabel;
+    }
+
+    public void setTypeLabel(String typeLabel) {
+        this.typeLabel = typeLabel;
+    }
 }

src/main/java/eu/dnetlib/dhp/schema/solr/Project.java

@@ -18,6 +18,8 @@ public class Project implements Serializable {
     private String keywords;
     private String duration;
 
+    private String oamandatepublications;
+
     private String ecarticle29_3;
 
     private List<Subject> subjects;
@@ -107,6 +109,14 @@ public class Project implements Serializable {
         this.duration = duration;
     }
 
+    public String getOamandatepublications() {
+        return oamandatepublications;
+    }
+
+    public void setOamandatepublications(String oamandatepublications) {
+        this.oamandatepublications = oamandatepublications;
+    }
+
     public String getEcarticle29_3() {
         return ecarticle29_3;
     }

src/main/java/eu/dnetlib/dhp/schema/solr/RelatedRecord.java

@@ -39,6 +39,7 @@ public class RelatedRecord implements Serializable {
     private String acronym;
     private CodeLabel contracttype;
     private Funding funding;
+    private String validationDate;
 
     public RelatedRecordHeader getHeader() {
         return header;
@@ -215,4 +216,12 @@ public class RelatedRecord implements Serializable {
     public void setFunding(Funding funding) {
         this.funding = funding;
     }
+
+    public String getValidationDate() {
+        return validationDate;
+    }
+
+    public void setValidationDate(String validationDate) {
+        this.validationDate = validationDate;
+    }
 }

src/main/java/eu/dnetlib/dhp/schema/solr/RelatedRecordHeader.java

@@ -14,12 +14,18 @@ public class RelatedRecordHeader implements Serializable {
 
     private RecordType relatedRecordType;
 
-    public static RelatedRecordHeader newInstance(String relationType, String relationClass, String relatedIdentifier, RecordType relatedRecordType) {
+    private String relationProvenance;
+
+    private String trust;
+
+    public static RelatedRecordHeader newInstance(String relationType, String relationClass, String relatedIdentifier, RecordType relatedRecordType, String relationProvenance, String trust) {
         RelatedRecordHeader header = new RelatedRecordHeader();
         header.setRelationType(relationType);
         header.setRelationClass(relationClass);
         header.setRelatedIdentifier(relatedIdentifier);
         header.setRelatedRecordType(relatedRecordType);
+        header.setRelationProvenance(relationProvenance);
+        header.setTrust(trust);
         return header;
     }
 
@@ -54,4 +60,20 @@ public class RelatedRecordHeader implements Serializable {
     public void setRelatedRecordType(RecordType relatedRecordType) {
         this.relatedRecordType = relatedRecordType;
     }
+
+    public String getRelationProvenance() {
+        return relationProvenance;
+    }
+
+    public void setRelationProvenance(String relationProvenance) {
+        this.relationProvenance = relationProvenance;
+    }
+
+    public String getTrust() {
+        return trust;
+    }
+
+    public void setTrust(String trust) {
+        this.trust = trust;
+    }
 }

src/main/java/eu/dnetlib/dhp/schema/solr/Result.java

@@ -3,8 +3,6 @@ package eu.dnetlib.dhp.schema.solr;
 import java.io.Serializable;
 import java.util.List;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
-
 public class Result implements Serializable {
 
     private static final long serialVersionUID = -9121038426985022737L;
@@ -147,12 +145,10 @@ public class Result implements Serializable {
      */
     private List<EoscIfGuidelines> eoscifguidelines;
 
-    @JsonProperty("isGreen")
     private Boolean isGreen;
 
     private OpenAccessColor openAccessColor;
 
-    @JsonProperty("isInDiamondJournal")
     private Boolean isInDiamondJournal;
 
     private Boolean publiclyFunded;
@@ -381,11 +377,11 @@ public class Result implements Serializable {
         this.eoscifguidelines = eoscifguidelines;
     }
 
-    public Boolean getGreen() {
+    public Boolean getIsGreen() {
         return isGreen;
     }
 
-    public void setGreen(Boolean green) {
+    public void setIsGreen(Boolean green) {
         isGreen = green;
     }
 
@@ -397,11 +393,11 @@ public class Result implements Serializable {
         this.openAccessColor = openAccessColor;
     }
 
-    public Boolean getInDiamondJournal() {
+    public Boolean getIsInDiamondJournal() {
         return isInDiamondJournal;
     }
 
-    public void setInDiamondJournal(Boolean inDiamondJournal) {
+    public void setIsInDiamondJournal(Boolean inDiamondJournal) {
         isInDiamondJournal = inDiamondJournal;
     }
 

src/main/java/eu/dnetlib/dhp/schema/solr/SolrRecordHeader.java

@@ -7,6 +7,8 @@ public class SolrRecordHeader implements Serializable {
 
     private static final long serialVersionUID = -6052397109220149426L;
 
+    public enum Status { UNDER_CURATION }
+
     /**
      * The OpenAIRE identifiers for this record
      */
@@ -19,13 +21,20 @@ public class SolrRecordHeader implements Serializable {
 
     private RecordType recordType;
 
+    private Status status = null;
+
     private Boolean deletedbyinference;
 
     public static SolrRecordHeader newInstance(String id, List<String> originalId, RecordType recordType, Boolean deletedbyinference) {
+        return newInstance(id, originalId, recordType, null, deletedbyinference);
+    }
+
+    public static SolrRecordHeader newInstance(String id, List<String> originalId, RecordType recordType, Status status, Boolean deletedbyinference) {
         SolrRecordHeader header = new SolrRecordHeader();
         header.setId(id);
         header.setOriginalId(originalId);
         header.setRecordType(recordType);
+        header.setStatus(status);
         header.setDeletedbyinference(deletedbyinference);
         return header;
     }
@@ -58,6 +67,14 @@ public class SolrRecordHeader implements Serializable {
         return deletedbyinference;
     }
 
+    public Status getStatus() {
+        return status;
+    }
+
+    public void setStatus(Status status) {
+        this.status = status;
+    }
+
     public void setDeletedbyinference(Boolean deletedbyinference) {
         this.deletedbyinference = deletedbyinference;
     }

src/main/java/eu/dnetlib/dhp/schema/solr/Subject.java

@@ -8,12 +8,15 @@ public class Subject implements Serializable {
 
     private String value;
 
-    private String type;
+    private String typeCode;
 
-    public static Subject newInstance(String value, String type) {
+    private String typeLabel;
+
+    public static Subject newInstance(String value, String typeCode, String typeLabel) {
         Subject s = new Subject();
         s.setValue(value);
-        s.setType(type);
+        s.setTypeCode(typeCode);
+        s.setTypeLabel(typeLabel);
         return s;
     }
 
@@ -25,11 +28,19 @@ public class Subject implements Serializable {
         this.value = value;
     }
 
-    public String getType() {
-        return type;
+    public String getTypeCode() {
+        return typeCode;
     }
 
-    public void setType(String type) {
-        this.type = type;
+    public void setTypeCode(String typeCode) {
+        this.typeCode = typeCode;
+    }
+
+    public String getTypeLabel() {
+        return typeLabel;
+    }
+
+    public void setTypeLabel(String typeLabel) {
+        this.typeLabel = typeLabel;
     }
 }

src/test/java/eu/dnetlib/dhp/schema/solr/TestJsonSerialization.java

@@ -0,0 +1,32 @@
+package eu.dnetlib.dhp.schema.solr;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class TestJsonSerialization {
+
+    private static ObjectMapper MAPPER = new ObjectMapper();
+
+    @Test
+    void testSerialiseJsonPayload() throws IOException {
+        Result r = new Result();
+
+        r.setIsGreen(true);
+        r.setIsInDiamondJournal(false);
+
+        final String json = MAPPER.writeValueAsString(r);
+
+        assertNotNull(json);
+
+        System.out.println("json = " + json);
+
+        Result r1 = MAPPER.readValue(json, Result.class);
+
+        assertTrue(r1.getIsGreen());
+        assertFalse(r1.getIsInDiamondJournal());
+    }
+}