Changeset 6879

Timestamp:

2004-02-24T13:09:55+13:00 (20 years ago)

Author:

mdewsnip

Message:

Renamed GDM* classes to MetadataXMLFile*, for our sanity.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• collection/Collection.java (modified) (4 diffs)
• collection/CollectionManager.java (modified) (3 diffs)
• file/FileQueue.java (modified) (3 diffs)
• gui/GUIManager.java (modified) (5 diffs)
• msm/LegacyCollectionImporter.java (modified) (2 diffs)
• msm/MetadataSetManager.java (modified) (3 diffs)
• msm/MetadataXMLFile.java (added)
• msm/MetadataXMLFileManager.java (added)
• msm/MetadataXMLFileParser.java (added)
• undo/UndoManager.java (modified) (3 diffs)
• util/Utility.java (modified) (1 diff)

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

@@ -50 +50 @@
 import org.greenstone.gatherer.file.FileNode;
 import org.greenstone.gatherer.msm.ElementWrapper;
-import org.greenstone.gatherer.msm.GDMManager;
+import org.greenstone.gatherer.msm.MetadataXMLFileManager;
 import org.greenstone.gatherer.msm.MetadataSetManager;
 import org.greenstone.gatherer.msm.MSMUtils;
@@ -67 +67 @@
     public CollectionDesignManager cdm;
     /** A reference to the Greenstone Directory Metadata Manager. */
-    public GDMManager gdm;
+    public MetadataXMLFileManager gdm;
     /** A reference to the Metadata Set Manager. */
     public MetadataSetManager msm;
@@ -109 +109 @@
      * @see org.greenstone.gatherer.Gatherer
      * @see org.greenstone.gatherer.cdm.CollectionDesignManager
-     * @see org.greenstone.gatherer.msm.GDMManager
+     * @see org.greenstone.gatherer.msm.MetadataXMLFileManager
      * @see org.greenstone.gatherer.msm.MetadataSetManager
      */
@@ -162 +162 @@
     }
 
-    public GDMManager getGDM() {
+    public MetadataXMLFileManager getGDM() {
     return gdm;
     }

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

@@ -61 +61 @@
 import org.greenstone.gatherer.gui.tree.WorkspaceTree;
 import org.greenstone.gatherer.msm.ElementWrapper;
-import org.greenstone.gatherer.msm.GDMManager;
+import org.greenstone.gatherer.msm.MetadataXMLFileManager;
 import org.greenstone.gatherer.msm.GreenstoneArchiveParser;
 import org.greenstone.gatherer.msm.LegacyCollectionImporter;
@@ -426 +426 @@
         }
 
-        collection.gdm = new GDMManager();
+        collection.gdm = new MetadataXMLFileManager();
 
         progress.setProgress(3);
@@ -872 +872 @@
         }
 
-        // Whether the collection is legacy or not, we should now be able to prepared the GDMManager
-        collection.gdm = new GDMManager();
+        // Whether the collection is legacy or not, we should now be able to prepare the MetadataXMLFileManager
+        collection.gdm = new MetadataXMLFileManager();
 
         // Tell everyone that it worked.

trunk/gli/src/org/greenstone/gatherer/file/FileQueue.java

@@ -39 +39 @@
 import org.greenstone.gatherer.gui.LongProgressBar;
 import org.greenstone.gatherer.gui.tree.DragTree;
-import org.greenstone.gatherer.msm.GDMManager;
+import org.greenstone.gatherer.msm.MetadataXMLFileManager;
 import org.greenstone.gatherer.undo.UndoManager;
 import org.greenstone.gatherer.util.ArrayTools;
@@ -442 +442 @@
                     if (job.source.toString().equals("Collection")) {
                     ///ystem.err.println("Move within collection...");
-                    GDMManager gdm = Gatherer.c_man.getCollection().gdm;
+                    MetadataXMLFileManager gdm = Gatherer.c_man.getCollection().gdm;
                     // we just retrieve the metadata attached to the origin node...
                     ArrayList existing_metadata = gdm.getMetadataOnly(source_file);
@@ -454 +454 @@
                 // If it came from the recycle bin retrieve the metadata from there, once again remembering to account for inherited metadata
                     else if (job.source.toString().equals("Undo")) {
-                    GDMManager gdm = Gatherer.c_man.getCollection().gdm;
+                    MetadataXMLFileManager gdm = Gatherer.c_man.getCollection().gdm;
                     // Retrieve metadata from the recycle bin
                     ArrayList existing_metadata = Gatherer.c_man.undo.getMetadata(source_file);

trunk/gli/src/org/greenstone/gatherer/gui/GUIManager.java

@@ -122 +122 @@
     /** The main tab pane containing the different views, available here to trap view change events. */
     private JTabbedPane tab_pane = null;
-    /** A reference to any existing search and replace module/dialog. */
-    // private SearchAndReplace sar = null;
     /** A threaded tab changer to try and avoid NPE on exit. */
     private TabUpdater tab_updater = null;
@@ -135 +133 @@
     private TreeSynchronizer workspace_tree_sync = null;
     /**Constructor. Enable window events and arranges all other components.
-      * @param size The intial <strong>Dimension</strong> of the screen.
-      */
+     * @param size The intial <strong>Dimension</strong> of the screen.
+     */
     public GUIManager(Dimension size) {
     super();
@@ -173 +171 @@
 
     /** Any implementation of <i>ActionListener</i> must include this method so that we can be informed when an action has occured. In this case we are listening to actions from the menu-bar, and should react appropriately.
-      * @param event An <strong>ActionEvent</strong> containing information about the action that has occured.
-      */
+     * @param event An <strong>ActionEvent</strong> containing information about the action that has occured.
+     */
     public void actionPerformed(ActionEvent event) {
     boolean cont = true;
@@ -220 +218 @@
     }
     else if(esrc == menu_bar.file_options) {
-         // Just incase the user has edited the GeneralSettings of a collection without losing focus afterwards. Well I'm forever losing foc... ooh shiney.
-         design_pane.loseFocus();
-         // And spawn a new preferences.
+        // Just incase the user has edited the GeneralSettings of a collection without losing focus afterwards. Well I'm forever losing foc... ooh shiney.
+        design_pane.loseFocus();
+        // And spawn a new preferences.
         new Preferences();
     }
@@ -366 +364 @@
 //          browser_pane.afterDisplay();
 //      }
-    if(mirror_pane != null) {
+    if (mirror_pane != null) {
         mirror_pane.afterDisplay();
     }

trunk/gli/src/org/greenstone/gatherer/msm/LegacyCollectionImporter.java

@@ -182 +182 @@
                     element_ew = null;
                 }
-                // If the raw name is null now, we have been instructed to ignore this metadata, so we can delete it from the metadata.xml (GDMDocument would do this anyway when it tried to save)
+                // If the raw name is null now, we have been instructed to ignore this metadata, so we can delete it from the metadata.xml (MetadataXMLFile would do this anyway when it tried to save)
                 else {
                     // Retrieve the parent node
@@ -257 +257 @@
                         changed = true;
                     } 
-                    // Cancel only skips the current metadata.xml file - actually I'll ignore the file on a cancel, as otherwise it will bugger up GDMManager when it starts up
+                    // Cancel only skips the current metadata.xml file - actually I'll ignore the file on a cancel, as otherwise it will bugger up MetadataXMLFileManager when it starts up
                     else {
                         // Confirm the cancel, informing the user that the metadata.xml will be completely ignored if they continue

trunk/gli/src/org/greenstone/gatherer/msm/MetadataSetManager.java

@@ -86 +86 @@
     private ExistingMetadataLoader loader = null;
     /** Specialized parser for parsing GreenstoneDirectoryMetadata files, which not only caches entries, but also breaks up massive metadata.xml files into reasonable sizes. */
-    private GDMParser gdm_parser = null;
+    private MetadataXMLFileParser gdm_parser = null;
     /** A list of classes who are interested in changes to the loaded metadata sets. */
     private Vector listeners = null;
@@ -92 +92 @@
     /** Constructor. */
     public MetadataSetManager() {
-    this.gdm_parser = new GDMParser();
+    this.gdm_parser = new MetadataXMLFileParser();
     this.listeners = new Vector();
     this.loader = new ExistingMetadataLoader();
@@ -1088 +1088 @@
 
     /** Add a reference to a piece of metadata to the given FileNode. The whole method gets a wee bit messy as we have to allow for several different commands from users such as accumulate / overwrite, skip just this file or cancel the whole batch. Cancelling is especially problematic as we need to rollback any changes (within reason).
-     * It is also worth mentioning that despite its name, no actual metadata is added directly by this method. Instead a call to fireMetadataChanged() is issued, which is in turn processed by the GDMManager (which, given this method may have been called from GDMManager as well, means the cycle is complete. Um, that doesn't mean theres an infinite loop... I hope).
+     * It is also worth mentioning that despite its name, no actual metadata is added directly by this method. Instead a call to fireMetadataChanged() is issued, which is in turn processed by the MetadataXMLFileManager (which, given this method may have been called from MetadataXMLFileManager as well, means the cycle is complete. Um, that doesn't mean theres an infinite loop... I hope).
      * @param id a long unique identifier shared by all actions caused by the same gesture.
      * @param record the FileNode we are adding the metadata to.

trunk/gli/src/org/greenstone/gatherer/undo/UndoManager.java

@@ -51 +51 @@
 import org.greenstone.gatherer.file.FileQueue;
 import org.greenstone.gatherer.file.FileSystemModel;
-import org.greenstone.gatherer.msm.GDMDocument;
+import org.greenstone.gatherer.msm.MetadataXMLFile;
 import org.greenstone.gatherer.msm.Metadata;
 import org.greenstone.gatherer.msm.MSMEvent;
@@ -75 +75 @@
     private FileQueue file_queue;
     private FileSystemModel model;
-    private GDMDocument obsolete_metadata;
+    private MetadataXMLFile obsolete_metadata;
     /** What sort of action should a drag resemble. Not really used as we override with custom drag icon. */
     private int drag_action = DnDConstants.ACTION_MOVE;
@@ -104 +104 @@
     }
     this.model = new FileSystemModel(new FileNode(recycle_directory, "Undo"));
-    obsolete_metadata = new GDMDocument(); // This GDM is never saved.
+    obsolete_metadata = new MetadataXMLFile(); // This GDM is never saved.
     redo = new UndoStack(false);
     redo_sources = new ArrayList();

trunk/gli/src/org/greenstone/gatherer/util/Utility.java

@@ -254 +254 @@
         return true;
     }
-    // A file not found exception is most likely thrown because the directory the metadata.xml file is attempting to be written to no longer has any files in it. I'll add a test in GDMDocument to test for this, but if it still happens ignore it (a non-existant directory can't really have metadata added to it any way.
+    // A file not found exception is most likely thrown because the directory the metadata.xml file is attempting to be written to no longer has any files in it. I'll add a test in MetadataXMLFile to test for this, but if it still happens ignore it (a non-existant directory can't really have metadata added to it any way.
     catch (Exception exception) {
         if(!file.getName().endsWith(METADATA_XML)) {