Merge pull request #5556 from effective-webwork/metadata-group

Change MetadataGroup.group variable to HashSet

Author: solth

Kitodo-API/src/main/java/org/kitodo/api/MetadataGroup.java

@@ -11,7 +11,6 @@
 
 package org.kitodo.api;
 
-import java.util.Collection;
 import java.util.HashSet;
 import java.util.Objects;
 import java.util.stream.Collectors;
@@ -23,25 +22,25 @@ public class MetadataGroup extends Metadata {
     /**
      * The contents of the metadata group.
      */
-    private Collection<Metadata> group = new HashSet<>();
+    private HashSet<Metadata> metadata = new HashSet<>();
 
     /**
      * Get the grouped metadata.
      *
      * @return The grouped metadata
      */
-    public Collection<Metadata> getGroup() {
-        return group;
+    public HashSet<Metadata> getMetadata() {
+        return metadata;
     }
 
     /**
      * Set the grouped metadata.
      *
-     * @param group
+     * @param metadata
      *            the grouped metadata
      */
-    public void setGroup(Collection<Metadata> group) {
-        this.group = group;
+    public void setMetadata(HashSet<Metadata> metadata) {
+        this.metadata = metadata;
     }
 
     @Override
@@ -63,22 +62,22 @@ public boolean equals(Object obj) {
                 : MdSec.DMD_SEC)) {
             return false;
         }
-        return Objects.equals(group, other.group);
+        return Objects.equals(metadata, other.metadata);
     }
 
     @Override
     public int hashCode() {
         final int prime = 31;
         int result = 1;
         result = prime * result + (Objects.nonNull(domain) ? domain : MdSec.DMD_SEC).hashCode();
-        result = prime * result + ((group == null) ? 0 : group.hashCode());
+        result = prime * result + ((metadata == null) ? 0 : metadata.hashCode());
         result = prime * result + ((key == null) ? 0 : key.hashCode());
         return result;
     }
 
     @Override
     public String toString() {
         return (Objects.nonNull(domain) ? "(" + domain + ") " : "") + key + ": {"
-                + group.stream().map(String::valueOf).collect(Collectors.joining(", ")) + '}';
+                + metadata.stream().map(String::valueOf).collect(Collectors.joining(", ")) + '}';
     }
 }

Kitodo-API/src/main/java/org/kitodo/api/dataformat/Division.java

@@ -47,7 +47,7 @@ public abstract class Division<T extends Division<T>> {
     /**
      * The metadata for this division.
      */
-    private Collection<Metadata> metadata = new HashSet<>();
+    private HashSet<Metadata> metadata = new HashSet<>();
 
     /**
      * Sequence number. The sequence number must be unique across all divisions.
@@ -165,7 +165,7 @@ public void setLabel(String label) {
      *
      * @return the metadata
      */
-    public Collection<Metadata> getMetadata() {
+    public HashSet<Metadata> getMetadata() {
         return metadata;
     }
 

Kitodo-DataFormat/src/main/java/org/kitodo/dataformat/access/MetadataGroupXmlElementAccess.java

@@ -39,7 +39,7 @@ public MetadataGroupXmlElementAccess() {
 
     /**
      * Constructor for a metadata entry group gained from METS.
-     * 
+     *
      * @param domain
      *            domain of the METS document where the metadata was read
      * @param xmlMetadataGroup
@@ -49,7 +49,7 @@ public MetadataGroupXmlElementAccess() {
         this();
         metadataGroup.setDomain(domain);
         metadataGroup.setKey(xmlMetadataGroup.getName());
-        metadataGroup.getGroup()
+        metadataGroup.getMetadata()
                 .addAll(Stream.concat(
                     xmlMetadataGroup.getMetadata().parallelStream()
                             .map(kitodoMetadata -> new MetadataXmlElementAccess(null, kitodoMetadata)
@@ -70,13 +70,13 @@ MetadataGroup getMetadataGroup() {
 
     /**
      * Generates a {@code <kitodo:metadataGroup>} XML element from this group.
-     * 
+     *
      * @return a {@code <kitodo:metadataGroup>} XML element
      */
     MetadataGroupType toXMLMetadataGroup() {
         MetadataGroupType xmlMetadataGroup = new MetadataGroupType();
         xmlMetadataGroup.setName(metadataGroup.getKey());
-        for (org.kitodo.api.Metadata entry : metadataGroup.getGroup()) {
+        for (org.kitodo.api.Metadata entry : metadataGroup.getMetadata()) {
             if (entry instanceof MetadataEntry) {
                 xmlMetadataGroup.getMetadata().add(new MetadataXmlElementAccess((MetadataEntry) entry).toMetadata());
             } else if (entry instanceof MetadataGroup) {

Kitodo-DataFormat/src/test/java/org/kitodo/dataformat/access/MetsXmlElementAccessIT.java

@@ -176,11 +176,11 @@ public void testSave() throws Exception {
         MetadataEntry firstName = new MetadataEntry();
         firstName.setKey("firstName");
         firstName.setValue("Alice");
-        author.getGroup().add(firstName);
+        author.getMetadata().add(firstName);
         MetadataEntry lastName = new MetadataEntry();
         lastName.setKey("firstName");
         lastName.setValue("Smith");
-        author.getGroup().add(lastName);
+        author.getMetadata().add(lastName);
         frontCover.getMetadata().add(author);
 
         MetadataEntry imagesConverted = new MetadataEntry();
@@ -258,7 +258,7 @@ public void missingMetsHeaderCreationDateDidNotThrowNullPointerException() throw
 
     @Test
     public void missingMetsFileForPointer() throws Exception {
-        try { 
+        try {
             new MetsXmlElementAccess().read(new FileInputStream(new File("src/test/resources/meta_missing_file.xml")));
         } catch (IllegalArgumentException e) {
             assertEquals("Corrupt file: file id for <mets:fptr> not found for div PHYS_0001", e.getMessage());
@@ -267,7 +267,7 @@ public void missingMetsFileForPointer() throws Exception {
 
     @Test
     public void duplicateMetsFileDefinition() throws Exception {
-        try { 
+        try {
             new MetsXmlElementAccess().read(
                 new FileInputStream(new File("src/test/resources/meta_duplicate_file.xml"))
             );
@@ -278,13 +278,13 @@ public void duplicateMetsFileDefinition() throws Exception {
 
     @Test
     public void missingMetsFileGroupUse() throws Exception {
-        try { 
+        try {
             new MetsXmlElementAccess().read(
                 new FileInputStream(new File("src/test/resources/meta_missing_file_use.xml"))
             );
         } catch (IllegalArgumentException e) {
             assertEquals(
-                "Corrupt file: file use for <mets:fptr> with id FILE_0001 not found in <mets:fileGrp>", 
+                "Corrupt file: file use for <mets:fptr> with id FILE_0001 not found in <mets:fileGrp>",
                 e.getMessage()
             );
         };

Kitodo-Validation/src/main/java/org/kitodo/validation/metadata/MetadataValidation.java

@@ -287,7 +287,7 @@ private static ValidationResult checkForMandatoryQuantitiesOfTheMetadataRecursiv
                 for (Metadata metadata : metadataViewWithValues.getValue()) {
                     if (metadata instanceof MetadataGroup) {
                         ValidationResult validationResult = checkForMandatoryQuantitiesOfTheMetadataRecursive(
-                            ((MetadataGroup) metadata).getGroup(),
+                            ((MetadataGroup) metadata).getMetadata(),
                             (ComplexMetadataViewInterface) metadataView, location + metadataView.getLabel() + " - ",
                             translations);
                         if (validationResult.getState().equals(State.ERROR)) {
@@ -327,7 +327,7 @@ private static ValidationResult checkForDetailsInTheMetadata(
         return checkForDetailsInTheMetadata( // start recursion
             containedMetadata, containingMetadataView, location, translations, new LinkedList<>());
     }
-    
+
     private static ValidationResult checkForDetailsInTheMetadata(
             Collection<Metadata> containedMetadata, ComplexMetadataViewInterface containingMetadataView,
             String location, Map<String, String> translations, LinkedList<Map<MetadataEntry, Boolean>> surroundingMetadata) {
@@ -355,7 +355,7 @@ private static ValidationResult checkForDetailsInTheMetadata(
                 } else if (metadata instanceof MetadataGroup
                         && metadataView instanceof ComplexMetadataViewInterface) {
                     ValidationResult validationResult = checkForDetailsInTheMetadata( // recursive
-                        ((MetadataGroup) metadata).getGroup(),
+                        ((MetadataGroup) metadata).getMetadata(),
                         (ComplexMetadataViewInterface) metadataView, location + metadataView.getLabel() + " - ",
                         translations, surroundingMetadata);
                     if (validationResult.getState().equals(State.ERROR)) {

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

@@ -81,7 +81,7 @@ public class ProcessFieldedMetadata extends ProcessDetail implements Serializabl
     /**
      * The metadata object with the content of this panel.
      */
-    private final Collection<Metadata> metadata;
+    private final HashSet<Metadata> metadata;
 
     /**
      * The key of the metadata group displaying here.
@@ -105,7 +105,7 @@ public ProcessFieldedMetadata() {
         super(null, null);
         this.treeNode = new DefaultTreeNode();
         treeNode.setExpanded(true);
-        this.metadata = Collections.emptyList();
+        this.metadata = new HashSet<>();
         this.hiddenMetadata = Collections.emptyList();
     }
 
@@ -191,7 +191,7 @@ private static void overwriteTreeNodes(List<TreeNode> source, List<TreeNode> tar
      *            data of the group, may be empty but must be modifiable
      */
     private ProcessFieldedMetadata(ProcessFieldedMetadata parent, ComplexMetadataViewInterface metadataView,
-            Collection<Metadata> metadata) {
+            HashSet<Metadata> metadata) {
         this(parent, null, metadataView, metadataView.getLabel(), metadataView.getId(), metadata);
     }
 
@@ -208,7 +208,7 @@ private ProcessFieldedMetadata(ProcessFieldedMetadata parent, ComplexMetadataVie
      */
     private ProcessFieldedMetadata(ProcessFieldedMetadata parent, Division<?> structure,
             ComplexMetadataViewInterface metadataView, String label, String metadataKey,
-                                   Collection<Metadata> metadata) {
+                                   HashSet<Metadata> metadata) {
         super(parent, label);
         this.division = structure;
         this.metadata = metadata;
@@ -217,12 +217,12 @@ private ProcessFieldedMetadata(ProcessFieldedMetadata parent, Division<?> struct
     }
 
     private ProcessFieldedMetadata(ProcessFieldedMetadata parent, MetadataGroup group) {
-        this(parent, null, null, group.getKey(), group.getKey(), group.getGroup());
+        this(parent, null, null, group.getKey(), group.getKey(), group.getMetadata());
     }
 
     private ProcessFieldedMetadata(ProcessFieldedMetadata template) {
         this(template.container, null, template.metadataView, template.label, template.metadataKey,
-                new ArrayList<>(template.metadata));
+                new HashSet<>(template.metadata));
         copy = true;
         hiddenMetadata = template.hiddenMetadata;
         treeNode = new DefaultTreeNode(this, template.getTreeNode().getParent());
@@ -330,17 +330,17 @@ private Collection<Metadata> addLabels(Collection<Metadata> metadata) {
      */
     public void createMetadataGroupPanel(ComplexMetadataViewInterface complexMetadataView,
                                                            Collection<Metadata> values) {
-        Collection<Metadata> value;
+        HashSet<Metadata> value;
 
         switch (values.size()) {
             case 0:
-                value = new ArrayList<>();
+                value = new HashSet<>();
                 break;
             case 1:
                 Metadata nextMetadata = values.iterator().next();
                 if (nextMetadata instanceof MetadataGroup) {
                     MetadataGroup metadataGroup = (MetadataGroup) nextMetadata;
-                    value = metadataGroup.getGroup();
+                    value = metadataGroup.getMetadata();
                 } else {
                     throw new IllegalStateException("Got simple metadata entry with key \"" + nextMetadata.getKey()
                             + "\" which is declared as substructured key in the rule set.");
@@ -612,9 +612,9 @@ public Collection<Metadata> getMetadata(boolean skipEmpty) throws InvalidMetadat
             throw new IllegalStateException("never happening exception");
         }
         if (skipEmpty) {
-            result.setGroup(metadata instanceof List ? metadata : new ArrayList<>(metadata));
+            result.setMetadata(metadata instanceof List ? metadata : new HashSet<>(metadata));
         } else {
-            result.setGroup(new ArrayList<>(DataEditorService.getExistingMetadataRows(treeNode.getChildren())));
+            result.setMetadata(new HashSet<>(DataEditorService.getExistingMetadataRows(treeNode.getChildren())));
         }
         return Collections.singletonList(result);
     }
@@ -728,7 +728,7 @@ public void preserve() throws InvalidMetadataValueException, NoSuchMetadataField
             metadataGroup.setKey(metadataKey);
             Optional<Domain> optionalDomain = metadataView.getDomain();
             optionalDomain.ifPresent(domain -> metadataGroup.setDomain(DOMAIN_TO_MDSEC.get(domain)));
-            metadataGroup.setGroup(metadata);
+            metadataGroup.setMetadata(metadata);
             container.metadata.add(metadataGroup);
             copy = false;
         }

Kitodo/src/main/java/org/kitodo/production/helper/ProcessHelper.java

@@ -12,8 +12,8 @@
 package org.kitodo.production.helper;
 
 import java.io.IOException;
-import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Locale;
 import java.util.Objects;
@@ -253,8 +253,8 @@ public static String getTitleDefinition(RulesetManagementInterface rulesetManage
      *            domain of metadata
      * @return metadata from node list
      */
-    public static List<Metadata> convertMetadata(NodeList nodes, MdSec domain) {
-        List<Metadata> allMetadata = new ArrayList<>();
+    public static HashSet<Metadata> convertMetadata(NodeList nodes, MdSec domain) {
+        HashSet<Metadata> allMetadata = new HashSet<>();
         if (Objects.nonNull(nodes)) {
             for (int index = 0; index < nodes.getLength(); index++) {
                 Node node = nodes.item(index);
@@ -271,7 +271,7 @@ public static List<Metadata> convertMetadata(NodeList nodes, MdSec domain) {
                         break;
                     case "metadataGroup": {
                         MetadataGroup group = new MetadataGroup();
-                        group.setGroup(convertMetadata(element.getChildNodes(), null));
+                        group.setMetadata(convertMetadata(element.getChildNodes(), null));
                         metadata = group;
                         break;
                     }

Kitodo/src/main/java/org/kitodo/production/services/command/OverwriteDataScript.java

@@ -37,7 +37,7 @@ public void executeScript(LegacyMetsModsDigitalDocumentHelper metadataFile, Proc
                 break;
             }
             if (metadatum instanceof MetadataGroup) {
-                Collection<Metadata> group = ((MetadataGroup) metadatum).getGroup();
+                Collection<Metadata> group = ((MetadataGroup) metadatum).getMetadata();
                 if (metadatum.getKey().equals(metadataScript.getMetadataKey())) {
                     // TODO: implement handling of metadataGroups
                 }

Kitodo/src/main/java/org/kitodo/production/services/dataeditor/DataEditorService.java

@@ -110,7 +110,7 @@ public static String getTitleValue(LogicalDivision element, String metadataTitle
             metadata = metadata.stream()
                     .filter(currentMetadata -> Objects.equals(currentMetadata.getKey(), metadataKey))
                     .filter(MetadataGroup.class::isInstance).map(MetadataGroup.class::cast)
-                    .flatMap(metadataGroup -> metadataGroup.getGroup().stream())
+                    .flatMap(metadataGroup -> metadataGroup.getMetadata().stream())
                     .collect(Collectors.toList());
         }
         Optional<String> metadataTitle = metadata.stream()