Changeset 34286

Timestamp:

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

Author:

ak19

Message:

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.

Location:

main/trunk/gli/src/org/greenstone/gatherer

Files:

• collection/CollectionManager.java (modified) (3 diffs)
• gui/FormatPane.java (modified) (1 diff)

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

@@ -129 +129 @@
      * this will be the local bin/script folder. */
     static private String scriptPath = "";
-  
+
+    private Boolean canPreview = null;
+    
     /** Constructor. */
     public CollectionManager() {
@@ -394 +396 @@
     }
 
+    /** Calling c_man.built() is expensive in isGsdlRemote case. If you don't need built status recalculated
+     * call this method to get the last built() result,
+     * as the private canPreview variable stores the recalculated result after each call to built().
+     * For example, this method should especially be used by the FormatPane for determining if the Preview
+     * button should be available as queried after every character has been input. The Preview Button should
+     * be available in such cases if the collection's last-known status indicated that an index folder from
+     * the most recent or prior build process was available.
+     * @return A boolean indicating the last known built status of the collection.
+     */
+    public boolean previewAvailable() {
+    if(canPreview == null) {
+        built(); // this will set the variable canPreview, if not already set by CreatePane's calls to built()
+    }
+    return this.canPreview.booleanValue();
+    }
+    
     /** Used to determine whether the currently active collection has been built.
      * @return A boolean indicating the built status of the collection.
      */
     public boolean built() {
+    boolean been_built = false;
+    
     if(collection != null) {
         // Determine if the collection has been built by looking for the build.cfg (gs2) 
@@ -420 +440 @@
 
         if(Gatherer.isGsdlRemote) {
-        return Gatherer.remoteGreenstoneServer.exists(collection.getGroupQualifiedName(false), test_file);
+        been_built = Gatherer.remoteGreenstoneServer.exists(collection.getGroupQualifiedName(false), test_file);
         } else {
-        return test_file.exists();
-        }
-    }
-    return false;
+        been_built = test_file.exists();
+        }
+    }
+
+    // store recalculated result
+    this.canPreview = been_built ? Boolean.FALSE : Boolean.TRUE;
+
+    return been_built; //or: this.canPreview.booleanValue();
     }
 

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

@@ -123 +123 @@
     // unbuilt (as could happen when someone clicks on a format statement before 
     // building the collection), then shouldn't enable previewing.
-    if(ready_to_preview && !Gatherer.c_man.built()) {
+    if(ready_to_preview && Gatherer.c_man.previewAvailable()) {
         ready_to_preview = false;
     }