chore: migrate exporters to new Exporter interface in Extension API IQSS#9175

- Change main export method signature (avoids internal model class DatasetVersion in Extension API)
- Migrate imports
- Cleanup imports order

Note: this commit introduces a BREAKING change, as a few exporters relied on the DatasetVersion parameter!
This will need to be addressed.

Author: poikilotherm

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

@@ -2,13 +2,14 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.DatasetVersion;
 import edu.harvard.iq.dataverse.export.dublincore.DublinCoreExportUtil;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
-import java.io.OutputStream;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
 import javax.json.JsonObject;
 import javax.xml.stream.XMLStreamException;
+import java.io.OutputStream;
 
 /**
  *
@@ -30,7 +31,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream) throws ExportException {
+    public void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException {
         try {
             DublinCoreExportUtil.datasetJson2dublincore(json, outputStream, DublinCoreExportUtil.DC_FLAVOR_DCTERMS);
         } catch (XMLStreamException xse) {

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

@@ -2,15 +2,16 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.DatasetVersion;
 import edu.harvard.iq.dataverse.export.ddi.DdiExportUtil;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
-import java.io.OutputStream;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
 import javax.json.JsonObject;
+import javax.xml.stream.XMLOutputFactory;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
-import javax.xml.stream.XMLOutputFactory;
+import java.io.OutputStream;
 
 /**
  * This exporter is for the "full" DDI, that includes the file-level,
@@ -39,7 +40,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream) throws ExportException {
+    public void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException {
         try {
         XMLStreamWriter xmlw = XMLOutputFactory.newInstance().createXMLStreamWriter(outputStream);
         xmlw.writeStartDocument();

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

@@ -2,17 +2,17 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-
 import edu.harvard.iq.dataverse.DOIDataCiteRegisterService;
 import edu.harvard.iq.dataverse.DataCitation;
-import edu.harvard.iq.dataverse.DatasetVersion;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
+import javax.json.JsonObject;
 import java.io.IOException;
 import java.io.OutputStream;
 import java.nio.charset.Charset;
 import java.util.Map;
-import javax.json.JsonObject;
 
 /**
  *
@@ -39,7 +39,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream)
+    public void exportDataset(JsonObject json, OutputStream outputStream)
             throws ExportException {
         try {
             DataCitation dc = new DataCitation(version);

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

@@ -2,13 +2,14 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.DatasetVersion;
 import edu.harvard.iq.dataverse.export.dublincore.DublinCoreExportUtil;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
-import java.io.OutputStream;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
 import javax.json.JsonObject;
 import javax.xml.stream.XMLStreamException;
+import java.io.OutputStream;
 
 /**
  *
@@ -30,7 +31,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream) throws ExportException {
+    public void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException {
         try {
             DublinCoreExportUtil.datasetJson2dublincore(json, outputStream, DublinCoreExportUtil.DC_FLAVOR_OAI);
         } catch (XMLStreamException xse) {

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

@@ -1,21 +1,17 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.Dataset;
-import edu.harvard.iq.dataverse.DatasetVersion;
 import edu.harvard.iq.dataverse.export.ddi.DdiExportUtil;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
 
 import javax.json.JsonObject;
 import javax.ws.rs.core.MediaType;
 import javax.xml.stream.XMLStreamException;
-import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
-import java.nio.file.Path;
-import java.nio.file.Paths;
 
 @AutoService(Exporter.class)
 public class HtmlCodeBookExporter implements Exporter {
@@ -31,7 +27,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream) throws ExportException {
+    public void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException {
         try {
             InputStream ddiInputStream;
             try {

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

@@ -2,9 +2,10 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.DatasetVersion;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
 import java.io.OutputStream;
 import javax.json.JsonObject;
 import javax.ws.rs.core.MediaType;
@@ -28,7 +29,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream) throws ExportException {
+    public void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException {
         try{
             outputStream.write(json.toString().getBytes("UTF8"));
             outputStream.flush();

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

@@ -2,10 +2,11 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.DatasetVersion;
 import edu.harvard.iq.dataverse.export.ddi.DdiExportUtil;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
 import java.io.OutputStream;
 import javax.json.JsonObject;
 import javax.xml.stream.XMLStreamException;
@@ -32,7 +33,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream) throws ExportException {
+    public void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException {
         try {
             DdiExportUtil.datasetJson2ddi(json, outputStream);
         } catch (XMLStreamException xse) {

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

@@ -1,18 +1,15 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.DatasetVersion;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
-import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
-import edu.harvard.iq.dataverse.export.ExportException;
 import edu.harvard.iq.dataverse.util.BundleUtil;
 import edu.harvard.iq.dataverse.util.bagit.OREMap;
-import java.io.OutputStream;
-import java.util.ResourceBundle;
-import java.util.logging.Logger;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
 
 import javax.json.JsonObject;
 import javax.ws.rs.core.MediaType;
+import java.io.OutputStream;
+import java.util.logging.Logger;
 
 @AutoService(Exporter.class)
 public class OAI_OREExporter implements Exporter {
@@ -22,7 +19,7 @@ public class OAI_OREExporter implements Exporter {
     public static final String NAME = "OAI_ORE";
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream)
+    public void exportDataset(JsonObject json, OutputStream outputStream)
             throws ExportException {
         try {
             new OREMap(version).writeOREMap(outputStream);

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

@@ -9,8 +9,9 @@
 
 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;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
 
 @AutoService(Exporter.class)
 public class OpenAireExporter implements Exporter {
@@ -29,7 +30,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream)
+    public void exportDataset(JsonObject json, OutputStream outputStream)
             throws ExportException {
         try {
             OpenAireExportUtil.datasetJson2openaire(json, outputStream);

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

@@ -1,17 +1,18 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.DatasetVersion;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
-import java.io.IOException;
-import java.io.OutputStream;
-import java.io.StringReader;
-import java.util.logging.Logger;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
 import javax.json.Json;
 import javax.json.JsonObject;
 import javax.json.JsonReader;
 import javax.ws.rs.core.MediaType;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.StringReader;
+import java.util.logging.Logger;
 
 /**
  * Schema.org JSON-LD is used by Google Dataset Search and other services to
@@ -75,7 +76,7 @@ public class SchemaDotOrgExporter implements Exporter {
     public static final String NAME = "schema.org";
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream) throws ExportException {
+    public void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException {
         String jsonLdAsString = version.getJsonLd();
         try (JsonReader jsonReader = Json.createReader(new StringReader(jsonLdAsString));) {
             JsonObject jsonLdJsonObject = jsonReader.readObject();