Changeset 7827

Timestamp:

2004-07-30T04:54:25+12:00 (20 years ago)

Author:

mdewsnip

Message:

More of the new metadata code.

Location:

trunk/gli/src/org/greenstone/gatherer/metadata

Files:

• DocXMLFile.java (modified) (2 diffs)
• MetadataAuditTableModel.java (added)
• MetadataSet.java (modified) (1 diff)
• MetadataValue.java (modified) (2 diffs)
• MetadataValueTableModel.java (modified) (4 diffs)
• MetadataXMLFile.java (modified) (7 diffs)
• MetadataXMLFileManager.java (modified) (7 diffs)

trunk/gli/src/org/greenstone/gatherer/metadata/DocXMLFile.java

@@ -5 +5 @@
 import java.util.*;
 import org.greenstone.gatherer.util.Utility;
+import org.greenstone.gatherer.util.XMLTools;
 import org.w3c.dom.*;
 
@@ -112 +113 @@
      if (file_relative_path.equals(files_in_doc_xml_file.get(i))) {
         contains_extracted_metadata_for_file = true;
-        System.err.println("Found extracted metadata in file " + getAbsolutePath());
+        // System.err.println("Found extracted metadata in file " + getAbsolutePath());
         break;
      }

trunk/gli/src/org/greenstone/gatherer/metadata/MetadataSet.java

@@ -4 +4 @@
 import java.io.*;
 import java.util.*;
+import org.greenstone.gatherer.util.XMLTools;
 import org.w3c.dom.*;
 

trunk/gli/src/org/greenstone/gatherer/metadata/MetadataValue.java

@@ -13 +13 @@
    private MetadataElement metadata_element = null;
    private MetadataValueTreeNode metadata_value_tree_node = null;
+   private boolean is_accumulating_metadata = false;
 
 
@@ -73 +74 @@
 
 
+   public boolean isAccumulatingMetadata()
+   {
+      return is_accumulating_metadata;
+   }
+
+
    public boolean isInheritedMetadata()
    {
       return (folder_metadata_inherited_from != null);
    }
+
+
+   public void setIsAccumulatingMetadata(boolean is_accumulating_metadata)
+   {
+      this.is_accumulating_metadata = is_accumulating_metadata;
+   }
 }
 

trunk/gli/src/org/greenstone/gatherer/metadata/MetadataValueTableModel.java

@@ -17 +17 @@
    extends AbstractTableModel
 {
+   /** The FileNodes this model is built for */
+   private FileNode[] file_nodes = null;
    /** The list of MetadataValueTableEntries in the table */
    private ArrayList metadata_value_table_entries = new ArrayList();
-   /** The FileNodes this model is built for */
-   private FileNode[] file_nodes = null;
-   /** The table this model is being displayed in */
-   private JTable metadata_value_table = null;
-
-   private MetadataValueTableModelBuilder builder = null;
 
    static final private String[] COLUMN_NAMES = {"", Dictionary.get("Metadata.Element"),  Dictionary.get("Metadata.Value")};
 
 
-   public MetadataValueTableModel(JTable metadata_value_table, FileNode[] file_nodes)
-   {
-      this.metadata_value_table = metadata_value_table;
+   /** Returns the number of columns in this table. */
+   public int getColumnCount()
+   {
+      return COLUMN_NAMES.length;
+   }
+
+
+   /** Retrieves the name of the specified column. */
+   public String getColumnName(int col)
+   {
+      return COLUMN_NAMES[col];
+   }
+
+
+   /* Called to retrieve the MetadataValueTableEntry at a certain row. Usually caused by the user selecting a row in the table. It is synchronized so that the model doesn't up and change while we're trying to retrieve the indicated element. */
+   public synchronized MetadataValueTableEntry getMetadataValueTableEntry(int row)
+   {
+      if (row >= 0 && row < metadata_value_table_entries.size()) {
+     return (MetadataValueTableEntry) metadata_value_table_entries.get(row);
+      }
+
+      return null;
+   }
+
+
+   /** Returns the number of rows in this table. */
+   public int getRowCount()
+   {
+      return metadata_value_table_entries.size();
+   }
+
+
+   /** Returns the cell value at a given row and column as an Object. */
+   public Object getValueAt(int row, int col)
+   {
+      // Check values are reasonable
+      if (row < 0 || row >= metadata_value_table_entries.size() || col < 0 || col >= COLUMN_NAMES.length) {
+     return null;
+      }
+
+      MetadataValueTableEntry metadata_value_table_entry = (MetadataValueTableEntry) metadata_value_table_entries.get(row);
+      if (col == 0 && metadata_value_table_entry.isInheritedMetadata()) {
+     return metadata_value_table_entry.getFolderMetadataInheritedFrom();
+      }
+
+      if (col == 1) {
+     return metadata_value_table_entry.getMetadataElement();
+      }
+
+      if (col == 2) {
+     return metadata_value_table_entry.getFullValue();
+      }
+
+      return null;
+   }
+
+
+   /** Determine if the given metadata is common to all selected file nodes given the context of the current view. */
+   public boolean isCommon(MetadataValueTableEntry metadata_value_table_entry)
+   {
+      return (file_nodes != null && metadata_value_table_entry.getOccurrences() == file_nodes.length);
+   }
+
+
+   /** Determine if the given metadata is common to all selected file nodes given the context of the current view. */
+   public boolean isCommon(int row)
+   {
+      if (row >= 0 && row < metadata_value_table_entries.size()) {
+     return isCommon((MetadataValueTableEntry) metadata_value_table_entries.get(row));
+      }
+
+      return false;
+   }
+
+
+   public void rebuild(FileNode[] file_nodes)
+   {
+      metadata_value_table_entries.clear();
+
+      if (!Gatherer.c_man.ready()) {
+     Gatherer.println("Not ready!");
+     return;
+      }
 
       this.file_nodes = file_nodes;
       if (file_nodes != null && file_nodes.length > 0) {
      // Create model builder
-     builder = new MetadataValueTableModelBuilder();
-     builder.start();
-      }
-   }
-
-
-   /** Returns the number of columns in this table. */
-   public int getColumnCount()
-   {
-      return COLUMN_NAMES.length;
-   }
-
-
-   /** Retrieves the name of the specified column. */
-   public String getColumnName(int col)
-   {
-      return COLUMN_NAMES[col];
-   }
-
-
-   /* Called to retrieve the MetadataValueTableEntry at a certain row. Usually caused by the user selecting a row in the table. It is synchronized so that the model doesn't up and change while we're trying to retrieve the indicated element. */
-   public synchronized MetadataValueTableEntry getMetadataValueTableEntry(int row)
-   {
-      if (row >= 0 && row < metadata_value_table_entries.size()) {
-     return (MetadataValueTableEntry) metadata_value_table_entries.get(row);
-      }
-
-      return null;
-   }
-
-
-   /** Returns the number of rows in this table. */
-   public int getRowCount()
-   {
-      return metadata_value_table_entries.size();
-   }
-
-
-   /** Returns the cell value at a given row and column as an Object. */
-   public Object getValueAt(int row, int col)
-   {
-      // Check values are reasonable
-      if (row < 0 || row >= metadata_value_table_entries.size() || col < 0 || col >= COLUMN_NAMES.length) {
-     return null;
-      }
-
-      MetadataValueTableEntry metadata_value_table_entry = (MetadataValueTableEntry) metadata_value_table_entries.get(row);
-      if (col == 0 && metadata_value_table_entry.isInheritedMetadata()) {
-     return metadata_value_table_entry.getFolderMetadataInheritedFrom();
-      }
-
-      if (col == 1) {
-     return metadata_value_table_entry.getMetadataElement();
-      }
-
-      if (col == 2) {
-     return metadata_value_table_entry.getFullValue();
-      }
-
-      return null;
-   }
-
-   
-   public boolean isBuildingComplete()
-   {
-      return (builder == null || builder.complete);
-   }
-
-
-   /** Determine if the given metadata is common to all selected file nodes given the context of the current view. */
-   public boolean isCommon(MetadataValueTableEntry metadata_value_table_entry)
-   {
-      return (file_nodes != null && metadata_value_table_entry.getOccurrences() == file_nodes.length);
-   }
-
-
-   /** Determine if the given metadata is common to all selected file nodes given the context of the current view. */
-   public boolean isCommon(int row)
-   {
-      if (row >= 0 && row < metadata_value_table_entries.size()) {
-     return isCommon((MetadataValueTableEntry) metadata_value_table_entries.get(row));
-      }
-
-      return false;
-   }
-
-
-   public void selectClosestMetadataValueTableEntryWhenBuildingComplete(MetadataValueTableEntry metadata_value_table_entry)
-   {
-      // If there is no builder or no data then there is no point...
-      if (builder == null || metadata_value_table_entry == null) {
-     return;
-      }
-
-      // If building is not complete, ask the builder to select the metadata when finished
-      if (!builder.complete) {
-     builder.select_closest_metadata_value_table_entry = metadata_value_table_entry;
-     return;
-      }
-
-      // Otherwise, select the appropriate row in the table...
-      // ...but only if there actually is some metadata in the table
-      if (metadata_value_table_entries == null || metadata_value_table_entries.size() == 0) {
-     return;
-      }
-
-      // Find the position in the list where the piece of metadata should be
-      int i = 0;
-      for (i = 0; i < metadata_value_table_entries.size(); i++) {
-     if (metadata_value_table_entry.compareTo(metadata_value_table_entries.get(i)) <= 0) {
-        break;
-     }
-      }
-
-      // Ensure the position is within the current metadata
-      if (i >= metadata_value_table_entries.size()) {
-     i = metadata_value_table_entries.size() - 1;
-      }
-
-      // Select the same row as before, except if it would select a different element - in which case select the first element
-      MetadataElement metadata_element = metadata_value_table_entry.getMetadataElement();
-      MetadataValueTableEntry newly_selected_metadata_value_table_entry = (MetadataValueTableEntry) metadata_value_table_entries.get(i);
-      if (!newly_selected_metadata_value_table_entry.getMetadataElement().equals(metadata_element)) {
-     // Try one row previous
-     i--;
-     if (i < 0) {
-        Gatherer.println("Could not find suitable row to select!");
-        i = 0;
-     }
-     else {
-        newly_selected_metadata_value_table_entry = (MetadataValueTableEntry) metadata_value_table_entries.get(i);
-        if (!newly_selected_metadata_value_table_entry.getMetadataElement().equals(metadata_element)) {
-           Gatherer.println("Could not find suitable row to select!");
-           i = 0;
-        }
-     }
-      }
-
-      // We have to put the selection task onto the AWT thread
-      SwingUtilities.invokeLater(new TableRowSelectionTask(i));
+     MetadataValueTableModelBuilder builder = new MetadataValueTableModelBuilder();
+     builder.run();
+      }
    }
 
 
    private class MetadataValueTableModelBuilder
-      extends Thread
-   {
-      public boolean complete = false;
-      public MetadataValueTableEntry select_closest_metadata_value_table_entry = null;
-
+   {
       public void run()
       {
-     if (!Gatherer.c_man.ready()) {
-        Gatherer.println("Not ready!");
-        return;
-     }
-
      // Build a list of MetadataValueTableEntries that represent the metadata asssigned to the selected files
-     metadata_value_table_entries.clear();
      boolean hid_extracted_metadata = false;
      boolean has_inherited_metadata = false;
@@ -220 +149 @@
         }
 
-        ArrayList extracted_metadata = DocXMLFileManager.getMetadataExtractedFromFile(current_file);
-        for (int k = 0; k < extracted_metadata.size(); k++) {
-           MetadataValue metadata_value = (MetadataValue) extracted_metadata.get(k);
-
-           // Insert this metadata value into the table, unless it already exists (in which case increment its count)
-           insertMetadataValueIntoTable(metadata_value);
+        // Get the extracted metadata for this file, if desired
+        if (Gatherer.config.get("general.view_extracted_metadata", Configuration.COLLECTION_SPECIFIC) == true) {
+           ArrayList extracted_metadata = DocXMLFileManager.getMetadataExtractedFromFile(current_file);
+           for (int k = 0; k < extracted_metadata.size(); k++) {
+          MetadataValue metadata_value = (MetadataValue) extracted_metadata.get(k);
+
+          // Insert this metadata value into the table, unless it already exists (in which case increment its count)
+          insertMetadataValueIntoTable(metadata_value);
+           }
         }
      }
@@ -244 +176 @@
            insertMetadataValueIntoTable(metadata_value_table_entry);
         }
-     }
-
-     // Processing complete
-     complete = true;
-
-     // If while processing we've been asked to select a certain metadata, do it now
-     if (select_closest_metadata_value_table_entry != null) {
-        selectClosestMetadataValueTableEntryWhenBuildingComplete(select_closest_metadata_value_table_entry);
      }
 
@@ -320 +244 @@
       }
    }
-
-
-   /** Little utility class for selecting a row in the table, on the AWT thread. */
-   private class TableRowSelectionTask
-      extends Thread
-   {
-      private int row_to_select;
-
-      public TableRowSelectionTask(int row_to_select)
-      {
-     this.row_to_select = row_to_select;
-      }
-
-      public void run()
-      {
-     Rectangle cell_rect = metadata_value_table.getCellRect(row_to_select, 0, true);
-     metadata_value_table.scrollRectToVisible(cell_rect);
-     metadata_value_table.setRowSelectionInterval(row_to_select, row_to_select);
-      }
-   }
 }

trunk/gli/src/org/greenstone/gatherer/metadata/MetadataXMLFile.java

@@ -4 +4 @@
 import java.io.*;
 import java.util.*;
+import org.greenstone.gatherer.util.XMLTools;
 import org.w3c.dom.*;
 
@@ -65 +66 @@
       // Convert the file path into a regular expression that will match it
       String file_path_regexp = file_relative_path.replaceAll("\\.", "\\\\.");
+      if (file_relative_path.equals("")) {
+     file_path_regexp = DIRECTORY_FILENAME;
+      }
+
+      // Create a new Metadata element to record this metadata
+      Element new_metadata_value_element = document.createElement(METADATA_ELEMENT);
+      new_metadata_value_element.setAttribute("name", metadata_value.getMetadataElement().getFullName());
+      new_metadata_value_element.setAttribute("mode", (metadata_value.isAccumulatingMetadata() ? "accumulate" : "override"));
+      new_metadata_value_element.appendChild(document.createTextNode(metadata_value.getFullValue()));
+      boolean have_added_metadata = false;
 
       // Read all the FileSet elements in the file
@@ -70 +81 @@
       for (int i = 0; i < fileset_elements_nodelist.getLength(); i++) {
      Element current_fileset_element = (Element) fileset_elements_nodelist.item(i);
-     boolean current_fileset_matches = false;
 
      // Check the FileName elements of the FileSet to see if we have a match
@@ -80 +90 @@
         // Only exact matches can be extended with new metadata
         if (current_filename_element_value.equals(file_path_regexp)) {
-           current_fileset_matches = true;
+           // Append the new Metadata element to the Description element of this FileSet
+           Element description_element = (Element) current_fileset_element.getElementsByTagName(DESCRIPTION_ELEMENT).item(0);
+
+           // Accumulating metadata: add at the end
+           if (metadata_value.isAccumulatingMetadata()) {
+          description_element.appendChild(new_metadata_value_element);
+           }
+           // Override metadata: add at the start (so it overrides inherited metadata without affecting other assigned metadata)
+           else {
+          description_element.insertBefore(new_metadata_value_element, description_element.getFirstChild());
+           }
+
+           have_added_metadata = true;
            break;
         }
      }
-
-     // The FileSet doesn't apply, so move onto the next one
-     if (current_fileset_matches == false) {
-        continue;
-     }
-
-     // Create a new Metadata element to record this metadata
-     Element new_metadata_value_element = document.createElement(METADATA_ELEMENT);
-     new_metadata_value_element.setAttribute("name", metadata_value.getMetadataElement().getFullName());
-     new_metadata_value_element.appendChild(document.createTextNode(metadata_value.getFullValue()));
+      }
+
+      // Check if the metadata was added to an existing FileSet
+      if (!have_added_metadata) {
+     // It wasn't, so create a new FileSet element for it
+     Element new_fileset_element = document.createElement(FILESET_ELEMENT);
+
+     Element new_filename_element = document.createElement(FILENAME_ELEMENT);
+     new_filename_element.appendChild(document.createTextNode(file_path_regexp));
+     new_fileset_element.appendChild(new_filename_element);
 
      // Append the new Metadata element to the Description element of this FileSet
-     Element description_element = (Element) current_fileset_element.getElementsByTagName(DESCRIPTION_ELEMENT).item(0);
-     description_element.appendChild(new_metadata_value_element);
-      }
-
-      // Write the metadata.xml file
+     Element new_description_element = document.createElement(DESCRIPTION_ELEMENT);
+     new_description_element.appendChild(new_metadata_value_element);
+     new_fileset_element.appendChild(new_description_element);
+
+     document.getDocumentElement().appendChild(new_fileset_element);
+      }
+
+      // Rewrite the metadata.xml file
       XMLTools.writeXMLFile(this, document);
    }
@@ -181 +206 @@
         }
 
-        // Add the new metadata value to the list
         MetadataValue metadata_value = new MetadataValue(metadata_element, metadata_value_tree_node);
         if (is_folder_level_metadata && !file_relative_path.equals("")) {
            metadata_value.inheritsMetadataFromFolder(metadata_xml_file_directory);
         }
+
+        // Is this accumulating metadata?
+        if (current_metadata_element.getAttribute("mode").equals("accumulate")) {
+           metadata_value.setIsAccumulatingMetadata(true);
+        }
+
+        // Add the new metadata value to the list
         metadata_values.add(metadata_value);
      }
@@ -212 +243 @@
       // Convert the file path into a regular expression that will match it
       String file_path_regexp = file_relative_path.replaceAll("\\.", "\\\\.");
+      if (file_relative_path.equals("")) {
+     file_path_regexp = DIRECTORY_FILENAME;
+      }
 
       // Read all the FileSet elements in the file
@@ -261 +295 @@
       }
 
-      // Write the metadata.xml file
+      // Rewrite the metadata.xml file
       XMLTools.writeXMLFile(this, document);
    }

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

@@ -5 +5 @@
 import java.util.*;
 import org.greenstone.gatherer.file.FileNode;
+import org.greenstone.gatherer.util.Utility;
+import org.greenstone.gatherer.util.XMLTools;
 
 
@@ -20 +22 @@
 
      // Find which metadata.xml file needs editing
+     boolean applicable_metadata_xml_file_found = false;
      File current_file_directory = (current_file.isDirectory() ? current_file : current_file.getParentFile());
      for (int j = 0; j < metadata_xml_files.size(); j++) {
@@ -26 +29 @@
         // This metadata.xml file is only potentially applicable if it is above or at the same level as the file
         if (current_file_directory.getAbsolutePath().startsWith(metadata_xml_file.getParentFile().getAbsolutePath())) {
+           applicable_metadata_xml_file_found = true;
            metadata_xml_file.addMetadata(current_file, metadata_value);
         }
+     }
+
+     // If no applicable metadata.xml file exists, we have to create a new one
+     if (!applicable_metadata_xml_file_found) {
+        // Create a new (empty) metadata.xml file in the file's directory...
+        File new_metadata_xml_file_file = new File(current_file_directory, "metadata.xml");
+        XMLTools.writeXMLFile(new_metadata_xml_file_file, Utility.parse("xml/metadata.xml", true));
+
+        // ...load it...
+        MetadataXMLFile new_metadata_xml_file = loadMetadataXMLFile(new_metadata_xml_file_file);
+
+        // ...and add the metadata
+        new_metadata_xml_file.addMetadata(current_file, metadata_value);
      }
       }
@@ -42 +59 @@
    {
       // Build up a list of metadata values assigned to this file
-      ArrayList metadata_values = new ArrayList();
+      ArrayList metadata_values_all = new ArrayList();
 
       // Look at each loaded metadata.xml file to see if any assign metadata to this file
@@ -51 +68 @@
      // This metadata.xml file is only potentially applicable if it is above or at the same level as the file
      if (file_directory.getAbsolutePath().startsWith(metadata_xml_file.getParentFile().getAbsolutePath())) {
-        metadata_values.addAll(metadata_xml_file.getMetadataAssignedToFile(file));
+        ArrayList metadata_values = metadata_xml_file.getMetadataAssignedToFile(file);
+        for (int j = 0; j < metadata_values.size(); j++) {
+           MetadataValue metadata_value = (MetadataValue) metadata_values.get(j);
+
+           // Overriding metadata: remove any values with this metadata element
+           if (metadata_value.isAccumulatingMetadata() == false) {
+          for (int k = metadata_values_all.size() - 1; k >= 0; k--) {
+             if (((MetadataValue) metadata_values_all.get(k)).getMetadataElement().equals(metadata_value.getMetadataElement())) {
+            metadata_values_all.remove(k);
+             }
+          }
+           }
+
+           metadata_values_all.add(metadata_value);
+        }
      }
       }
 
-      return metadata_values;
+      return metadata_values_all;
    }
 
@@ -75 +106 @@
 
 
-   static private void loadMetadataXMLFile(File metadata_xml_file_file)
+   static private MetadataXMLFile loadMetadataXMLFile(File metadata_xml_file_file)
    {
       MetadataXMLFile metadata_xml_file = new MetadataXMLFile(metadata_xml_file_file.getAbsolutePath());
       metadata_xml_files.add(metadata_xml_file);
+      return metadata_xml_file;
    }
 
@@ -95 +127 @@
         // This metadata.xml file is only potentially applicable if it is above or at the same level as the file
         if (current_file_directory.getAbsolutePath().startsWith(metadata_xml_file.getParentFile().getAbsolutePath())) {
-           System.err.println("Applicable metadata.xml file: " + metadata_xml_file.getAbsolutePath());
            metadata_xml_file.removeMetadata(current_file, metadata_value);
         }