Changeset 10237 for trunk/gli/src/org/greenstone/gatherer/cdm

Timestamp:

2005-07-13T11:12:11+12:00 (19 years ago)

Author:

mdewsnip

Message:

New code for "incremental" building, by Matthew Whyte.

I've only had time to look at this briefly; I've fixed a few obvious problems but I imagine this will be pretty flaky for a while.

Location:

trunk/gli/src/org/greenstone/gatherer/cdm

Files:

• ArgumentConfiguration.java (modified) (1 diff)
• ClassifierManager.java (modified) (2 diffs)
• CollectionDesignManager.java (modified) (7 diffs)
• DesignChangeListener.java (added)
• FormatManager.java (modified) (6 diffs)
• GeneralManager.java (modified) (1 diff)
• IndexManager.java (modified) (1 diff)
• LanguageManager.java (modified) (1 diff)
• PluginManager.java (modified) (1 diff)
• SearchTypeManager.java (modified) (1 diff)
• SubcollectionIndexManager.java (modified) (1 diff)
• SubcollectionManager.java (modified) (1 diff)
• SuperCollectionManager.java (modified) (2 diffs)
• TranslationView.java (modified) (1 diff)

trunk/gli/src/org/greenstone/gatherer/cdm/ArgumentConfiguration.java

@@ -129 +129 @@
     cancel.addActionListener(this);
     ok.addActionListener(this);
+    ok.addActionListener(CollectionDesignManager.all_change_listener);
 
     // Layout

trunk/gli/src/org/greenstone/gatherer/cdm/ClassifierManager.java

@@ -582 +582 @@
         Dictionary.registerText(instructions, "CDM.ClassifierManager.Instructions");
 
-        ClassifierComboboxListener ccl = new ClassifierComboboxListener();
+        ClassifierComboboxListener ccl = new ClassifierComboboxListener();
         classifier = new GComboBox(getAvailable());
         classifier.setBackgroundNonSelectionColor(Configuration.getColor("coloring.editable_background", false));
@@ -630 +630 @@
         // Listeners
         add.addActionListener(new AddListener());
-        classifier.addItemListener(ccl);
+        add.addActionListener(CollectionDesignManager.buildcol_change_listener);
+        classifier.addItemListener(ccl);
         configure.addActionListener(new ConfigureListener());
+        configure.addActionListener(CollectionDesignManager.buildcol_change_listener);
         remove.addActionListener(new RemoveListener());
+        remove.addActionListener(CollectionDesignManager.buildcol_change_listener);
         classifier_list.addMouseListener(new ClickListener());
         classifier_list.addListSelectionListener(new ListListener());
-        ccl = null;
+        ccl = null;
 
         MoveListener ml = new MoveListener();
         //move_bottom_button.addActionListener(ml);
         move_down_button.addActionListener(ml);
+        move_down_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         //move_top_button.addActionListener(ml);
         move_up_button.addActionListener(ml);
+        move_up_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
 
         // Layout

trunk/gli/src/org/greenstone/gatherer/cdm/CollectionDesignManager.java

@@ -50 +50 @@
     /** This listener listens for any event on any of the components in any of the sub-views, and marks the collection as needing saving if any change occurs. */
     static public CDMChangeListener change_listener;
+    /** These listeners listen to changes in the Design mode so as to allow incremental building */
+    static public DesignChangeListener all_change_listener;
+    static public DesignChangeListener buildcol_change_listener;
+    static public DesignChangeListener collect_cfg_change_listener;
     /** A list of classifiers to use at build time. */
     static public ClassifierManager classifier_manager;
@@ -78 +82 @@
     /** The text translation manager. */
     static public TranslationView translation_view;
+    /** These mark what needs to happen when building a collection where ONLY design options have been changed.
+        The build requirements of the higher numbers must include doing everything from the lower numbers. */
+    static final public int ALL = 3;
+    static final public int BUILDCOL = 2;
+    static final public int UPDATE_COLLECT_CFG = 1;
+    static final public int NOTHING = 0;
+    static private int rebuildTypeRequired = NOTHING; //Rebuild type required if only design options have changed
+    static protected boolean update_collect_cfg_required = false;
+
     /** Constructor. Loads a certain collection configuration file, which is parsed into a DOM. This model is then registered with the command information managers, each of whom knows how to, and provides controls to, alter certain commands.
      * @param collect_config_file the File representing a collection configuration file either in its text (G2) or xml (G3) form
@@ -84 +97 @@
     DebugStream.println("Initializaing CollectionDesignModule.");
     change_listener = new CDMChangeListener();
+    all_change_listener = new DesignChangeListener(ALL);
+    buildcol_change_listener = new DesignChangeListener(BUILDCOL);
+    collect_cfg_change_listener = new DesignChangeListener(UPDATE_COLLECT_CFG);
     // Parse the collection configuration
     collect_config = new CollectionConfiguration(collect_config_file);
@@ -199 +215 @@
      */
     public void save() {
+    System.err.println("Config file saved. The level of processing needed is: " + CollectionDesignManager.getRebuildTypeRequired()); //debug
     // Release collection as necessary
     String collection_name = Gatherer.c_man.getCollection().getName();
     boolean collection_released = false;
-    boolean formats_changed = format_manager.formatsChanged();
-
-    if (formats_changed && Gatherer.c_man.built() && LocalLibraryServer.isRunning() == true) {
+
+    if (update_collect_cfg_required && Gatherer.c_man.built() && LocalLibraryServer.isRunning() == true) {
         // Release the collection
         LocalLibraryServer.releaseCollection(collection_name);
@@ -213 +229 @@
     collect_config.save();
 
-    if (Gatherer.isGsdlRemote) {
-        if (formats_changed && Gatherer.c_man.built()) {
-        // upload etc/collect.cfg to server to reflect changes
-        Utility.zipup(Gatherer.getCollectDirectoryPath(), collection_name, Utility.CONFIG_FILE, null, "", "");
-        GathererApplet.upload_url_zip(collection_name, "etc", "", null);
-        }
-    }
-
-    // Readd collection
+    if (update_collect_cfg_required && Gatherer.c_man.built() && Gatherer.isGsdlRemote) {
+        //If the GLI is running as an applet, and Format Features or Cross-Collection Searching have changed,
+        //upload etc/collect.cfg to the server to immediately reflect these changes.
+        Utility.zipup(Gatherer.getCollectDirectoryPath(), collection_name, Utility.CONFIG_FILE, null, "", "");
+        GathererApplet.upload_url_zip(collection_name, "etc", "", null);
+    }
+    
+    // Read collection
     if (collection_released) {
         // Now re-add collection to server to force format commands to be processed
@@ -227 +242 @@
     }
 
-    if (formats_changed) {
+    if (update_collect_cfg_required) {
         // Unset formats changed
-        format_manager.setFormatsChanged(false);
+        update_collect_cfg_required = false;
     }
     }
@@ -263 +278 @@
     }
 
-
+    public static int getRebuildTypeRequired() {
+    return rebuildTypeRequired;
+    }
+    public static void resetRebuildTypeRequired() {
+    setRebuildTypeRequired(NOTHING);
+    }
+    public static void setRebuildTypeRequired(int number) {
+    rebuildTypeRequired = number;
+    }
+
+    /**
+     * What exactly does this do?
+     */
     private class CDMChangeListener
     implements ActionListener, DocumentListener {
 
+    /** Gives notification that an event has happened */
     public void actionPerformed(ActionEvent event) {
         Gatherer.c_man.getCollection().setSaved(false);

trunk/gli/src/org/greenstone/gatherer/cdm/FormatManager.java

@@ -64 +64 @@
     static final private String INVISIBLE_DEFAULT_FORMAT = "";
 
-    /** This flag is set if some change has occured to the format commands. When a collection has been built for previewing, and the greenstone local library server is used, then we have to send commands to remove then add the new collection. */
-    private boolean formats_changed = false;
     /** The controls used to edit the format commands. */
     private Control controls = null;
@@ -106 +104 @@
         add(root, format, target_node);
         Gatherer.c_man.configurationChanged();
-        formats_changed = true;
     }
     }
@@ -115 +112 @@
         controls = null;
     }
-    }
-
-    /** Have the formats changed since the last save. */
-    public boolean formatsChanged() {
-    return formats_changed;
     }
 
@@ -160 +152 @@
     remove(format);
     Gatherer.c_man.configurationChanged();
-    formats_changed = true;
-    }
-
-    /** Set the state of the formats changed flag.
-     * @param state the new state as a boolean
-     */
-    public void setFormatsChanged(boolean state) {
-    formats_changed = state;
     }
 
@@ -344 +328 @@
         // Connect
         add_button.addActionListener(new AddListener());
+        add_button.addActionListener(CollectionDesignManager.collect_cfg_change_listener);
         insert_button.addActionListener(new InsertListener());
+        insert_button.addActionListener(CollectionDesignManager.collect_cfg_change_listener);
         remove_button.addActionListener(new RemoveListener());
+        remove_button.addActionListener(CollectionDesignManager.collect_cfg_change_listener);
         replace_button.addActionListener(new ReplaceListener());
+        replace_button.addActionListener(CollectionDesignManager.collect_cfg_change_listener);
         enabled_checkbox.addActionListener(new EnabledListener());
+        enabled_checkbox.addActionListener(CollectionDesignManager.collect_cfg_change_listener);
         feature_combobox.addActionListener(new FeatureListener());
         part_combobox.addActionListener(new PartListener());
@@ -425 +414 @@
         // This is only necessary if the components have been realized
         if(ready) {
-        formats_changed = false;
         model.refresh();
         feature_model = buildFeatureModel();

trunk/gli/src/org/greenstone/gatherer/cdm/GeneralManager.java

@@ -266 +266 @@
         browse_listener = null;
         public_checkbox.addActionListener(CollectionDesignManager.change_listener);
+        public_checkbox.addActionListener(CollectionDesignManager.buildcol_change_listener);
         creator_emailfield.getDocument().addDocumentListener(CollectionDesignManager.change_listener);
+        creator_emailfield.getDocument().addDocumentListener(CollectionDesignManager.buildcol_change_listener);
         description_textarea.getDocument().addDocumentListener(CollectionDesignManager.change_listener);
+        description_textarea.getDocument().addDocumentListener(CollectionDesignManager.buildcol_change_listener);
         icon_textfield.getDocument().addDocumentListener(CollectionDesignManager.change_listener);
+        icon_textfield.getDocument().addDocumentListener(CollectionDesignManager.buildcol_change_listener);
         maintainer_emailfield.getDocument().addDocumentListener(CollectionDesignManager.change_listener);
+        maintainer_emailfield.getDocument().addDocumentListener(CollectionDesignManager.buildcol_change_listener);
         name_textfield.getDocument().addDocumentListener(CollectionDesignManager.change_listener);
         name_textfield.getDocument().addDocumentListener(new CollectionTitleUpdater());
+        name_textfield.getDocument().addDocumentListener(CollectionDesignManager.buildcol_change_listener);
         small_icon_textfield.getDocument().addDocumentListener(CollectionDesignManager.change_listener);
+        small_icon_textfield.getDocument().addDocumentListener(CollectionDesignManager.buildcol_change_listener);
+        //Note: unfortunately just loading the General Design panel fires the buildcol_change_listener (even if nothing is changed).
 
         // Layout

trunk/gli/src/org/greenstone/gatherer/cdm/IndexManager.java

@@ -626 +626 @@
         // Listeners
         add_button.addActionListener(new AddListener());
+        add_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         move_down_button.addActionListener(new MoveListener(false));
+        move_down_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         move_up_button.addActionListener(new MoveListener(true));
+        move_up_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         remove_button.addActionListener(new RemoveListener());
+        remove_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         replace_button.addActionListener(new ReplaceListener());
+        replace_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         set_default_button.addActionListener(new SetDefaultListener());
+        set_default_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         name_textfield.getDocument().addDocumentListener(new NameListener());
         level_combobox.addItemListener(new LevelListener());

trunk/gli/src/org/greenstone/gatherer/cdm/LanguageManager.java

@@ -351 +351 @@
         // Set up and connect listeners.
         add_button.addActionListener(new AddListener());
+        add_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         move_down_button.addActionListener(new MoveListener(false));
+        move_down_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         move_up_button.addActionListener(new MoveListener(true));
+        move_up_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         remove_button.addActionListener(new RemoveListener());
+        remove_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         language_combobox.addActionListener(new SelectorListener());
         set_default_button.addActionListener(new SetDefaultListener());
+        set_default_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         selected_languages_list.addListSelectionListener(new ListListener());
 

trunk/gli/src/org/greenstone/gatherer/cdm/PluginManager.java

@@ -794 +794 @@
 
         // Listeners
-        add.addActionListener(new AddListener());
+        add.addActionListener(new AddListener()); //all_change_listener is listening to the ArgumentConfiguration
         configure.addActionListener(new ConfigureListener());
         MoveListener ml = new MoveListener();
         //move_bottom_button.addActionListener(ml);
         move_down_button.addActionListener(ml);
+        move_down_button.addActionListener(CollectionDesignManager.all_change_listener);
         //move_top_button.addActionListener(ml);
         move_up_button.addActionListener(ml);
+        move_up_button.addActionListener(CollectionDesignManager.all_change_listener);
         plugin.addItemListener(picl);
         remove.addActionListener(new RemoveListener());
+        remove.addActionListener(CollectionDesignManager.all_change_listener);
         plugin_list.addMouseListener(new ClickListener());
         plugin_list.addListSelectionListener(new ListListener());

trunk/gli/src/org/greenstone/gatherer/cdm/SearchTypeManager.java

@@ -268 +268 @@
         // Connection
         add_button.addActionListener(new AddActionListener());
+        add_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         build_type_combobox.addActionListener(new BuildTypeActionListener());
+        build_type_combobox.addActionListener(CollectionDesignManager.buildcol_change_listener);
         current_search_types_list.addListSelectionListener(new CurrentSearchTypesListSelectionListener());
         enable_advanced_searches_checkbox.addActionListener(new EnableAdvancedSearchesActionListener());
+        enable_advanced_searches_checkbox.addActionListener(CollectionDesignManager.buildcol_change_listener);
         move_up_button.addActionListener(new MoveListener(true));
+        move_up_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         move_down_button.addActionListener(new MoveListener(false));
+        move_down_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         remove_button.addActionListener(new RemoveActionListener());
+        remove_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         SearchTypesActionDocumentListener stadl = new SearchTypesActionDocumentListener();
         search_type_combobox.addActionListener(stadl);
+        search_type_combobox.addActionListener(CollectionDesignManager.buildcol_change_listener);
         ((JTextField)search_type_combobox.getEditor().getEditorComponent()).getDocument().addDocumentListener(stadl);
 

trunk/gli/src/org/greenstone/gatherer/cdm/SubcollectionIndexManager.java

@@ -314 +314 @@
         // Listeners
         add_button.addActionListener(new AddListener());
+        add_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         move_down_button.addActionListener(new MoveListener(false));
+        move_down_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         move_up_button.addActionListener(new MoveListener(true));
+        move_up_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         remove_button.addActionListener(new RemoveListener());
+        remove_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         replace_button.addActionListener(new ReplaceListener());
+        replace_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         set_default_button.addActionListener(new SetDefaultListener());
+        set_default_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         subcollection_index_name_textfield.getDocument().addDocumentListener(new NameListener());
         subcollection_index_list.addListSelectionListener(new SubcollectionIndexListListener());

trunk/gli/src/org/greenstone/gatherer/cdm/SubcollectionManager.java

@@ -277 +277 @@
         SubCollectionChangeListener cl = new SubCollectionChangeListener();
         add_button.addActionListener(new AddSubCollectionListener());
+        add_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         remove_button.addActionListener(new RemoveSubCollectionListener());
+        remove_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         update_button.addActionListener(new UpdateSubCollectionListener());
+        update_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         exclude_button.addActionListener(cl);
         include_button.addActionListener(cl);

trunk/gli/src/org/greenstone/gatherer/cdm/SuperCollectionManager.java

@@ -53 +53 @@
     private DOMProxyListModel model = null;
     private String current_coll_name = null;
-
+    private boolean superCollectionChanged = false;
 
     public SuperCollectionManager(Element supercollections_element) {
@@ -157 +157 @@
 
     public void loseFocus() {
+        CollectionDesignManager.collect_cfg_change_listener.maybeSetRebuildRequired(); // !! TO DO: This is crap
         int super_collections_count = 0;
         // Retrieve the current supercollections

trunk/gli/src/org/greenstone/gatherer/cdm/TranslationView.java

@@ -270 +270 @@
         // Connection
         add_button.addActionListener(new AddListener());
+        add_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         remove_button.addActionListener(new RemoveListener());
+        remove_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         replace_button.addActionListener(new ReplaceListener());
+        replace_button.addActionListener(CollectionDesignManager.buildcol_change_listener);
         language_combobox.addActionListener(new LanguageActionListener());
         translation_area.getDocument().addDocumentListener(new TranslationDocumentListener());