Merge pull request #6443 from thomaslow/import-structural-data-from-catalog-fixes-5915

Import catalog metadata from any record in the metadata editor

Author: solth

Kitodo/src/main/java/org/kitodo/production/forms/createprocess/CreateProcessForm.java

@@ -505,8 +505,10 @@ private String parentTypeIfForbidden() throws IOException {
      *            id of project to query from database
      * @param referringView
      *            view the user was coming from
+     * @param showDialog
+     *            whether to show the appropriate dialog for the default import configuration
      */
-    public void prepareProcess(int templateId, int projectId, String referringView, Integer parentId) {
+    public void prepareProcess(int templateId, int projectId, String referringView, Integer parentId, boolean showDialog) {
         this.referringView = referringView;
         ProcessGenerator processGenerator = new ProcessGenerator();
         try {
@@ -544,15 +546,15 @@ public void prepareProcess(int templateId, int projectId, String referringView,
                     }
                 }
                 processDataTab.prepare();
-                showDialogForImportConfiguration(currentImportConfiguration);
+                showDialogForImportConfiguration(currentImportConfiguration, showDialog);
             }
         } catch (ProcessGenerationException | DataException | DAOException | IOException e) {
             Helper.setErrorMessage(e.getLocalizedMessage(), logger, e);
         }
     }
 
-    private void showDialogForImportConfiguration(ImportConfiguration importConfiguration) {
-        if (Objects.nonNull(importConfiguration)) {
+    private void showDialogForImportConfiguration(ImportConfiguration importConfiguration, boolean showDialog) {
+        if (Objects.nonNull(importConfiguration) && showDialog) {
             if (ImportConfigurationType.OPAC_SEARCH.name().equals(importConfiguration.getConfigurationType())) {
                 PrimeFaces.current().executeScript("PF('catalogSearchDialog').show();");
             } else if (ImportConfigurationType.PROCESS_TEMPLATE.name().equals(importConfiguration.getConfigurationType())) {

Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/DataEditorForm.java

@@ -97,8 +97,6 @@ public class DataEditorForm implements MetadataTreeTableInterface, RulesetSetupI
      */
     private final AddMetadataDialog addMetadataDialog;
 
-    private final UpdateMetadataDialog updateMetadataDialog;
-
     /**
      * Backing bean for the add PhysicalDivision dialog.
      */
@@ -240,7 +238,6 @@ public DataEditorForm() {
         this.paginationPanel = new PaginationPanel(this);
         this.addDocStrucTypeDialog = new AddDocStrucTypeDialog(this);
         this.addMetadataDialog = new AddMetadataDialog(this);
-        this.updateMetadataDialog = new UpdateMetadataDialog(this);
         this.addPhysicalDivisionDialog = new AddPhysicalDivisionDialog(this);
         this.changeDocStrucTypeDialog = new ChangeDocStrucTypeDialog(this);
         this.editPagesDialog = new EditPagesDialog(this);
@@ -670,16 +667,6 @@ public AddMetadataDialog getAddMetadataDialog() {
         return addMetadataDialog;
     }
 
-    /**
-     * Get updateMetadataDialog.
-     *
-     * @return value of updateMetadataDialog
-     */
-    public UpdateMetadataDialog getUpdateMetadataDialog() {
-        return updateMetadataDialog;
-    }
-
-
     /**
      * Returns the backing bean for the add media dialog. This function is used
      * by PrimeFaces to access the elements of the add media dialog.
@@ -1295,28 +1282,6 @@ public String getMetadataFileLoadingError() {
         return metadataFileLoadingError;
     }
 
-    /**
-     * Check and return whether conditions for metadata update are met or not.
-     *
-     * @return whether metadata of process can be updated
-     */
-    public boolean canUpdateMetadata() {
-        try {
-            return DataEditorService.canUpdateCatalogMetadata(process, workpiece, structurePanel.getSelectedLogicalNodeIfSingle());
-        } catch (IOException e) {
-            Helper.setErrorMessage(e.getLocalizedMessage(), logger, e);
-            return false;
-        }
-    }
-
-    /**
-     * Perform metadata update for current process.
-     */
-    public void applyMetadataUpdate() {
-        DataEditorService.updateMetadataWithNewValues(workpiece, updateMetadataDialog.getMetadataComparisons());
-        metadataPanel.update();
-    }
-
     /**
      * Retrieve and return value of metadata configured as functional metadata 'recordIdentifier'.
      *

Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/UpdateMetadataDialog.java

@@ -11,11 +11,22 @@
 
 package org.kitodo.production.forms.dataeditor;
 
+import java.io.IOException;
+import java.io.Serializable;
 import java.util.HashSet;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Objects;
 
+import javax.faces.view.ViewScoped;
+import javax.inject.Inject;
+import javax.inject.Named;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.kitodo.api.Metadata;
+import org.kitodo.api.dataformat.Division;
+import org.kitodo.api.dataformat.LogicalDivision;
 import org.kitodo.exceptions.InvalidMetadataValueException;
 import org.kitodo.production.forms.createprocess.ProcessDetail;
 import org.kitodo.production.helper.Helper;
@@ -24,15 +35,25 @@
 import org.primefaces.PrimeFaces;
 import org.primefaces.model.TreeNode;
 
-public class UpdateMetadataDialog {
+/**
+ * Manages the dialog when a user clicks on the update metadata button.
+ * 
+ * <p>Re-imports the catalog record for a known record identifier and import configuration
+ * and visualizes the differences between the current metadata and re-imported metadata of the
+ * catalog.</p>
+ */
+@Named("UpdateMetadataDialog")
+@ViewScoped
+public class UpdateMetadataDialog implements Serializable {
+
+    private static final Logger logger = LogManager.getLogger(UpdateMetadataDialog.class);
 
-    private final DataEditorForm dataEditor;
+    @Inject
+    private DataEditorForm dataEditor;
 
     private List<MetadataComparison> metadataComparisons = new LinkedList<>();
 
-    UpdateMetadataDialog(DataEditorForm dataEditor) {
-        this.dataEditor = dataEditor;
-    }
+    private String recordIdentifier = "";
 
     /**
      * Get list of metadata comparisons displayed in 'UpdateMetadataDialog'.
@@ -43,11 +64,73 @@ public List<MetadataComparison> getMetadataComparisons() {
         return metadataComparisons;
     }
 
+    /**
+     * Return catalog identifier of record whose metadata is imported.
+     * 
+     * <p>The record identifier is shown to the user in the metadata comparison dialog.</p>
+     * 
+     * @return the record identifier
+     */
+    public String getRecordIdentifier() {
+        return this.recordIdentifier;
+    }
+
+    /**
+     * Set record identifier of record whose metadata is imported.
+     * 
+     * <p>The record identifier is shown to the user in the metadata comparison dialog.</p>
+     * 
+     * @param recordIdentifier the record identifier
+     */
+    public void setRecordIdentifier(String recordIdentifier) {
+        this.recordIdentifier = recordIdentifier;
+    }
+
+    /**
+     * Perform metadata update for current process.
+     */
+    public void applyMetadataUpdate() {
+        Division<?> division = dataEditor.getMetadataPanel().getLogicalMetadataTable().getDivision();
+        if (Objects.nonNull(division) && division instanceof LogicalDivision) {
+            DataEditorService.updateMetadataWithNewValues((LogicalDivision) division, getMetadataComparisons());
+            dataEditor.getMetadataPanel().update();
+        } else {
+            Helper.setErrorMessage("cannot update metadata of non-logical division");
+        }        
+    }
+
+    /**
+     * Check and return whether conditions for metadata update are met or not.
+     *
+     * @return whether metadata of process can be updated
+     */
+    public boolean canUpdateMetadata() {
+        try {
+            return DataEditorService.canUpdateCatalogMetadata(
+                dataEditor.getProcess(), dataEditor.getWorkpiece(), dataEditor.getStructurePanel().getSelectedLogicalNodeIfSingle()
+            );
+        } catch (IOException e) {
+            Helper.setErrorMessage(e.getLocalizedMessage(), logger, e);
+            return false;
+        }
+    }
+
+    /**
+     * Is called when a user clicks on the update metadata button of the logical metadata panel.
+     */
+    public void onUpdateCatalogMetadataClick() {
+        if (canUpdateMetadata()) {
+            // update metadata from catalog using existing record identifier and import configuration
+            updateCatalogMetadata();
+        }
+    }
+
     /**
      * Trigger re-import of metadata of current process.
      */
     public void updateCatalogMetadata() {
         if (dataEditor.getSelectedStructure().isPresent()) {
+            setRecordIdentifier(dataEditor.getProcessRecordIdentifier());
             try {
                 HashSet<Metadata> existingMetadata = getMetadata(dataEditor.getMetadataPanel().getLogicalMetadataRows());
                 metadataComparisons = DataEditorService.reimportCatalogMetadata(dataEditor.getProcess(),