Changeset 18364 for gli/branches/rtl-gli/src/org/greenstone/gatherer/gui/CreatePane.java

Timestamp:

2009-01-12T11:40:15+13:00 (15 years ago)

Author:

kjdon

Message:

updated the rtl-gli branch with files from trunk. Result of a merge 14807:18318, and fixed some conflicts. I think this is the last commit following merging the files. Haven't tried to compile yet... here goes...

File:

• gli/branches/rtl-gli/src/org/greenstone/gatherer/gui/CreatePane.java (modified) (20 diffs)

gli/branches/rtl-gli/src/org/greenstone/gatherer/gui/CreatePane.java

@@ -53 +53 @@
 import org.greenstone.gatherer.shell.GBuildProgressMonitor;
 import org.greenstone.gatherer.shell.GImportProgressMonitor;
+import org.greenstone.gatherer.shell.GScheduleProgressMonitor; 
 import org.greenstone.gatherer.shell.GShell;
 import org.greenstone.gatherer.shell.GShellEvent;
@@ -61 +62 @@
 import org.greenstone.gatherer.util.Utility;
 
+import org.greenstone.gatherer.collection.CollectionManager;
 
 /** This class provides a GUI view showing some statistics on your current collection, and options for building it. As the collection is built this initial view is replaced with one showing progress bars and a message log of the creation process. This log can be later accessed via the options tree located in the center of the initial pane. This class is also responsible for creating the GShellProgressMonitors that are then attatched to external shell processes, and calling the methods in the CollectionManager for actually importing and building the collection. <br><BR>
@@ -93 +95 @@
     /** This monitor tracks the import processes progress. */
     private GShellProgressMonitor import_monitor = null;
+    /** This monitor tracks the schedule processes progress. */ 
+    private GShellProgressMonitor schedule_monitor = null; 
     /** The button for begining the building processes. */
     private JButton build_button = null;
     /** The button for stopping the building processes. */
     private JButton cancel_button = null;
+    /** The button for setting up scheduling */
+    private JButton schedule_button = null; 
     /** The button for viewing the collection. */
     private JButton preview_button = null;
@@ -149 +155 @@
     public String homepage = null;
 
-
     /** The constructor creates important helper classes, and initializes all the components.
      * @see org.greenstone.gatherer.collection.CollectionManager
@@ -194 +199 @@
     Gatherer.c_man.registerBuildMonitor(build_monitor);
 
+    //We only need a schedule monitor for text output. No use for a progress bar!
+    
+    //progress_schedule_label = new JLabel(Dictionary.get("CreatePane.Schedule_Progress")); 
+    
+    schedule_monitor = new GScheduleProgressMonitor(); 
+    Gatherer.c_man.registerScheduleMonitor(schedule_monitor); 
+
     // And the simple panel
     slower_panel = new JPanel();
@@ -238 +250 @@
     }
     
+    BuildSimpleButtonListener bsbl = new BuildSimpleButtonListener(); 
     simple_build_button = new GLIButton(Dictionary.get("CreatePane.Build_Collection"), Dictionary.get("CreatePane.Build_Collection_Tooltip"));
-    simple_build_button.addActionListener(bbl);
-    
+    simple_build_button.addActionListener(bsbl);
+
     simple_cancel_button = new GLIButton(Dictionary.get("CreatePane.Cancel_Build"), Dictionary.get("CreatePane.Cancel_Build_Tooltip"));
     simple_cancel_button.addActionListener(cbl);
@@ -255 +268 @@
     
     bbl = null;
+    bsbl = null; 
     cbl = null;
     //pbl = null;
@@ -375 +389 @@
         sargument_configuration_panel = options_pane.buildImport(null);
         sargument_configuration_panel = options_pane.buildBuild(sargument_configuration_panel);
+        // if(CollectionManager.canDoScheduling()) {
+        //  sargument_configuration_panel = options_pane.buildSchedule(sargument_configuration_panel); 
+        // }
     }
     else {
@@ -498 +515 @@
         sargument_configuration_panel = options_pane.buildImport(null);
         sargument_configuration_panel = options_pane.buildBuild(sargument_configuration_panel);
+        //  if(CollectionManager.canDoScheduling()) {
+        //  sargument_configuration_panel = options_pane.buildSchedule(sargument_configuration_panel);
+        //}
         }
         else {
@@ -545 +565 @@
     DebugStream.println("In CreatePane::processComplete(" + event.getType() + ")...");
     if(event.getStatus() == GShell.OK) {
-        if(event.getType() == GShell.BUILD) {
+        if(event.getType() == GShell.SCHEDULE) {
+        
+        processing = false; 
+        build_button.setEnabled(true);
+        cancel_button.setEnabled(false);
+        //preview_button.setEnabled(true);
+        //only enable preview if the collection has been built. 
+        preview_button.setEnabled(Gatherer.c_man.built());
+        simple_build_button.setEnabled(true);
+        simple_cancel_button.setEnabled(false);
+        simple_preview_button.setEnabled(Gatherer.c_man.built()); 
+        int status = event.getStatus();
+        document.setSpecialCharacter(OptionsPane.SCHEDULED); 
+        options_pane.resetFileEntry();
+        build_monitor.reset();
+        import_monitor.reset();
+        if(Configuration.getMode() >= THRESHOLD) {
+            control_pane.add(button_pane, BorderLayout.SOUTH); 
+            card_layout.show(main_pane, CONTROL); 
+        }
+        }
+        else if(event.getType() == GShell.BUILD) {
         processing = false;
         build_button.setEnabled(true);
         cancel_button.setEnabled(false);
-        //preview_button.setEnabled(true);
+        preview_button.setEnabled(true);
         simple_build_button.setEnabled(true);
         simple_cancel_button.setEnabled(false);
@@ -570 +611 @@
         build_button.setEnabled(true);
         // The build may have failed, but a previous index may still be in place
-        //preview_button.setEnabled(Gatherer.c_man.built());
+        preview_button.setEnabled(Gatherer.c_man.built());
 
         simple_build_button.setEnabled(true);
         simple_cancel_button.setEnabled(false);
-        //simple_preview_button.setEnabled(Gatherer.c_man.built());
+        simple_preview_button.setEnabled(Gatherer.c_man.built());
         if(event.getStatus() == GShell.CANCELLED) {
         document.setSpecialCharacter(OptionsPane.CANCELLED);
@@ -604 +645 @@
     Collection current_collection = Gatherer.c_man.getCollection();
     if (current_collection != previous_collection && !Gatherer.c_man.isImporting()) {
-        this.options_pane = new OptionsPane(current_collection.import_options, current_collection.build_options);
+        this.options_pane = new OptionsPane(current_collection.import_options, current_collection.build_options, current_collection.schedule_options);
         if (previous_collection != null) {
         // clear the log
@@ -620 +661 @@
         sargument_configuration_panel = options_pane.buildImport(null);
         sargument_configuration_panel = options_pane.buildBuild(sargument_configuration_panel);
+        //if(CollectionManager.canDoScheduling()) {
+        //sargument_configuration_panel = options_pane.buildSchedule(sargument_configuration_panel); 
+        //}
         sargument_configuration_scroll = new JScrollPane(sargument_configuration_panel);
             sargument_configuration_scroll.setComponentOrientation(Dictionary.getOrientation());
@@ -654 +698 @@
         Collection collection = Gatherer.c_man.getCollection();
         String collection_name = collection.getName();
-        if(!collection.getMetadataChanged() && !collection.getFilesChanged() && isIncremental()) {
-        //Only design options have changes, and we want to be smart in the way we handle them.
-        int rebuildTypeRequired = CollectionDesignManager.getRebuildTypeRequired();
-        if (rebuildTypeRequired == CollectionDesignManager.BUILDCOL) {
-            // Just run the buildcol command.
-            DebugStream.println("Just want to run buildcol.pl");
-            prepareForBuild();
-            Gatherer.c_man.buildCollection(isIncremental());
+
+        //if button is labelled for Building
+        if(event.getActionCommand().equals(Dictionary.get("CreatePane.Build_Collection"))) { 
+
+        if(!collection.getMetadataChanged() && !collection.getFilesChanged() && isIncremental()) {
+            //Only design options have changes, and we want to be smart in the way we handle them.
+            int rebuildTypeRequired = CollectionDesignManager.getRebuildTypeRequired();
+            if (rebuildTypeRequired == CollectionDesignManager.BUILDCOL) {
+            // Just run the buildcol command.
+            DebugStream.println("Just want to run buildcol.pl");
+            prepareForBuild();
+            Gatherer.c_man.buildCollection(isIncremental());
+            }
+            else if (rebuildTypeRequired == CollectionDesignManager.ALL) {
+            // Do both import and buildcol
+            DebugStream.println("Want to do a complete build");
+            prepareForBuild();
+            Gatherer.c_man.importCollection(); //This starts the building process.
+            }
+            else {
+            //Nothing at all needs doing.
+            //This is bad HCI. Maybe should disable the build button in this situation?
+            JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CreatePane.Minimal_Build_Not_Required"));
+            }
         }
-        else if (rebuildTypeRequired == CollectionDesignManager.ALL) {
-            // Do both import and buildcol
-            DebugStream.println("Want to do a complete build");
+        else {
+            //Do a complete build.
             prepareForBuild();
             Gatherer.c_man.importCollection(); //This starts the building process.
-        }
-        else {
-            //Nothing at all needs doing.
-            //This is bad HCI. Maybe should disable the build button in this situation?
-            JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CreatePane.Minimal_Build_Not_Required"));
-        }
-        }
-        else {
-        //Do a complete build.
-        prepareForBuild();
-        Gatherer.c_man.importCollection(); //This starts the building process.
-        }
+        } 
+
+        } else {   //button is labelled for setting up scheduling
+
+        //this needs to be called to configure buttons... but no building is done
+        prepareForBuild(); 
+    
+        Gatherer.c_man.scheduleBuild(isIncremental()); 
+        }
+        
         //Re-setting the rebuildTypeRequired is handled by CollectionManager.processComplete(GShellEvent)
     }
-
+        
     /**
      * This does some stuff that is needed before a collection can be built.
@@ -721 +778 @@
     }
     
+    /** I hope this works. Wendy */ 
+    private class BuildSimpleButtonListener
+    implements ActionListener {
+    /**
+     * This method checks to see what needs to be done for a build, and starts the process off.
+     * A complete build proccess is started by {@link CollectionManager.importCollection()}, which then imports and builds the collection.
+     * However, this doesn't always happen, as sometimes an incremental build will do :-)
+     * @param event An <strong>ActionEvent</strong> who, thanks to the power of object oriented programming, we don't give two hoots about.
+     * @see org.greenstone.gatherer.Gatherer
+     * @see org.greenstone.gatherer.collection.CollectionManager
+     * @see org.greenstone.gatherer.gui.BuildOptions
+     * @see org.greenstone.gatherer.shell.GShellProgressMonitor
+     */
+    public void actionPerformed(ActionEvent event) {
+        Collection collection = Gatherer.c_man.getCollection();
+        String collection_name = collection.getName();
+
+        //prepareForBuild(); 
+        if(!collection.getMetadataChanged() && !collection.getFilesChanged() && isIncremental()) {
+            //Only design options have changes, and we want to be smart in the way we handle them.
+            int rebuildTypeRequired = CollectionDesignManager.getRebuildTypeRequired();
+            if (rebuildTypeRequired == CollectionDesignManager.BUILDCOL) {
+            // Just run the buildcol command.
+            DebugStream.println("Just want to run buildcol.pl");
+            prepareForBuild();
+            Gatherer.c_man.buildCollection(isIncremental());
+            }
+            else if (rebuildTypeRequired == CollectionDesignManager.ALL) {
+            // Do both import and buildcol
+            DebugStream.println("Want to do a complete build");
+            prepareForBuild();
+            Gatherer.c_man.importCollection(); //This starts the building process.
+            }
+            else {
+            //Nothing at all needs doing.
+            //This is bad HCI. Maybe should disable the build button in this situation?
+            JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CreatePane.Minimal_Build_Not_Required"));
+            }
+        }
+        else {
+            //Do a complete build.
+            prepareForBuild();
+            Gatherer.c_man.importCollection(); //This starts the building process.
+        }
+        
+        // have commented this out for now - scheduling currently not
+        // available except in expert mode
+        //only schedule in SYSTEM mode - also done in EXPERT mode, but that is handled elsewhere
+        /*      if(Configuration.getMode() ==  Configuration.SYSTEMS_MODE) {
+           if(Gatherer.c_man.getCollection().schedule_options.getValueEnabled("schedule")) {
+            Gatherer.c_man.getCollection().schedule_options.setValue("action",true,"add"); 
+            Gatherer.c_man.getCollection().schedule_options.setValue("email",false, null); 
+            Gatherer.c_man.getCollection().schedule_options.setValue("smtp",false, null);
+            Gatherer.c_man.getCollection().schedule_options.setValue("toaddr",false, null);  
+            Gatherer.c_man.getCollection().schedule_options.setValue("fromaddr",false, null);   
+            Gatherer.c_man.getCollection().schedule_options.setValue("frequency",false, null);  
+            Gatherer.c_man.scheduleBuild(isIncremental()); 
+        } else {
+            //need to turn off existing scheduling
+            Gatherer.c_man.getCollection().schedule_options.setValue("action",true,"delete"); 
+            Gatherer.c_man.scheduleBuild(isIncremental()); 
+            
+        }
+        }
+        */
+        //Re-setting the rebuildTypeRequired is handled by CollectionManager.processComplete(GShellEvent)
+    }
+
+    /**
+     * This does some stuff that is needed before a collection can be built.
+     * For example, buttons are enabled/disabled, and certain flags are set.
+     * This is called from {@link actionPerformed(ActionEvent)}
+     */
+    private void prepareForBuild() {
+        // First we force the build options to be updated if we haven't already.
+        tree.valueChanged(null);
+        
+        // Remember that for lower thresholds the above doesn't work, so try this instead
+        if(Configuration.getMode() < THRESHOLD) {
+        options_pane.update(sargument_configuration_panel);
+        }
+        
+        // Now go about building.
+        build_button.setEnabled(false);
+        cancel_button.setEnabled(true);
+        preview_button.setEnabled(false);
+        
+        simple_build_button.setEnabled(false);
+        simple_cancel_button.setEnabled(true);
+        simple_preview_button.setEnabled(false);
+        
+        document = options_pane.createNewLogDocument();
+        log_textarea.setDocument(document);
+        options_pane.log_textarea.setDocument(document);
+        // Change the view.
+        processing = true;
+        if(Configuration.getMode() >= THRESHOLD) {
+        progress_pane.add(button_pane, BorderLayout.SOUTH);
+        card_layout.show(main_pane, PROGRESS);
+        }
+        // Reset the stop flag in all the process monitors, just incase.
+        ((GBuildProgressMonitor)build_monitor).reset();
+        import_monitor.setStop(false);
+    }
+    }
     
+
     /** This class serves as the listener for actions on the cancel button. */
     private class CancelButtonListener
@@ -771 +934 @@
     /** The node corresponding to the importing options view. */
     private OptionTreeNode importing = null;
+    /** The node corresponding to the scheduling options view. */ 
+    private OptionTreeNode scheduling = null; 
     /** The node corresponding to the log view. */
     private OptionTreeNode log       = null;
@@ -793 +958 @@
         importing = new OptionTreeNode(Dictionary.get("CreatePane.Import"));
         importing.setToolTipText(Dictionary.get("CreatePane.Import_Tooltip"));
+        scheduling = new OptionTreeNode(Dictionary.get("CreatePane.Schedule"));
+        scheduling.setToolTipText(Dictionary.get("CreatePane.Schedule_Tooltip")); 
+
         log = new OptionTreeNode(Dictionary.get("CreatePane.Log"));
         log.setToolTipText(Dictionary.get("CreatePane.Log_Tooltip"));
@@ -801 +969 @@
         model.insertNodeInto(importing, options, 0);
         model.insertNodeInto(building, options, 1);
-        model.insertNodeInto(log, options, 2);
+        model.insertNodeInto(scheduling, options, 2); 
+        model.insertNodeInto(log, options, 3);
         // Expand the root node
         expandPath(new TreePath(options));
@@ -831 +1000 @@
         scroll_pane = null;
         }
+        if(node != null && node.equals(log)) { 
+        build_button.setActionCommand(Dictionary.get("CreatePane.Build_Collection")); 
+        build_button.setText(Dictionary.get("CreatePane.Build_Collection"));    
+        }
         if(node != null && node.equals(building)) {
+    build_button.setActionCommand(Dictionary.get("CreatePane.Build_Collection"));       
+        build_button.setText(Dictionary.get("CreatePane.Build_Collection"));
+ 
+
         previous_pane = options_pane.buildBuild(null);
         scroll_pane = new JScrollPane(previous_pane);
@@ -838 +1015 @@
         }
         else if(node != null && node.equals(importing)) {
+        build_button.setActionCommand(Dictionary.get("CreatePane.Build_Collection")); 
+        build_button.setText(Dictionary.get("CreatePane.Build_Collection")); 
+
         previous_pane = options_pane.buildImport(null);
         scroll_pane = new JScrollPane(previous_pane);
         right.add(scroll_pane, BorderLayout.CENTER);
         //target_pane.add(previous_pane, BorderLayout.CENTER);
+        }
+        else if(node != null && node.equals(scheduling) && CollectionManager.canDoScheduling()) { 
+        build_button.setActionCommand(Dictionary.get("CreatePane.Schedule_Build")); 
+        build_button.setText(Dictionary.get("CreatePane.Schedule_Build"));
+ 
+        previous_pane = options_pane.buildSchedule(null); 
+        scroll_pane = new JScrollPane(previous_pane);
+        right.add(scroll_pane, BorderLayout.CENTER);
         }
         else {