Changeset 23410

Timestamp:

2010-12-07T19:26:53+13:00 (13 years ago)

Author:

kjdon

Message:

Katherine fixed the reason why non-accumulating metadata (gs.FilenameEncoding) was glitchy and at times did not override meta assigned at higher levels with those assigned at lower levels. The applicable_metadata_xml_files needed to be inspected in a guaranteed top-down order for the override to work.

File:

• main/trunk/gli/src/org/greenstone/gatherer/metadata/MetadataXMLFileManager.java (modified) (3 diffs)

main/trunk/gli/src/org/greenstone/gatherer/metadata/MetadataXMLFileManager.java

@@ -47 +47 @@
     static private ArrayList modified_metadata_xml_files = new ArrayList();
 
+  /** For non-accumulating metadata (gs.FilenameEncoding), need the metadata.xml files
+   * sorted in top-down folder level order, which is achieved through this Comparator. 
+   * By declaring a static class member here, we avoid recreating this object for every 
+   * comparison, which would otherwise have resulted in a constructor call each time. */
+  static private MetadataXMLFileComparator metadataXMLFileComparator = new MetadataXMLFileComparator();
+
 
     static public void addMetadata(CollectionTreeNode file_node, ArrayList metadata_values)
@@ -201 +207 @@
     }
 
+    // sort the metadataxml files in order starting from those in the 
+    // topmost folders down to the one in the lowest level folder.
+    Collections.sort(applicable_metadata_xml_files, metadataXMLFileComparator);
     // Return the metadata assigned to the specified file from the applicable metadata.xml files
     return getMetadataAssignedToFile(file, applicable_metadata_xml_files);
@@ -388 +397 @@
     }
     }
+
+  
+  /**
+  * Comparator to order MetadataXMLFiles in ascending order from
+  * those in a higher level folder to those in a lower level folder
+  * It is based on the assumption that all MetadataXMLFiles sent to
+  * it to compare will be linear descendants of one toplevel folder
+  * E.g. /A/metadata.xml, /A/B/metadata.xml, /A/B/C/D/metadata.xml.
+  * In other words, that each is a substring of one other until we
+  * get to the toplevel folder.
+  */
+  private static class MetadataXMLFileComparator implements Comparator {
+    
+    public int compare(Object o1, Object o2) {
+      if(!(o1 instanceof MetadataXMLFile)) {
+    return -1;
+      } else if (!(o2 instanceof MetadataXMLFile)) {
+    return 1;
+      } 
+
+      // Both are MetadataXMLFiles objects. Remove the terminating
+      // "metadata.xml" from their filenames to get their containing folder
+      String filename1 = ((MetadataXMLFile)o1).getParentFile().getAbsolutePath();
+      String filename2 = ((MetadataXMLFile)o2).getParentFile().getAbsolutePath();
+
+      // if 1 is a prefix 2, then 1 < 2 in the ordering (1 comes before 2)
+      if(filename2.startsWith(filename1)) {
+    return -1;
+      } else if(filename1.startsWith(filename2)) {
+    return 1;
+      } else { 
+    // unlikely that the metadata.xml files will be the same
+    // or that neither is a prefix of the other
+    return filename1.compareTo(filename2); // sorts in ascending order
+      }      
+      
+    }
+
+    public boolean equals(Object obj) {
+      if(!(obj instanceof MetadataXMLFileComparator)) {
+    return false;
+      } 
+     
+      // else it is the same sort of comparator
+      return true;
+    }
+
+  }
+
 }