Changeset 34287 for main/trunk

Timestamp:

2020-07-23T21:08:07+12:00 (4 years ago)

Author:

ak19

Message:

Belongs with previous commit, had left out one more file that needed committing. Client-GLI was noticeably slow compared to GLI when swapping between format statements or when typing anything into a format statement. The cause was my own mistake from 9 years ago (commit revision 24424) when I didn't know that the CollectionManager.built() operation was an expensive remote call in the case of IsGsdlRemote. This function was being called to determine if the previewbutton should really be available (enabled or disabled) so that the user could not accidentally attempt to preview an unbuilt collection. However, I must not have realised back then that the previewbutton was being set this way at every character added into the Format statements editor, as well as when swapping between one format statement and another. As a result, all of such user action was being severely delayed when isGsdlRemote was true. Fixed this now by adding a function CollectionManager.previewAvailable() that returns the last known result of the built() call. Client-GLI's format pane is now thankfully so much faster, rather than a pain to use.

File:

• main/trunk/gli/src/org/greenstone/gatherer/gui/CreatePane.java (modified) (7 diffs)

main/trunk/gli/src/org/greenstone/gatherer/gui/CreatePane.java

@@ -267 +267 @@
     preview_button = new PreviewButton(Dictionary.get("CreatePane.Preview_Collection"), Dictionary.get("CreatePane.Preview_Collection_Tooltip"));
     //preview_button.addActionListener(pbl);
+
+    // c_man.built() is an expensive operation for isGsdlRemote case,
+    // so calculate this once to set both preview and simple_preview buttons in one go
+    boolean been_built = Gatherer.c_man.built();
+    
     if(Gatherer.c_man != null) {
-        preview_button.setEnabled(Gatherer.c_man.built());
+        preview_button.setEnabled(been_built);
     }
     else {
@@ -285 +290 @@
     //simple_preview_button.addActionListener(pbl);
     if(Gatherer.c_man != null) {
-        simple_preview_button.setEnabled(Gatherer.c_man.built());
+        simple_preview_button.setEnabled(been_built);
     }
     else {
@@ -550 +555 @@
     public synchronized void processComplete(GShellEvent event) {
     DebugStream.println("In CreatePane::processComplete(" + event.getType() + ")...");
+    
+    // c_man.built() is an expensive operation in isGsdlRemote case,
+    // so calculate this once now to set both preview and simple_preview buttons in one go
+    boolean been_built = Gatherer.c_man.built();
+    
     if(event.getStatus() == GShell.OK) {
         if(event.getType() == GShell.SCHEDULE) {
@@ -558 +568 @@
         //preview_button.setEnabled(true);
         //only enable preview if the collection has been built. 
-        preview_button.setEnabled(Gatherer.c_man.built());
+        preview_button.setEnabled(been_built);
         simple_build_button.setEnabled(true);
         simple_cancel_button.setEnabled(false);
-        simple_preview_button.setEnabled(Gatherer.c_man.built()); 
+        simple_preview_button.setEnabled(been_built); 
         int status = event.getStatus();
         document.setSpecialCharacter(OptionsPane.SCHEDULED); 
@@ -576 +586 @@
         build_button.setEnabled(true);
         cancel_button.setEnabled(false);
-        preview_button.setEnabled(Gatherer.c_man.built());
+        preview_button.setEnabled(been_built);
         simple_build_button.setEnabled(true);
         simple_cancel_button.setEnabled(false);
-        simple_preview_button.setEnabled(Gatherer.c_man.built());
+        simple_preview_button.setEnabled(been_built);
         int status = event.getStatus();
         document.setSpecialCharacter(OptionsPane.SUCCESSFUL);
@@ -597 +607 @@
         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());
+        // In which case, previewing should still be available      
+        preview_button.setEnabled(been_built);
 
         simple_build_button.setEnabled(true);
         simple_cancel_button.setEnabled(false);
-        simple_preview_button.setEnabled(Gatherer.c_man.built());
+        simple_preview_button.setEnabled(been_built);
         if(event.getStatus() == GShell.CANCELLED) {
         document.setSpecialCharacter(OptionsPane.CANCELLED);
@@ -658 +669 @@
 
     // Validate the preview button
-    if (Gatherer.c_man.built() && Configuration.library_url != null) {
+    // Calling the expensive built() operation here is justified probably,
+    // as long as refresh() is not called frivolously
+    boolean been_built = Gatherer.c_man.built();
+    if (been_built && Configuration.library_url != null) {
         preview_button.setEnabled(true);
         simple_preview_button.setEnabled(true);