OpenAIRE guidelines for Data Archives

.gitignore

@@ -1,6 +1,10 @@
 nb-configuration.xml
 target
 nbactions.xml
+# eclipse IDE
+.settings/
+.classpath
+.project
 michael-local
 GPATH
 GTAGS
@@ -41,4 +45,4 @@ conf/docker-aio/dv/deps/
 conf/docker-aio/dv/install/dvinstall.zip
 # or copy of test data
 conf/docker-aio/testdata/
-scripts/installer/default.config
+scripts/installer/default.config

src/main/java/edu/harvard/iq/dataverse/api/dto/DataFileDTO.java

@@ -12,6 +12,7 @@ public class DataFileDTO {
     private String id;
     private String storageIdentifier; 
     private String contentType;
+    private Long filesize;
     private String filename;
     private String originalFileFormat;
     private String originalFormatLabel;
@@ -51,6 +52,14 @@ public String getContentType() {
     public void setContentType(String contentType) {
         this.contentType = contentType;
     }
+
+    public Long getFileSize() {
+        return filesize;
+    }
+
+    public void setFileSize(Long fileSize) {
+        this.filesize = fileSize;
+    }
 
     public String getFilename() {
         return filename;

src/main/java/edu/harvard/iq/dataverse/api/dto/DatasetVersionDTO.java

@@ -13,7 +13,7 @@ public class DatasetVersionDTO {
     String archiveNote;
     String deacessionLink;
     Long versionNumber;
-    String minorVersionNumber;
+    Long versionMinorNumber;
     long id;
     VersionState versionState;
     String releaseDate;
@@ -36,7 +36,8 @@ public class DatasetVersionDTO {
     String availabilityStatus;
     String contactForAccess;
     String sizeOfCollection;
-    String studyCompletion; 
+    String studyCompletion;
+    boolean fileAccessRequest;
     String citation;
     String license;
     boolean inReview;
@@ -172,7 +173,15 @@ public String getStudyCompletion() {
     public void setStudyCompletion(String studyCompletion) {
         this.studyCompletion = studyCompletion;
     }
-
+
+    public boolean isFileAccessRequest() {
+    	return fileAccessRequest;
+    }
+
+    public void setFileAccessRequest(boolean fileAccessRequest) {
+    	this.fileAccessRequest = fileAccessRequest;
+    }
+
     public String getCitation() {
         return citation;
     }
@@ -229,12 +238,12 @@ public void setVersionNumber(Long versionNumber) {
         this.versionNumber = versionNumber;
     }
 
-    public String getMinorVersionNumber() {
-        return minorVersionNumber;
+    public Long getMinorVersionNumber() {
+        return versionMinorNumber;
     }
 
-    public void setMinorVersionNumber(String minorVersionNumber) {
-        this.minorVersionNumber = minorVersionNumber;
+    public void setMinorVersionNumber(Long minorVersionNumber) {
+        this.versionMinorNumber = minorVersionNumber;
     }
 
     public long getId() {
@@ -320,7 +329,7 @@ public List<FieldDTO> getDatasetFields() {
 
     @Override
     public String toString() {
-        return "DatasetVersionDTO{" + "archiveNote=" + archiveNote + ", deacessionLink=" + deacessionLink + ", versionNumber=" + versionNumber + ", minorVersionNumber=" + minorVersionNumber + ", id=" + id + ", versionState=" + versionState + ", releaseDate=" + releaseDate + ", lastUpdateTime=" + lastUpdateTime + ", createTime=" + createTime + ", archiveTime=" + archiveTime + ", UNF=" + UNF + ", metadataBlocks=" + metadataBlocks + ", fileMetadatas=" + fileMetadatas + '}';
+        return "DatasetVersionDTO{" + "archiveNote=" + archiveNote + ", deacessionLink=" + deacessionLink + ", versionNumber=" + versionNumber + ", minorVersionNumber=" + versionMinorNumber + ", id=" + id + ", versionState=" + versionState + ", releaseDate=" + releaseDate + ", lastUpdateTime=" + lastUpdateTime + ", createTime=" + createTime + ", archiveTime=" + archiveTime + ", UNF=" + UNF + ", metadataBlocks=" + metadataBlocks + ", fileMetadatas=" + fileMetadatas + '}';
     }
 
 

src/main/java/edu/harvard/iq/dataverse/api/dto/FileDTO.java

@@ -1,9 +1,27 @@
 package edu.harvard.iq.dataverse.api.dto;
 
 public class FileDTO {
-
+
+	String label;
+	boolean restricted;
     DataFileDTO dataFile;
-
+
+    public String getLabel() {
+    	return label;
+    }
+
+    public void setLabel(String label) {
+    	this.label = label;
+    }
+
+    public boolean isRestricted() {
+    	return restricted;
+    }
+
+    public void setRestricted(boolean restricted) {
+    	this.restricted = restricted;
+    }
+
     public DataFileDTO getDataFile() {
         return dataFile;
     }

src/main/java/edu/harvard/iq/dataverse/export/ExportService.java

@@ -306,7 +306,7 @@ private InputStream getCachedExportFormat(Dataset dataset, String formatName) th
         try {
             dataAccess = DataAccess.getStorageIO(dataset);
         } catch (IOException ioex) {
-            throw new IOException("IO Exception thrown exporting as " + "export_" + formatName + ".cached");
+            throw new IOException("IO Exception thrown exporting as " + "export_" + formatName + ".cached", ioex);
         }
 
         InputStream cachedExportInputStream = null;
@@ -317,7 +317,7 @@ private InputStream getCachedExportFormat(Dataset dataset, String formatName) th
                 return cachedExportInputStream;
             }
         } catch (IOException ioex) {
-            throw new IOException("IO Exception thrown exporting as " + "export_" + formatName + ".cached");
+            throw new IOException("IO Exception thrown exporting as " + "export_" + formatName + ".cached", ioex);
         }
         return null;
 

src/main/java/edu/harvard/iq/dataverse/export/OpenAireExporter.java

@@ -0,0 +1,83 @@
+package edu.harvard.iq.dataverse.export;
+
+import java.io.OutputStream;
+import java.util.logging.Logger;
+
+import javax.json.JsonObject;
+import javax.xml.stream.XMLStreamException;
+
+import com.google.auto.service.AutoService;
+
+import edu.harvard.iq.dataverse.DatasetVersion;
+import edu.harvard.iq.dataverse.export.openaire.OpenAireExportUtil;
+import edu.harvard.iq.dataverse.export.spi.Exporter;
+import edu.harvard.iq.dataverse.util.BundleUtil;
+
+@AutoService(Exporter.class)
+public class OpenAireExporter implements Exporter {
+    Logger logger = Logger.getLogger(OpenAireExporter.class.getCanonicalName());
+
+	public OpenAireExporter() {
+		logger.info("entering in OpenAireExporter constructor");
+	}
+
+	@Override
+	public String getProviderName() {
+		logger.info("entering in the method getProviderName() of OpenAIRE");
+		return "oai_datacite";
+	}
+
+	@Override
+	public String getDisplayName() {
+		logger.info("entering in getDisplayName() of OpenAIRE");
+		// add this into the dataverse/src/main/java/Bundle.properties (it is present into applications/dataverse-4.8.6/WEB-INF/classes)
+		return  BundleUtil.getStringFromBundle("dataset.exportBtn.itemLabel.dataciteOpenAIRE") != null ? BundleUtil.getStringFromBundle("dataset.exportBtn.itemLabel.dataciteOpenAIRE") : "DataCite OpenAIRE";
+	}
+
+	@Override
+	public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream)
+			throws ExportException {
+		logger.info("entering into exportDataset() of OpenAIRE");
+		try {
+            OpenAireExportUtil.datasetJson2openaire(json, outputStream);
+		} catch (XMLStreamException xse) {
+            throw new ExportException("Caught XMLStreamException performing DataCite OpenAIRE export", xse);
+        }
+	}
+
+	@Override
+	public Boolean isXMLFormat() {
+		return true;
+	}
+
+	@Override
+	public Boolean isHarvestable() {
+		return true;
+	}
+
+	@Override
+	public Boolean isAvailableToUsers() {
+		return false;
+	}
+
+	@Override
+	public String getXMLNameSpace() throws ExportException {
+		return OpenAireExportUtil.OAI_DATACITE_NAMESPACE;
+	}
+
+	@Override
+	public String getXMLSchemaLocation() throws ExportException {
+		return OpenAireExportUtil.OAI_DATACITE_SCHEMA_LOCATION;
+	}
+
+	@Override
+	public String getXMLSchemaVersion() throws ExportException {
+		return OpenAireExportUtil.SCHEMA_VERSION;
+	}
+
+	@Override
+	public void setParam(String name, Object value) {
+		// not used
+	}
+
+}