Changeset 5847

Timestamp:

2003-11-14T15:03:33+13:00 (20 years ago)

Author:

mdewsnip

Message:

A much improved workspace tree that only refreshes when it really needs to (and only refreshes what it really needs to). This should prevent the five second plus refreshes on slow machines.

I'm planning to tidy up the collection tree in a similar way, when I get time.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• WGet.java (modified) (2 diffs)
• collection/CollectionManager.java (modified) (12 diffs)
• collection/Job.java (modified) (2 diffs)
• file/FileQueue.java (modified) (1 diff)
• file/FileSystem.java (added)
• file/WorkspaceTreeModel.java (added)
• gui/CollectionPane.java (modified) (6 diffs)
• gui/GUIManager.java (modified) (4 diffs)
• gui/MirrorPane.java (modified) (1 diff)
• gui/Preferences.java (modified) (2 diffs)
• gui/tree/DragTree.java (modified) (2 diffs)
• gui/tree/WorkspaceTree.java (added)

trunk/gli/src/org/greenstone/gatherer/WGet.java

@@ -254 +254 @@
      * @see org.greenstone.gatherer.util.GURL
      */
-    public void newJob(TreeModel model, boolean overwrite, boolean no_parents, boolean other_hosts, boolean page_requisites, URL url, int depth, String destination) {
+    public void newJob(/* TreeModel model, */ boolean overwrite, boolean no_parents, boolean other_hosts, boolean page_requisites, URL url, int depth, String destination) {
     // Create the job and fill in the details from gatherer.config.
     Gatherer.println("About to create a new job");
@@ -261 +261 @@
         destination = destination + url.getHost();
     }
-    Job new_job = new Job(model, overwrite, Gatherer.config.get("mirroring.debug", false), no_parents, other_hosts, page_requisites, Gatherer.config.get("mirroring.quiet", false), url, depth, destination, Gatherer.config.proxy_pass, Gatherer.config.proxy_user, this, simple);
+    Job new_job = new Job(/* model, */ overwrite, Gatherer.config.get("mirroring.debug", false), no_parents, other_hosts, page_requisites, Gatherer.config.get("mirroring.quiet", false), url, depth, destination, Gatherer.config.proxy_pass, Gatherer.config.proxy_user, this, simple);
     // Add to job_queue job list.
     job_queue.add(new_job);

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

@@ -55 +55 @@
 import org.greenstone.gatherer.gui.ExternalCollectionPrompt;
 import org.greenstone.gatherer.gui.NewMetaSetPrompt;
+import org.greenstone.gatherer.gui.tree.WorkspaceTree;
 import org.greenstone.gatherer.msm.ElementWrapper;
 import org.greenstone.gatherer.msm.GDMManager;
@@ -92 +93 @@
     private boolean importing = false;
     /** The collection this manager is managing! */
-    private Collection collection = null;
+    static private Collection collection = null;
     /** The collection_model. */
     private FileSystemModel collection_model = null;
     /** The workspace model. This becomes invalid on a collection change. */
-    private FileSystemModel workspace_model = null;
+    // 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;
@@ -137 +138 @@
         collection.addDirectoryMapping(name, file);
         // Now update the tree
-        FileSystemModel model = (FileSystemModel) Gatherer.g_man.collection_pane.getWorkspaceTree().getModel();
-        FileNode parent = (FileNode) model.getRoot();
-        FileNode target = new FileNode(file, name);
-        SynchronizedTreeModelTools.insertNodeInto(model, parent, target);
+        Gatherer.g_man.collection_pane.refreshWorkspaceTree(WorkspaceTree.MAPPED_DIRECTORIES_CHANGED);
     }
     }
@@ -207 +205 @@
     collection = null;
     collection_model = null;
-    workspace_model = null;
+    // workspace_model = null;
     undo.clear();
     Gatherer.config.setCollectionConfiguration(null);
@@ -420 +418 @@
     // Done.
     if(Gatherer.g_man != null) {
-        workspace_model = null;
+        // workspace_model = null;
         // set the view to Gather pane
         Gatherer.g_man.setSelectedView(Gatherer.g_man.collection_pane);
@@ -611 +609 @@
     return collection_model;
     }
-    /** Create and return the model behind the workspace tree. Quite an extensive method, as it must first map known greenstone collections, then the local file system and finally any public or private download workspaces. */
-    public TreeModel getWorkspace() {
-    ///ystem.err.println("Get Workspace");
-    if(workspace_model != null) {
-        return workspace_model;
-    }
-    // Determine the local collection directory if any
-    String current_collection_directory = null;
-    if(collection != null) {
-        current_collection_directory = Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName();
-    }
-    // Create the workspace tree.
-    FileNode workspace_root = new FileNode("ABS_ROOT");
-    workspace_model = new FileSystemModel(workspace_root);
-    // Create and add Greenstone collections node.
-    // Starting at the collection directory of gsdl...
-    FileNode world_root = new FileNode(Dictionary.get("Tree.World"));
-    world_root.unmap();
-    workspace_root.insert(world_root);
-    // Create Local File space.
-    // Get all the available roots mounted on the system.
-    File roots[] = File.listRoots();
-    // If there is just one root use it as the tree root (linux)
-    if(roots != null) {
-        FileNode file_root;
-        String name = Dictionary.get("Tree.Root");
-        if(roots.length == 1) {
-        file_root = new FileNode(roots[0], name);
-        workspace_root.insert(file_root);
-        }
-        // Otherwise build a dummy node which has these nodes as children.
-        else {
-        file_root = new FileNode(name);
-        workspace_root.insert(file_root);
-        // Hopefully this does an alphabetic sort.
-        ArrayTools.sort(roots);
-        for(int i = 0; i < roots.length; i++) {
-           // Only add root if it isn't a floppy drive.
-           if(!FileSystemView.getFileSystemView().isFloppyDrive(roots[i])) {
-              FileNode child_root = new FileNode(roots[i]);
-              file_root.insert(child_root);
-              child_root = null;
-           }
-        }
-        }
-        name = null;
-        file_root = null;
-    }
-    
-    // Now if we can determine user home folder information, generate a 'special mapping' to it
-    String home_folder_str = System.getProperty("user.home");
-    if(home_folder_str != null && home_folder_str.length() > 0) {
-        File home_folder = new File(home_folder_str);
-        String[] args = new String[1];
-        args[0] = home_folder.getName();
-        FileNode home_folder_node = new FileNode(home_folder, Dictionary.get("Tree.Home", args));
-        workspace_root.insert(home_folder_node);
-    }
-
-    // If mirroring is enabled show the public and private caches.
-    if(Gatherer.config.get("workflow.mirror", false)) {
-        // Add Public workspace
-        FileNode public_root = new FileNode(new File(Utility.CACHE_DIR), Dictionary.get("Tree.Public"));
-        workspace_root.insert(public_root);
-        // Add Private workspace if a collection has been loaded.
-        if(ready()) {
-        FileNode private_root = new FileNode(new File(getCollectionCache()), Dictionary.get("Tree.Private"));
-        workspace_root.insert(private_root);
-        }
-    }
-    // Finally we retrieve and map any predefined special directories.
-    if(ready()) {
-        HashMap mappings = collection.getDirectoryMappings();
-        for(Iterator names = mappings.keySet().iterator(); names.hasNext(); ) {
-        String name = (String) names.next();
-        File file = (File) mappings.get(name);
-        FileNode special_root = new FileNode(file, name);
-        //workspace_root.insert(special_root);
-        SynchronizedTreeModelTools.insertNodeInto(workspace_model, workspace_root, special_root);
-        }
-    }
-    ///ystem.err.println("Returning for getWorkspace()");
-    return workspace_model;
-    }
+
+
+    static public FileNode getGreenstoneCollectionsMapping()
+    {
+    FileNode greenstone_collections_node = new FileNode(Dictionary.get("Tree.World"));
+    greenstone_collections_node.unmap();
+    return greenstone_collections_node;
+    }
+
+
+    static public FileNode[] getCollectionSpecificMappings()
+    {
+    if (!ready()) {
+        return null;
+    }
+
+    // Return any predefined special directories
+    HashMap mappings = collection.getDirectoryMappings();
+    FileNode[] mapping_nodes = new FileNode[mappings.size()];
+    Iterator mappings_iterator = mappings.keySet().iterator();
+    for (int i = 0; mappings_iterator.hasNext(); i++) {
+        String mapping_name = (String) mappings_iterator.next();
+        File mapping_file = (File) mappings.get(mapping_name);
+        mapping_nodes[i] = new FileNode(mapping_file, mapping_name);
+    }
+
+    return mapping_nodes;
+    }
+
+
     /** This method when called, creates a new GShell in order to run the import.pl script.
      * @see org.greenstone.gatherer.Configuration
@@ -855 +799 @@
         // We're done. Let everyone know.
         if(Gatherer.g_man != null) {
-        workspace_model = null;
+        // workspace_model = null;
         Gatherer.g_man.collectionChanged(ready());
         }
@@ -1097 +1041 @@
         //}
         // Signal collection changed.
-        workspace_model = null;
+        // workspace_model = null;
         Gatherer.g_man.collectionChanged(ready());
         JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Preview_Ready"), Dictionary.get("CollectionManager.Preview_Ready_Title"), JOptionPane.INFORMATION_MESSAGE);
@@ -1109 +1053 @@
      * @return A <i>boolean</i> which is <i>true</i> to indicate a collection has been loaded and thus the collection is ready for editing, <i>false</i> otherwise.
      */
-    public synchronized boolean ready() {
+    static public synchronized boolean ready() {
     if(collection != null) {
         return true;
@@ -1142 +1086 @@
     /** Refresh the Greenstone Collections special mapping in the workspace tree to account for collections being added/removed
      */
-    public void refreshGreenstoneCollections() {
-    FileNode root = (FileNode) workspace_model.getRoot();
+    public void refreshGreenstoneCollections()
+    {
+    Gatherer.g_man.collection_pane.refreshWorkspaceTree(WorkspaceTree.COLLECTION_CHANGED);
+
+    /* FileNode root = (FileNode) workspace_model.getRoot();
     FileNode greenstone_collections_node = null;
     int root_child_count = root.getChildCount();
@@ -1161 +1108 @@
         greenstone_collections_path = null;
         greenstone_collections_node = null;
-    }
-    }
-
-    /** Called to refresh the models upon which the trees are based.
-     * @see org.greenstone.gatherer.collection.Collection
-     */
-    public void refreshTrees() {
-    }
+        } */
+    }
+
     /** This method associates the collection build monitor with the build monitor created in CreatePane.
      * @param monitor A <strong>GShellProgressMonitor</strong> which we will use as the build monitor.
@@ -1197 +1139 @@
         file = collection.removeDirectoryMapping(target.toString());
         // Update tree.
-        FileSystemModel model = (FileSystemModel) Gatherer.g_man.collection_pane.getWorkspaceTree().getModel();
-        SynchronizedTreeModelTools.removeNodeFromParent(model, target);
+        Gatherer.g_man.collection_pane.refreshWorkspaceTree(WorkspaceTree.MAPPED_DIRECTORIES_CHANGED);
     }
     return file;

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

@@ -68 +68 @@
     private GURL url = null;
 
-    private TreeModel model;
+    // private TreeModel model;
 
     private int depth;
@@ -91 +91 @@
     /**
      */
-    public Job(TreeModel model, boolean clobber, boolean debug, boolean no_parents, boolean other_hosts, boolean page_requisites, boolean quiet, URL initial, int depth, String destination, String proxy_pass, String proxy_user, WGet mummy, boolean simple) {
-    this.model = model;
+    public Job(/* TreeModel model, */ boolean clobber, boolean debug, boolean no_parents, boolean other_hosts, boolean page_requisites, boolean quiet, URL initial, int depth, String destination, String proxy_pass, String proxy_user, WGet mummy, boolean simple) {
+    // this.model = model;
 
     this.debug = debug;

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

@@ -596 +596 @@
             // Force the trees to refresh (but only if there is something on screen!)
             if(Gatherer.g_man != null) {
-                Gatherer.g_man.refreshTrees();
+                Gatherer.g_man.refreshTrees(DragTree.COLLECTION_CONTENTS_CHANGED);
             }
             // Reset status area

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

@@ -53 +53 @@
 import org.greenstone.gatherer.gui.GComboBox;
 import org.greenstone.gatherer.gui.tree.DragTree;
+import org.greenstone.gatherer.gui.tree.WorkspaceTree;
 import org.greenstone.gatherer.undo.UndoManager;
 import org.greenstone.gatherer.util.DragComponent;
@@ -71 +72 @@
     private DragTree collection_tree         =  null;
     /** The tree showing the available source workspace. */
-    private DragTree workspace_tree          =  null;
+    private WorkspaceTree workspace_tree     =  null;
     /** The threaded queue that handles the actually movement of files, so that the gui remains responsive. */
     private FileQueue file_queue          =  null;
@@ -243 +244 @@
     collection_tree_sync.add(collection_tree);
 
-    refreshWorkspace();
+    refreshWorkspaceTree(DragTree.COLLECTION_CHANGED);
+    refreshCollectionTree(DragTree.COLLECTION_CHANGED);
 
     // Enable or disable the control buttons
@@ -250 +252 @@
     new_folder.setEnabled(ready);
     }
+
     /** Generates the pane on controls used to 'collect' files into the collection. Resposible for creating, connecting and laying out these controls. */
     public void display() {
@@ -269 +272 @@
     Dictionary.registerText(workspace_label, "Collection.Workspace");
 
-    workspace = Gatherer.c_man.getWorkspace();
-    workspace_tree = new DragTree(Utility.WORKSPACE_TREE, workspace, null, true);
+    workspace_tree = new WorkspaceTree(Utility.WORKSPACE_TREE);
     group.add(workspace_tree);
     workspace_tree.addFocusListener(this);
@@ -491 +493 @@
     }
 
-    public DragTree getWorkspaceTree() {
-    return workspace_tree;
-    }
-
-    public void refreshTrees() {
+
+    public void refreshCollectionTree(int refresh_reason)
+    {
     collection_tree.refresh(null);
-    workspace_tree.refresh(null);
-    }
-
-    public void refreshWorkspace() {
-    workspace = Gatherer.c_man.getWorkspace();
-    workspace_tree.setModel(workspace);
-    workspace_tree_sync.add(workspace_tree);
-    }
+    }
+
+
+    public void refreshWorkspaceTree(int refresh_reason)
+    {
+    workspace_tree.refresh(refresh_reason);
+    }
+
+
+    /* public void refreshWorkspace() {
+    System.err.println("CollectionPane::refreshWorkspace()... (ignored)");
+    // workspace = Gatherer.c_man.getWorkspace();
+    // workspace_tree.setModel(workspace);
+    // workspace_tree_sync.add(workspace_tree);
+    } */
 
 

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

@@ -72 +72 @@
 import org.greenstone.gatherer.gui.metaaudit.MetaAuditFrame;
 import org.greenstone.gatherer.gui.tree.DragTree;
+import org.greenstone.gatherer.gui.tree.WorkspaceTree;
 import org.greenstone.gatherer.help.HelpFrame;
 import org.greenstone.gatherer.msm.ElementWrapper;
@@ -359 +360 @@
     create_pane.collectionChanged(ready); // Used to indicate a new BuildOptions model should be loaded.
     preview_pane.collectionChanged(ready); // preview should know when teh coll has changed so it can reload the home page
-    // Force tree model updates.
-    Gatherer.c_man.refreshTrees();
+
     if(!locked) {
                 // Now enable tabs as necessary. Do this on event queue to prevent crazy NPEs
@@ -533 +533 @@
     }
 
-    public void refreshTrees() {
-    collection_pane.refreshTrees();
-    //metaedit_pane.refreshTrees();
+    public void refreshTrees(int refresh_reason)
+    {
+    collection_pane.refreshWorkspaceTree(refresh_reason);
+    collection_pane.refreshCollectionTree(refresh_reason);
+    metaedit_pane.refreshTrees();
     }
 
@@ -580 +582 @@
     // If the rawname was mirror then rebuild workspace tree to remove caches.
     if(rawname.equals("Mirroring")) {
-        collection_pane.refreshWorkspace();
+        collection_pane.refreshWorkspaceTree(WorkspaceTree.MAPPED_DIRECTORIES_CHANGED);
     }
     }

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

@@ -208 +208 @@
         if(url != null) {
         // Otherwise construct a new download job
-        getter.newJob(Gatherer.c_man.getWorkspace(), overwrite_checkbox.isSelected(), !higher_checkbox.isSelected(), !same_host_checkbox.isSelected(), automatic_checkbox.isSelected(), url, ((Integer)depth_spinner.getValue()).intValue(), (public_radiobutton.isSelected() ? Utility.CACHE_DIR : Gatherer.c_man.getCollectionCache()));
+        getter.newJob(/* Gatherer.c_man.getWorkspace(), */ overwrite_checkbox.isSelected(), !higher_checkbox.isSelected(), !same_host_checkbox.isSelected(), automatic_checkbox.isSelected(), url, ((Integer)depth_spinner.getValue()).intValue(), (public_radiobutton.isSelected() ? Utility.CACHE_DIR : Gatherer.c_man.getCollectionCache()));
         }
     }

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

@@ -15 +15 @@
 import org.greenstone.gatherer.gui.ModalDialog;
 import org.greenstone.gatherer.gui.SimpleMenuBar;
+import org.greenstone.gatherer.gui.tree.DragTree;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
@@ -428 +429 @@
         // General preferences
         Gatherer.config.set("general.show_file_size", Configuration.COLLECTION_SPECIFIC, show_file_size_checkbox.isSelected());
-        Gatherer.g_man.collection_pane.refreshTrees();
-        Gatherer.g_man.metaedit_pane.refreshTrees();
+        Gatherer.g_man.refreshTrees(DragTree.TREE_DISPLAY_CHANGED);
 
         Gatherer.config.set("general.view_extracted_metadata", Configuration.COLLECTION_SPECIFIC, view_extracted_metadata_checkbox.isSelected());

trunk/gli/src/org/greenstone/gatherer/gui/tree/DragTree.java

@@ -54 +54 @@
     static private final int AUTOSCROLL_MARGIN = 12;
 
+    static public int COLLECTION_CHANGED          = 1;
+    static public int COLLECTION_CONTENTS_CHANGED = 2;
+    static public int TREE_DISPLAY_CHANGED        = 3;
+
+
     public DragTree(String name, String background_name, boolean mixed_selection) {
     super();
@@ -452 +457 @@
 
     public void refresh(TreePath path) {
-    ((FileSystemModel)treeModel).refresh(path);
+    if (treeModel instanceof FileSystemModel) {
+        ((FileSystemModel)treeModel).refresh(path);
+    }
+    else {
+        // System.err.println("DragTree::refresh - Tree model is " + treeModel);
+    }
     }