Changeset 8313 for trunk/gli/src/org/greenstone/gatherer/collection

Timestamp:

2004-10-13T14:48:20+13:00 (20 years ago)

Author:

mdewsnip

Message:

Finally committing the (many) changes to the GLI to use the new metadata code... I hope this doesn't have too many bugs in it and committing it now doesn't stuff anyone up! (Katherine said I could commit it, so blame her if anything goes wrong).

Location:

trunk/gli/src/org/greenstone/gatherer/collection

Files:

• Collection.java (modified) (5 diffs)
• CollectionManager.java (modified) (46 diffs)
• LegacyCollectionImporter.java (added)
• SaveCollectionTask.java (modified) (8 diffs)

trunk/gli/src/org/greenstone/gatherer/collection/Collection.java

@@ -48 +48 @@
 import org.greenstone.gatherer.cdm.CollectionMetaManager;
 import org.greenstone.gatherer.file.FileNode;
-import org.greenstone.gatherer.msm.MetadataXMLFileManager;
-import org.greenstone.gatherer.msm.MetadataSetManager;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
@@ -64 +62 @@
     /** A reference to the Collection Design Manager. */
     public CollectionDesignManager cdm;
-    /** A reference to the Greenstone Directory Metadata Manager. */
-    public MetadataXMLFileManager gdm;
-    /** A reference to the Metadata Set Manager. */
-    public MetadataSetManager msm;
     /** true if an error has occurred during construction */
     public boolean error = false;
@@ -119 +113 @@
     public void destroy() {
     cdm.destroy();
-    gdm.destroy();
-    msm.destroy();
     Configuration.setCollectionConfiguration(null);
     if (Gatherer.g_man != null) {
@@ -127 +119 @@
     cdm = null;
     document = null;
-    gdm = null;
-    msm = null;
     }
     
@@ -170 +160 @@
     }
 
-    public MetadataXMLFileManager getGDM() {
-    return gdm;
-    }
-    
     /** Retrieve the short name for this collection.
      * @return The name as a <strong>String</strong>.

trunk/gli/src/org/greenstone/gatherer/collection/CollectionManager.java

@@ -62 +62 @@
 import org.greenstone.gatherer.gui.WarningDialog;
 import org.greenstone.gatherer.gui.tree.WorkspaceTree;
-import org.greenstone.gatherer.msm.ElementWrapper;
-import org.greenstone.gatherer.msm.MetadataXMLFileManager;
-import org.greenstone.gatherer.msm.GreenstoneArchiveParser;
-import org.greenstone.gatherer.msm.LegacyCollectionImporter;
-import org.greenstone.gatherer.msm.MetadataSet;
-import org.greenstone.gatherer.msm.MetadataSetManager;
-import org.greenstone.gatherer.msm.MSMEvent;
-import org.greenstone.gatherer.msm.MSMListener;
-import org.greenstone.gatherer.msm.MSMProfiler;
+import org.greenstone.gatherer.metadata.DocXMLFileManager;
+import org.greenstone.gatherer.metadata.MetadataSet;
+import org.greenstone.gatherer.metadata.MetadataSetManager;
+import org.greenstone.gatherer.metadata.MetadataXMLFileManager;
+import org.greenstone.gatherer.metadata.ProfileXMLFileManager;
 import org.greenstone.gatherer.shell.GShell;
 import org.greenstone.gatherer.shell.GShellEvent;
@@ -89 +85 @@
  */
 public class CollectionManager
-    implements GShellListener, MSMListener {
-    /** A reference to the metadata set manager. */
-    public MetadataSetManager msm;
+    implements GShellListener {
+
     /** Are we currently in the process of building? */
     private boolean building = false;
@@ -100 +95 @@
     /** The collection_model. */
     private FileSystemModel collection_model = null;
-    /** The workspace model. This becomes invalid on a collection change. */
-    // private FileSystemModel workspace_model = null;
     /** An inner class listener responsible for noting tree changes and resetting saved when they occur. */
     private FMTreeModelListener fm_tree_model_listener = null;
@@ -127 +120 @@
     this.collection = null;
     }
+
+
     /** Add a special directory mapping.
      * @param name The name for this directory mapping as a <strong>String</strong>.
      * @param file The directory this mapping maps to as a <strong>File</strong>.
      */
-    public void addDirectoryMapping(String name, File file) {
+    public void addDirectoryMapping(String name, File file)
+    {
     // Update the information stored in the Gatherer config
     Configuration.addDirectoryMapping(name, file);
@@ -137 +133 @@
     Gatherer.g_man.refreshWorkspaceTree(WorkspaceTree.FOLDER_SHORTCUTS_CHANGED);
     }
+
+
     /** This method calls the builcol.pl scripts via a GShell so as to not lock up the processor.
      * @see org.greenstone.gatherer.Configuration
@@ -147 +145 @@
      * @see org.greenstone.gatherer.util.Utility
      */
-    public void buildCollection() {
+    private void buildCollection() {
     DebugStream.println("CollectionManager.buildCollection()");
     building = true;
@@ -227 +225 @@
     lock_file.delete();
     if(lock_file.exists()) {
-       System.err.println("Lockfile was not successfully deleted.");
-    }
-    collection.msm.destroy();
+        System.err.println("Lockfile was not successfully deleted.");
+    }
+
+    MetadataSetManager.clearMetadataSets();
+    MetadataXMLFileManager.clearMetadataXMLFiles();
+    DocXMLFileManager.clearDocXMLFiles();
+    ProfileXMLFileManager.clearProfileXMLFile();
+
     collection = null;
     collection_model = null;
@@ -324 +327 @@
      * @param metadata_sets if the user has decided to select several metadata sets with which to initially populate the GLI then this is an ArrayList of metadata set file names, otherwise its null
      */
-    public void createCollection(String description, String email, String name, String title, File base_collection_directory, ArrayList metadata_sets) {
-    boolean cancelled = false;
-
+    public void createCollection(String description, String email, String name, String title, File base_collection_directory, ArrayList metadata_sets)
+    {
     try {
         // first make sure that the collect directory exists
@@ -340 +342 @@
         // *******************
         //check that this creation has worked - simply by checking for the existence of the collect.cfg file
-        String a_dir;
+        String collection_dir;
         if (Gatherer.GS3) {
-        a_dir = Utility.getCollectionDir(Configuration.gsdl3_path, Configuration.site_name, name);
+        collection_dir = Utility.getCollectionDir(Configuration.gsdl3_path, Configuration.site_name, name);
         } else {
-        a_dir = Utility.getCollectionDir(Configuration.gsdl_path, name);
-        }
-        File config_file = new File(Utility.getConfigFile(a_dir));
+        collection_dir = Utility.getCollectionDir(Configuration.gsdl_path, name);
+        }
+        File config_file = new File(Utility.getConfigFile(collection_dir));
         if (!config_file.exists()) {
         // no point continuing
@@ -356 +358 @@
         
         // ACTIVE_DIR/log/
-        File log_dir_temp = new File(Utility.getLogDir(a_dir)+"temp.dat");
+        File log_dir_temp = new File(Utility.getLogDir(collection_dir)+"temp.dat");
         File log_dir = log_dir_temp.getParentFile();
         log_dir.mkdirs();
@@ -364 +366 @@
 
         // Make sure an import folder exists
-        File import_directory = new File(Utility.getImportDir(a_dir));
+        File import_directory = new File(Utility.getImportDir(collection_dir));
         if (!import_directory.exists()) {
         import_directory.mkdirs();
@@ -372 +374 @@
 
         // Now create the collection object around the directory.
-        collection = new Collection(new File(a_dir, name + ".col"));
-        collection.msm = new MetadataSetManager();
-        msm = collection.msm; // Legacy
-        collection.msm.load();
-
-        // Import default metadata sets if any.
-        for(int i = 0; metadata_sets != null && i < metadata_sets.size(); i++) {
-        MetadataSet metadata_set = (MetadataSet) metadata_sets.get(i);
-        collection.msm.importMDS(metadata_set.getFile(), false);
-        }
-
-        boolean skip_import_phase = false;
+        collection = new Collection(new File(collection_dir, name + ".col"));
+
+        MetadataSetManager.clearMetadataSets();
+        MetadataXMLFileManager.clearMetadataXMLFiles();
+        DocXMLFileManager.clearDocXMLFiles();
+
+        // Import default metadata sets, if any
+        for (int i = 0; metadata_sets != null && i < metadata_sets.size(); i++) {
+        importMetadataSet((MetadataSet) metadata_sets.get(i));
+        }
+
+        ProfileXMLFileManager.loadProfileXMLFile(new File(collection_dir, Utility.META_DIR));
 
         // Before we create the CollectionDesignManager we have to check if we are basing it upon some other collection.
-        if(base_collection_directory != null) {
-           DebugStream.println("Basing new collection on existing one: " + base_collection_directory);
-           collection.setBaseCollection(base_collection_directory.getAbsolutePath());
-           // copy over other needed directories
-           copyExtraBaseCollStuff(new File(a_dir), base_collection_directory);
-        // Try to import any existing metadata sets for this collection. Look in base_collection_directory/metadata and import any metadata sets found.
-        File base_metadata = new File(base_collection_directory, Utility.META_DIR);
-        if(base_metadata.exists()) {
-            DebugStream.println("Found the metadata directory.");
-            File[] possible_metadata_sets = base_metadata.listFiles();
-            for(int i = 0; possible_metadata_sets != null && i < possible_metadata_sets.length; i++) {
-            String filename = possible_metadata_sets[i].getName();
-            if(filename.endsWith(".mds")) {
-                DebugStream.println("+ Found a metadata set. Importing: " + possible_metadata_sets[i].getAbsolutePath());
-                collection.msm.importMDS(possible_metadata_sets[i], false);
-                skip_import_phase = true;
-            }
+        if (base_collection_directory != null) {
+        DebugStream.println("Basing new collection on existing one: " + base_collection_directory);
+        collection.setBaseCollection(base_collection_directory.getAbsolutePath());
+        // copy over other needed directories
+        copyExtraBaseCollStuff(new File(collection_dir), base_collection_directory);
+        // Try to import any existing metadata sets for this collection
+        // Look in base_collection_directory/metadata and import any metadata sets found.
+        File base_metadata_directory = new File(base_collection_directory, Utility.META_DIR);
+        ArrayList base_metadata_sets = MetadataSetManager.listMetadataSets(base_metadata_directory);
+        if (base_metadata_sets != null) {
+            for (int i = 0; i < base_metadata_sets.size(); i++) {
+            importMetadataSet((MetadataSet) base_metadata_sets.get(i));
             }
         }
@@ -408 +405 @@
             DebugStream.println("This base collection has no metadata directory.");
         }
-        // If no sets were imported, then create a new metadata with this new collections name.
-        if(collection.msm.getSets().size() == 0) {
+
+        // If no sets were imported...
+        if (MetadataSetManager.getMetadataSets().size() == 0) {
             // Prompt the user so that they can choose at least one initial metadata set. We're sneaky here and just create a ncm_prompt
             DebugStream.println("This collection has no metadata sets. Present the user with the metadata set selection prompt.");
             NewCollectionMetadataPrompt ncm_prompt = new NewCollectionMetadataPrompt();
             // If cancelled then they really do mean to start a collection with no metadata sets.
-            if(!ncm_prompt.isCancelled()) {
+            if (!ncm_prompt.isCancelled()) {
             ArrayList initial_sets = ncm_prompt.getSets();
-            for(int i = 0; initial_sets != null && i < initial_sets.size(); i++) {
-                MetadataSet metadata_set = (MetadataSet) initial_sets.get(i);
-                collection.msm.importMDS(metadata_set.getFile(), false);
-                metadata_set = null;
+            for (int i = 0; initial_sets != null && i < initial_sets.size(); i++) {
+                importMetadataSet((MetadataSet) initial_sets.get(i));
             }
-            initial_sets = null;
             }
             ncm_prompt.dispose();
             ncm_prompt = null;
         }
-        // Do a dry metadata import run over the entire base collection, recording profile mappings. We do this by finding the archive files, and then iterating over them using the GreenstoneArchiveParser to retrieve metadata from them. We then process the importing of new metadata elements using the selectElement prompt used in a file action metadata import. However the big change is that we don't actually import any metadata, just create importing profiles.
-        if(!skip_import_phase) {
-            File base_archive = new File(base_collection_directory, Utility.ARCHIVES_DIR);
-            if(base_archive.exists()) {
-            DebugStream.println("+ Archive directory found. Inspecting archives for metadata information.");
-            ArrayList metadata_elements = GreenstoneArchiveParser.extractMetadataElements(base_archive);
-            for(int i = 0; !cancelled && i < metadata_elements.size(); i++) {
-                String metadata_name = (String) metadata_elements.get(i);
-                ElementWrapper target = collection.msm.prompt.selectElement(metadata_name);
-                cancelled = Gatherer.c_man.getCollection().msm.prompt.wasDialogCancelled();
-                if(!cancelled) {
-                if(target != null) {
-                    collection.msm.profiler.addAction(base_collection_directory.getAbsolutePath(), metadata_name, target.getName());
-                }
-                else {
-                    collection.msm.profiler.addAction(base_collection_directory.getAbsolutePath(), metadata_name, null);
-                }
-                }
-            }
-            // Hopefully mappings should now be in place for metadata extracted from this collection.
-            }
-            else {
-            DebugStream.println("+ Searching files for metadata.xml information.");
-            // Find the import directory
-            File base_import = new File(base_collection_directory, Utility.IMPORT_DIR);
-            if(base_import.exists()) {
-                searchForMetadata(base_import);
-            }
-            }
-        }
-        // And if that fails then we must have been asked by Satan himself to build the very digital collections of hell, because they don't match any goodly greenstone collection I have ever seen, so you can't blame me if I can't import them.
 
         // Now we update our collect.cfg
         DebugStream.println("Copy and update collect.cfg from base collection.");
-        updateCollectionCFG(new File(base_collection_directory, Utility.CONFIG_FILE), new File(a_dir, Utility.CONFIG_FILE), description, email, title);
+        updateCollectionCFG(new File(base_collection_directory, Utility.CONFIG_FILE), new File(collection_dir, Utility.CONFIG_FILE), description, email, title);
         }
 
         // Always import the extracted metadata set if we didn't already
-        if(collection.msm.getSet(Utility.EXTRACTED_METADATA_NAMESPACE) == null) {
-           collection.msm.importMDS(new File(Utility.METADATA_DIR + Utility.EXTRACTED_METADATA_NAMESPACE + StaticStrings.METADATA_SET_EXTENSION), false);
+        if (MetadataSetManager.getMetadataSet(MetadataSetManager.EXTRACTED_METADATA_NAMESPACE) == null) {
+        File extracted_metadata_set_file = new File(Utility.METADATA_DIR + Utility.EXTRACTED_METADATA_NAMESPACE + StaticStrings.METADATA_SET_EXTENSION);
+        importMetadataSet(new MetadataSet(extracted_metadata_set_file));
         }
 
         collection.cdm = new CollectionDesignManager(new File(getCollectionConfig()));
-        
+
         // Now that we have a CDM, update several settings, such as if we created this collection by basing it on another, set it as public automatically
-        if(base_collection_directory != null) {
+        if (base_collection_directory != null) {
         // Update the creator and maintainer
         CollectionMeta creator_collectionmeta = new CollectionMeta(collection.cdm.collect_config.getCreator());
@@ -479 +444 @@
         maintainer_collectionmeta.setValue(email);
         maintainer_collectionmeta = null;
+
         // Update the collection title
         CollectionMeta collection_name_collectionmeta = collection.cdm.collectionmeta_manager.getMetadatum(StaticStrings.COLLECTIONMETADATA_COLLECTIONNAME_STR);
         collection_name_collectionmeta.setValue(title);
         collection_name_collectionmeta = null;
+
         // And now the description
         CollectionMeta collection_extra_collectionmeta = collection.cdm.collectionmeta_manager.getMetadatum(StaticStrings.COLLECTIONMETADATA_COLLECTIONEXTRA_STR);
         collection_extra_collectionmeta.setValue(description);
         collection_extra_collectionmeta = null;
+
         // All collections based on others are automatically public
         CollectionMeta public_collectionmeta = new CollectionMeta(collection.cdm.collect_config.getPublic());
         public_collectionmeta.setValue(StaticStrings.TRUE_STR);
         public_collectionmeta = null;
+
         // Finally reset the icons
         CollectionMeta icon_collection_collectionmeta = collection.cdm.collectionmeta_manager.getMetadatum(StaticStrings.COLLECTIONMETADATA_ICONCOLLECTION_STR);
@@ -499 +468 @@
         icon_collection_small_collectionmeta = null;
         }
-        
-        collection.gdm = new MetadataXMLFileManager();
 
         progress.setProgress(3);
 
-        // Has to be done after creating metadata set manager.
-        File gmeta_dir_temp = new File(getCollectionMetadata()+"temp.dat");
-        File gmeta_dir = gmeta_dir_temp.getParentFile();
-        gmeta_dir.mkdirs();
-        if(progress != null) {
-        progress.setNote("GMeta created");
-        }
-        progress.setProgress(4);
-
-        progress.setProgress(6);
-        // Register ourselves as being interested in what the msm has to say.
-        collection.msm.addMSMListener(this);
         // Create a lock file.
-        File lock_file = new File(a_dir, LOCK_FILE);
+        File lock_file = new File(collection_dir, LOCK_FILE);
         FileOutputStream out = new FileOutputStream(lock_file);
         out.write(LOCK_FILE.getBytes());
         out.close();
         out = null;
+
         progress.setProgress(7);
-        String args[] = new String[1];
-        args[0] = name;
-        progress.setNote(Dictionary.get("CollectionManager.Session_Ready", args));
+        progress.setNote(Dictionary.get("CollectionManager.Session_Ready", name));
         progress.close();
     }
@@ -543 +497 @@
     }
     }
+
 
     public void createLockFile(File destination) {
@@ -569 +524 @@
     }
 
-    /** Method that is called whenever an element within a set is changed or modified. We want to mark the collection so that it needs saving again.
-     * @param event A <strong>MSMEvent</strong> containing details of the event that caused this message to be fired.
-     * @see org.greenstone.gatherer.collection.Collection
-     */
-    public void elementChanged(MSMEvent event) {
-    // This means the state of the collections has changed, so we should set saved to false.
-    collection.setSaved(false);
-    }
-    /** Used to retrieve the build options associated with the currently loaded collection. If none yet exist, default ones are created.
-     * @return A <strong>BuildOptions</strong> object containing the build options for the current collection.
-     * @see org.greenstone.gatherer.collection.Collection
-     */
-    /* private BuildOptions getBuildOptions() {
-    return collection.build_options;
-    } */
 
     /** Retrieve the current collection.
@@ -591 +531 @@
     return collection;
     }
+
+
     /** Constructs the absolute filename of the collection archive directory, which should resemble "$GSDLHOME/collect/&lt;col_name&gt;/archive/"
      * @return A <strong>String</strong> containing the filename.
@@ -630 +572 @@
         return Utility.getConfigFile(Utility.getCollectionDir(Configuration.gsdl3_path, Configuration.site_name, collection.getName()));
     } else {
-    return Utility.getConfigFile(Utility.getCollectionDir(Configuration.gsdl_path, collection.getName()));
+        return Utility.getConfigFile(Utility.getCollectionDir(Configuration.gsdl_path, collection.getName()));
     }
     }
@@ -660 +602 @@
         return Utility.getEtcDir(Utility.getCollectionDir(Configuration.gsdl3_path, Configuration.site_name, collection.getName()));
     } else {
-    return Utility.getEtcDir(Utility.getCollectionDir(Configuration.gsdl_path, collection.getName()));
+        return Utility.getEtcDir(Utility.getCollectionDir(Configuration.gsdl_path, collection.getName()));
     }
     }
@@ -674 +616 @@
         return Utility.getCollectionDir(Configuration.gsdl3_path, Configuration.site_name, collection.getName()) + collection.getName() + ".col";
     } else {
-    return Utility.getCollectionDir(Configuration.gsdl_path, collection.getName()) + collection.getName() + ".col";
+        return Utility.getCollectionDir(Configuration.gsdl_path, collection.getName()) + collection.getName() + ".col";
     }
     }
@@ -688 +630 @@
         return Utility.getImagesDir(Utility.getCollectionDir(Configuration.gsdl3_path, Configuration.site_name, collection.getName()));
     } else {
-    return Utility.getImagesDir(Utility.getCollectionDir(Configuration.gsdl_path, collection.getName()));
+        return Utility.getImagesDir(Utility.getCollectionDir(Configuration.gsdl_path, collection.getName()));
     }
     }
@@ -748 +690 @@
     }
 
-    /** This method either returns the title of the current collection, or a placeholder string of 'No Collection'.
-     * @return A <strong>String</strong> which represents what we wish to display for a collection title.
-     * @see org.greenstone.gatherer.collection.Collection
-     */
-    /* private String getCollectionTitle() {
-    if(collection != null) {
-        return collection.getTitle();
-    }
-    return Dictionary.get("Collection.No_Collection");
-    } */
+
+    static public String getCollectionMetadataDirectory()
+    {
+    if (Gatherer.GS3) {
+        return Utility.getMetadataDir(Utility.getCollectionDir(Configuration.gsdl3_path, Configuration.site_name, collection.getName()));
+    } else {
+        return Utility.getMetadataDir(Utility.getCollectionDir(Configuration.gsdl_path, collection.getName()));
+    }
+    }
+    
 
     /** Retrieve the record set (tree model) associated with the current collection. */
@@ -827 +769 @@
         index_dir = index_dir.getParentFile();
         if(index_dir.exists()) {
-           DebugStream.println("Old Index = " + index_dir.getAbsolutePath()+", testing for deletability");
-           if (!canDelete(index_dir)) {
-           // tell the user
-           JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Delete_Index"), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE); 
-           // tell the gui manager
-           // a message for the building log 
-           GShellEvent event = new GShellEvent(this, 0, GShell.IMPORT, Dictionary.get("CollectionManager.Cannot_Delete_Index_Log"), GShell.ERROR);
-           Gatherer.g_man.create_pane.message(event);
-           event = new GShellEvent(this, 0, GShell.IMPORT, "", GShell.ERROR);
-           Gatherer.g_man.create_pane.processComplete(event);
-           importing = false;
-           return;
-           }
-           
+        DebugStream.println("Old Index = " + index_dir.getAbsolutePath()+", testing for deletability");
+        if (!canDelete(index_dir)) {
+            // tell the user
+            JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Delete_Index"), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE); 
+            // tell the gui manager
+            // a message for the building log 
+            GShellEvent event = new GShellEvent(this, 0, GShell.IMPORT, Dictionary.get("CollectionManager.Cannot_Delete_Index_Log"), GShell.ERROR);
+            Gatherer.g_man.create_pane.message(event);
+            event = new GShellEvent(this, 0, GShell.IMPORT, "", GShell.ERROR);
+            Gatherer.g_man.create_pane.processComplete(event);
+            importing = false;
+            return;
+        }
         }
 
@@ -879 +820 @@
     }
 
+
+    public void importMetadataSet(MetadataSet external_metadata_set)
+    {
+    // Copy the .mds file into the collection's "metadata" folder...
+    File external_metadata_set_file = external_metadata_set.getMetadataSetFile();
+
+    // ...but not if it is the redundant "hidden.mds" file
+    if (external_metadata_set_file.getName().equals("hidden.mds")) {
+        return;
+    }
+
+    // ...and only if it doesn't already exist
+    File metadata_set_file = new File(getCollectionMetadata(), external_metadata_set_file.getName());
+    if (!metadata_set_file.exists()) {
+        try {
+        Gatherer.f_man.getQueue().copyFile(external_metadata_set_file, metadata_set_file, null);
+        }
+        catch (Exception ex) {
+        ex.printStackTrace();
+        }
+
+        // Load it into the MetadataSetManager
+        MetadataSetManager.loadMetadataSet(metadata_set_file);
+    }
+    }
+
+
     /** Determine if we are currently in the middle of importing (and thus, in this case, we can't allow the log writer to exit). Boy was this a mission to track down. The cascade of crap rolls out something like this: Joe Schmo clicks 'Build Collection', which calls the importCollection() method above, which in turn saves the collection with a saveTask, which fires a collectionChanged message once its finished, which drives the list of logs shown on the create pane to update, which fires a itemChanged() event to the OptionsPane who dutifully tells the current log writer thread to finish up writing (all zero lines its been asked to write) and then die. Wereapon Joe Schmo gets a pretty log to look at, but it isn't actually being written to file so the next time he tries to view it faeces hits the air motion cooling device. Joy.
      * @return true if the gli is currently importing
@@ -891 +859 @@
      * @see org.greenstone.gatherer.Gatherer
      * @see org.greenstone.gatherer.collection.Collection
-     * @see org.greenstone.gatherer.msm.MetadataSetManager
-     * @see org.greenstone.gatherer.msm.MSMListener
      * @see org.greenstone.gatherer.util.Utility
      */
-    public boolean loadCollection(String location) {
-    DebugStream.println("Load Collection '" + location + "'");
-    String[] args2 = new String[1];
-    args2[0] = location;
-    boolean result = false;
+    public boolean loadCollection(String location)
+    {
+    DebugStream.println("Loading collection " + location + "...");
     boolean non_gatherer_collection = false;
+
     // Check we have actually been given a .col file.
-    if(!location.endsWith(".col")) {
-        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Not_Col_File", args2), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
+    if (!location.endsWith(".col")) {
+        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Not_Col_File", location), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
         DebugStream.println("CollectionManager.loadCollection: Haven't been given a .col file.");
         return false;
     }
+
     // Check that there is the collection configuration file available
-
     File collection_file = new File(location);
     // Ensure that the directory exists.
     File collection_directory = collection_file.getParentFile();
-    if(!collection_directory.exists()) {
+    if (!collection_directory.exists()) {
         // we cant open this
         collection_directory = null;
@@ -926 +891 @@
 
     // Special case of a user trying to open an old greenstone collection.
-    File metadata_directory = new File(collection_directory, Utility.META_DIR);
-    if(!metadata_directory.exists()) {
-
-        DebugStream.println("CollectionManager.loadCollection: trying to load up a non-gatherer collection");
+    File collection_metadata_directory = new File(collection_directory, Utility.META_DIR);
+    if (!collection_metadata_directory.exists()) {
+        DebugStream.println("Loading non-gatherer collection...");
         non_gatherer_collection = true;
     }
 
+    // Now determine if a lock already exists on this collection.
     String name = collection_directory.getName();
     File lock_file = new File(collection_file.getParentFile(), LOCK_FILE);
-    // Now determine if a lock already exists on this collection.
-    int choice = LockFileDialog.YES_OPTION;
-    if(lock_file.exists()) {
+    if (lock_file.exists()) {
         LockFileDialog dialog = new LockFileDialog(Gatherer.g_man, name, lock_file);
-        choice = dialog.getChoice();
+        int choice = dialog.getChoice();
         dialog.dispose();
         dialog = null;
-    }
-
-    if(choice != LockFileDialog.YES_OPTION) {
-        // user has cancelled
-        lock_file = null;
-        collection_directory = null;
-        collection_config_file = null;
-        return false;
-    }
-
-
+
+        if (choice != LockFileDialog.YES_OPTION) {
+        // user has cancelled
+        lock_file = null;
+        collection_directory = null;
+        collection_config_file = null;
+        return false;
+        }
+
+        lock_file.delete();
+    }
+
+    boolean result = false;
     try {
-        if(lock_file.exists()) {
-        lock_file.delete();
-        }
         // Create a lock file.
         createLockFile(lock_file);
@@ -964 +926 @@
         System.err.println("Cannot write lock file!");
         String args[] = new String[2];
-        args[0] = args2[0];
+        args[0] = location;
         args[1] = Dictionary.get("FileActions.Write_Not_Permitted_Title");
         JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Open_With_Reason", args), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
@@ -970 +932 @@
         return false;
         }
+
         // Open the collection file
         this.collection = new Collection(collection_file);
@@ -975 +938 @@
         collection = null;
         // Remove lock file
-        if(lock_file.exists()) {
+        if (lock_file.exists()) {
             lock_file.delete();
         }
@@ -981 +944 @@
         }
 
-        collection.msm = new MetadataSetManager();
-        msm = collection.msm; // Legacy
-        collection.msm.load();
-        // if non-gatherer collection, need to add some metadata sets
+        MetadataSetManager.clearMetadataSets();
+        MetadataSetManager.loadMetadataSets(collection_metadata_directory);
+
+        ProfileXMLFileManager.loadProfileXMLFile(collection_metadata_directory);
+ 
+        // If this is a non-GLI (legacy) collection, ask the user to choose some metadata sets
         if (non_gatherer_collection) {
         if (!addSomeMetadataSets(collection_directory)) {
-            // for now - return of false means its been cancelled. Any error messages should be sent from the function itself
             lock_file = null;
             collection_directory = null;
@@ -993 +957 @@
             return false;
         }
-        }
+
+        // Recurse the import folder tree, backing up the metadata.xml files before they are edited
+        LegacyCollectionImporter.backupMetadataXMLFiles(collection_directory);
+        }
+
+        // Read through the metadata.xml files in the import directory, building up the metadata value trees
+        File collection_import_directory = new File(collection_directory, Utility.IMPORT_DIR);
+        MetadataXMLFileManager.clearMetadataXMLFiles();
+        MetadataXMLFileManager.loadMetadataXMLFiles(collection_import_directory);
+
+        // Read through the doc.xml files in the archives directory
+        File collection_archives_directory = new File(collection_directory, Utility.ARCHIVES_DIR);
+        DocXMLFileManager.clearDocXMLFiles();
+        DocXMLFileManager.loadDocXMLFiles(collection_archives_directory);
 
         collection.cdm = new CollectionDesignManager(collection_config_file);
         if (non_gatherer_collection) {
-        // We first recurse the Import folder tree, reading in any metadata.xml files, and then altering the non-namespaced element names to be valid GLI names
-        LegacyCollectionImporter lci = new LegacyCollectionImporter(collection_directory, collection.cdm);
-        lci.backupMetadataXMLFiles(collection_directory);
-        lci.importMetadata();
-        lci.updateClassifiers();
-        lci = null;
-        }
-        // Whether the collection is legacy or not, we should now be able to prepare the MetadataXMLFileManager
-        collection.gdm = new MetadataXMLFileManager();
+        // Change the classifiers to use the namespaced element names
+        LegacyCollectionImporter.updateClassifiers(collection.cdm);
+        }
 
         // Tell everyone that it worked.
-        String[] args = new String[1];
-        args[0] = name;
-        DebugStream.println(Dictionary.get("CollectionManager.Loading_Successful", args));
-        // Now we need to hook up classes that depend on messages from the metadata set manager to keep their content fresh.
-        collection.msm.addMSMListener(this);
+        DebugStream.println(Dictionary.get("CollectionManager.Loading_Successful", name));
+
         // We're done. Let everyone know.
-        if(Gatherer.g_man != null) {
-        // workspace_model = null;
+        if (Gatherer.g_man != null) {
         Gatherer.g_man.collectionChanged(ready());
         }
         result = true;
-    } catch (Exception error) {
+    }
+    catch (Exception error) {
         // There is obviously no existing collection present.
         DebugStream.printStackTrace(error);
         if(error.getMessage() != null) {
         String[] args = new String[2];
-        args[0] = args2[0];
+        args[0] = location;
         args[1] = error.getMessage();
         JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Open_With_Reason", args), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
         }
         else {
-        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Open", args2), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
+        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Open", location), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
         }
     }
@@ -1037 +1005 @@
     collection_config_file = null;
 
-    args2 = null;
     return result;
     }
@@ -1147 +1114 @@
     public synchronized void message(GShellEvent event) {
     }
-    /** Called whenever the metadata value changes in some way, such as the addition of a new value. We want to mark the collection so that it needs saving again.
-     * @param event A <strong>MSMEvent</strong> containing details of the event that caused this message to be fired.
-     * @see org.greenstone.gatherer.collection.Collection
-     */
-    public void metadataChanged(MSMEvent event) {
-    // Again this change means we need to save the collection again.
-    collection.setSaved(false);
-    }
+
     /** This call is fired whenever a process within a GShell created by this class begins.
      * @param event A <strong>GShellEvent</strong> containing information about the GShell process.
@@ -1282 +1242 @@
     return file;
     }
+
+
+    public void removeMetadataSet(MetadataSet metadata_set)
+    {
+    System.err.println("Removing metadata set...");
+
+    // Delete the .mds file from the collection's "metadata" folder...
+    File metadata_set_file = metadata_set.getMetadataSetFile();
+
+    // ...but not if it is the "ex.mds" file
+    if (metadata_set_file.getName().equals("ex.mds")) {
+        return;
+    }
+
+    // ...and only if it exists
+    if (metadata_set_file.exists()) {
+        metadata_set_file.delete();
+
+        // Unload it from the MetadataSetManager
+        MetadataSetManager.unloadMetadataSet(metadata_set);
+    }
+    }
+
+
     /** Used to check whether all open collections have a 'saved' state.
      * @return A <i>boolean</i> which is <i>true</i> if the collection has been saved.
@@ -1313 +1297 @@
     }
 
-    /** Method that is called whenever the metadata set collection changes in some way, such as the addition of a new set or the merging of two sets. We want to mark the collection so that it needs saving again.
-     * @param event A <strong>MSMEvent</strong> containing details of the event that caused this message to be fired.
-     * @see org.greenstone.gatherer.collection.Collection
-     */
-    public void setChanged(MSMEvent event) {
-    // Invalidate saved
-    collection.setSaved(false);
-    }
-
     public void setClosingThread(boolean set) {
     if(set) {
@@ -1331 +1306 @@
     }
 
-    /** Updates the given workspace tree model to reference the private cache of the currently loaded collection. */
-    /* private void updatePrivateWorkspace(DefaultTreeModel model) {
-    // Add Private workspace if a collection has been loaded.
-    if(ready() && !Configuration.get("workflow.mirror", true)) {
-        FileNode root = (FileNode)model.getRoot();
-                // Remove old private workspace
-        FileNode old = (FileNode)model.getChild(root, 2);
-        model.removeNodeFromParent(old);
-                // Create and insert new.
-        FileNode private_workspace = new FileNode(new File(getCollectionCache()), Dictionary.get("Tree.Private"));
-        model.insertNodeInto(private_workspace, root, 2);
-    }
-    } */
-    /** Called whenever the value tree of an metadata element changes in some way, such as the addition of a new value. We want to mark the collection so that it needs saving again.
-     * @param event A <strong>MSMEvent</strong> containing details of the event that caused this message to be fired.
-     * @see org.greenstone.gatherer.collection.Collection
-     */
-    public void valueChanged(MSMEvent event) {
-    collection.setSaved(false);
-    }
 
     /** I started giving the user the choice of using an existing meta set or creating a new one. The second option being so that they didn't have to add/merge/ignore each element, they could all be added automatically. However, I am not sure where the merge prompt gets called from, and it is not essential, so I am leaving it for now - it should be added back in and finished. [kjdon] */
@@ -1364 +1319 @@
 
     /*if (meta_choice == ExternalCollectionPrompt.NEW_META_SET) {
-        NewMetaSetPrompt nmsp = new NewMetaSetPrompt();
-        if (nmsp.isCancelled()) {
-        return false;
-}
-        String namespace_str = nmsp.getNamespace();
-        String name_str = nmsp.getName();
-        MetadataSet set = Gatherer.c_man.msm.addSet(namespace_str, name_str);
-    } else if (meta_choice == ExternalCollectionPrompt.EXISTING_META_SET) {
+      NewMetaSetPrompt nmsp = new NewMetaSetPrompt();
+      if (nmsp.isCancelled()) {
+      return false;
+      }
+      String namespace_str = nmsp.getNamespace();
+      String name_str = nmsp.getName();
+      // MetadataSet set = Gatherer.c_man.msm.addSet(namespace_str, name_str);
+      } else if (meta_choice == ExternalCollectionPrompt.EXISTING_META_SET) {
     */
     // now we reuse the newcoll metadata prompt for the user to select metadata sets
@@ -1381 +1336 @@
     // Import default metadata sets if any.
     for(int i = 0; metadata_sets != null && i < metadata_sets.size(); i++) {
-        MetadataSet metadata_set = (MetadataSet) metadata_sets.get(i);
-        collection.msm.importMDS(metadata_set.getFile(), false);
-    }
-    /*} else {
-      return false;
-      }*/
+        importMetadataSet((MetadataSet) metadata_sets.get(i));
+    }
+
     // Always import the extracted metadata set
-    collection.msm.importMDS(new File(Utility.METADATA_DIR + Utility.EXTRACTED_METADATA_NAMESPACE + StaticStrings.METADATA_SET_EXTENSION), false);
+    File extracted_metadata_set_file = new File(Utility.METADATA_DIR + Utility.EXTRACTED_METADATA_NAMESPACE + StaticStrings.METADATA_SET_EXTENSION);
+    importMetadataSet(new MetadataSet(extracted_metadata_set_file));
 
     return true;
     }
 
-
-//      // now try to load in existing metadata, delete the existing metadata.xml files, then save the new ones.
-//      private boolean findAndLoadExistingMetadata(File collection_dir)
-//      {
-//      TreeModel collection_tree = getRecordSet();
-//      FileNode root_node = (FileNode) collection_tree.getRoot();
-//      if (searchForMetadata(collection_tree, root_node) == false) {
-//          return false;
-//      }
-//      collection.gdm.save(root_node);
-//      return true;
-//      }
 
     // used as arg in the perl scripts
@@ -1423 +1364 @@
     }
 
+
     /** Install collection by moving its files from building to index after a successful build.
      * @see org.greenstone.gatherer.Gatherer
      * @see org.greenstone.gatherer.util.Utility
      */
-    private boolean installCollection() {
+    private boolean installCollection()
+    {
     DebugStream.println("Build complete. Moving files.");
 
@@ -1506 +1449 @@
 
 
-    private boolean searchArchivesForMetadata(File archive_directory) {
-    /** @todo - ensure GreenstoneArchiveParser works as expected. */
-    return true;
-    }
-
-    /** now this returns true if successful, false if unsuccessful or cancelled */
-    private boolean searchForMetadata(File current_file) {
-    boolean success = true;
-       if(current_file.isFile() && current_file.getName().equals(Utility.METADATA_XML)) {
-           success = collection.msm.searchForMetadata(null, new FileNode(current_file), false, true); // A dummy run only.
-       }
-       else {
-           File[] children_files = current_file.listFiles();
-           for(int i = 0; success && children_files != null && i < children_files.length; i++) {
-               success = searchForMetadata(children_files[i]);
-           }
-       }
-       return success;
-     }
-    
-    private boolean searchForMetadata(TreeModel collection_tree, FileNode current_node) {
-    File source_file = current_node.getFile();
-    String source_file_name = source_file.getName();
-    if (source_file_name.equals(Utility.METADATA_XML) || source_file_name.equals("CVS")) {
-        return true;
-    }
-    if (collection.msm.searchForMetadata(current_node, current_node, false)== false) {
-        return false;
-    }
-    int num_children = collection_tree.getChildCount(current_node);
-    for (int i=0; i<num_children; i++) {
-        FileNode child = (FileNode)collection_tree.getChild(current_node, i);
-        if (searchForMetadata(collection_tree, child)==false) {
-        return false;
-        }
-    }
-    return true;
-    }
-
-    private void updateCollectionCFG(File base_cfg, File new_cfg, String description, String email, String title) {
+    private void updateCollectionCFG(File base_cfg, File new_cfg, String description, String email, String title)
+    {
     boolean first_name = true;
     boolean first_extra = true;
     String collection_path = (base_cfg.getParentFile().getParentFile()).getAbsolutePath();
-    
-    HashMap mappings = collection.msm.profiler.getActions(collection_path);
-    if(mappings == null) {
-        DebugStream.println("Mappings is null, which is odd. Leaving all configuration commands which use metadata as they are.");
-    }
-    
+
     // Now read in base_cfg line by line, parsing important onces and/or replacing them with information pertinent to our collection. Each line is then written back out to the new collect.cfg file.
     try {
@@ -1620 +1520 @@
                 text.append(token);
                 String temp_metadata = tokenizer.nextToken();
-                String replacement = null;
-                if(mappings != null) {
-                    replacement = (String) mappings.get(temp_metadata);
-                }
-                if(replacement != null) {
+                String replacement = ProfileXMLFileManager.getMetadataElementFor(temp_metadata);
+                if (replacement != null && !replacement.equals("")) {
                     token = replacement;
                     old_metadata = temp_metadata;
@@ -1641 +1538 @@
                 text.append(token);
                 String temp_metadata = tokenizer.nextToken();
-                String replacement = null;
-                if(mappings != null) {
-                    replacement = (String) mappings.get(temp_metadata);
-                }
-                if(replacement != null) {
+                String replacement = ProfileXMLFileManager.getMetadataElementFor(temp_metadata);
+                if (replacement != null && !replacement.equals("")) {
                     token = replacement;
                 }
@@ -1681 +1575 @@
             old_metadata = null;
             write(out, command);
-         } else {
-             // the rest of the commands just want a string - we read in all the tokens from the tokeniser and get rid of it.
+        } else {
+            // the rest of the commands just want a string - we read in all the tokens from the tokeniser and get rid of it.
             StringBuffer new_command = new StringBuffer(command_type_str);
             while (tokenizer.hasMoreTokens()) {
@@ -1694 +1588 @@
             // we really want to build up the whole command here
             boolean format_command = command_type_str.equals(Utility.CFG_FORMAT);
-            // Replace mapping strings
-            if(mappings != null) {
-            for(Iterator keys = mappings.keySet().iterator(); keys.hasNext(); ) {
+            HashMap metadata_mapping = ProfileXMLFileManager.getMetadataMapping();
+            if (metadata_mapping != null) {
+            Iterator keys = metadata_mapping.keySet().iterator();
+            while (keys.hasNext()) {
                 String target = (String) keys.next();
-                String replacement = (String) mappings.get(target);
-                if(format_command) {
-                target = "\\[" + target + "\\]";
-                replacement = "{Or}{[" + replacement + "]," + target + "}";
+                String replacement = (String) metadata_mapping.get(target);
+                if (replacement != null && !replacement.equals("")) {
+                if (format_command) {
+                    target = "\\[" + target + "\\]";
+                    replacement = "{Or}{[" + replacement + "]," + target + "}";
+                }
+                command = command.replaceAll(target, replacement);
                 }
-                command = command.replaceAll(target, replacement);
             }
             }
+
             write(out, command);
-         }
+        }
         tokenizer = null;
         }
@@ -1727 +1625 @@
     out.newLine();
     }
+
 
     /** The CollectionManager class is getting too confusing by half so I'll implement this TreeModelListener in a private class to make responsibility clear. */

trunk/gli/src/org/greenstone/gatherer/collection/SaveCollectionTask.java

@@ -43 +43 @@
 import org.greenstone.gatherer.DebugStream;
 import org.greenstone.gatherer.Gatherer;
+import org.greenstone.gatherer.metadata.MetadataSetManager;
 import org.greenstone.gatherer.util.Utility;
 
@@ -66 +67 @@
     static final private int COPY_COLLECTION      = 4;
     static final private int MAKE_COLLECTION      = 5;
-    static final private int METADATA_SAVED       = 6;
-    static final private int METADATA_XML_SAVED   = 7;
     static final private int OPEN_COLLECTION      = 8;
     static final private int RESTORE_COLLECTION   = 9;
@@ -112 +111 @@
     // spd.setMillisToDecideToPopup(100);
     // spd.setMillisToPopup(100);
-    // 0. Force all remaining metadata.xml files to load.
+
     // 1. Perform a regular collection save on what we will later refer to as the origin collection.
     ///ystem.err.println("1. Save origin.");
@@ -119 +118 @@
     args[0] = collection.getName() + ".col";
     try {
-        // Block until all of the metadata files have been read in.
-        collection.gdm.waitUntilComplete();
-        // Write out the metadata xml files. The destroy below is meant to do this, but never does.
-        collection.gdm.save();
-        // spd.setProgress(getValue(METADATA_XML_SAVED));
-
         File file = new File(tmp_loc);
         // Create backup
@@ -131 +124 @@
         backup.deleteOnExit();
         if(!file.renameTo(backup)) {
-            DebugStream.println("Error in CollectionManager.load(): FileRenamedException");
+            DebugStream.println("Error in SaveCollectionTask.run(): FileRenamedException");
         }
         }
@@ -143 +136 @@
         // spd.setProgress(getValue(COLLECTION_CFG_SAVED));
 
-        // Write out the metadata files.
-        Gatherer.c_man.msm.save();
-        // spd.setProgress(getValue(METADATA_SAVED));
+        // Write hfiles for the loaded metadata elements into the collection "etc" directory
+        MetadataSetManager.writeHierarchyFiles(new File(Gatherer.c_man.getCollectionEtc()));
 
         collection.setSaved(true);
@@ -307 +299 @@
         return (int)((double)70 * multiplier);
     case COLLECTION_CFG_SAVED:
-    case METADATA_SAVED:
-    case METADATA_XML_SAVED:
         return (int)((double)10 * multiplier);
         // Save As
@@ -325 +315 @@
     }
 }
-
-
-
-
-