Add manual distinct count button

Address #759 Signed-off-by: Jeffrey Miller <jeffmax@gmail.com>
chop-dbhi · Jan 22, 2015 · e8efaad · e8efaad
1 parent e25b4fb
commit e8efaad
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 11 deletions.
diff --git a/src/js/cilantro/config.js b/src/js/cilantro/config.js
@@ -84,6 +84,12 @@ define([
          * concept names, operators and values to make filters more readable.
          */
         styleFilters: false,
+
+        /* 
+        * Automatically refresh count statistics for context when filters
+        * change.
+        */
+        distinctCountAutoRefresh: true,
 
         /*
          * Timeouts

diff --git a/src/js/cilantro/models/base.js b/src/js/cilantro/models/base.js
@@ -90,20 +90,24 @@ define([
 
             this.listenTo(this.parent, 'request', this.onParentRequest);
             this.listenTo(this.parent, 'sync', this.onParentSync);
+        },
 
-            if (this.parent.collection) {
-                this.listenTo(this.parent.collection, 'reset', this.onParentReset);
+        onParentRequest: function() {
+            // if the parent make a request and we are
+            // waiting for a stat response, it will be
+            // stale when it arrives
+            if (this.xhr) {
+                this.xhr.abort();
+                this.xhr = null;
             }
         },
 
-        onParentRequest: function() {},
-
         onParentReset: function() {
-            this.fetch();
+            this.xhr = this.fetch();
         },
 
         onParentSync: function() {
-            this.fetch();
+            this.xhr = this.fetch();
         },
 
         url: function() {
@@ -116,6 +120,11 @@ define([
             else {
                 throw new Error('Stat supported model has no stats URL defined.');
             }
+        },
+
+        manualFetch: function() {
+           this.xhr = this.fetch();
+           return this.xhr;
         }
     });
 
@@ -127,9 +136,13 @@ define([
                 throw new Error('statModel must be defined');
             }
 
+            this.stats = new this.statModel({parent: this});
+
             Model.prototype.constructor.call(this, attrs, options);
 
-            this.stats = new this.statModel({parent: this});
+            if (this.collection) {
+                this.stats.listenTo(this.collection, 'reset', this.stats.onParentReset);
+            }
         }
     });
 

diff --git a/src/js/cilantro/models/context.js b/src/js/cilantro/models/context.js
@@ -92,6 +92,10 @@ define([
             });
 
             this.on('sync', this.onSync);
+
+            if (!c.config.get('distinctCountAutoRefresh')) {
+                this.stats.stopListening(this, 'sync');
+            }
 
             // Define a debounced save method for handling rapid successions
             // of [un]apply events.

diff --git a/src/js/cilantro/ui/context/actions.js b/src/js/cilantro/ui/context/actions.js
@@ -15,15 +15,19 @@ define([
             removeAll: '[data-action=remove]',
             count: '[data-target=count]',
             units: '[data-target=units]',
-            loading: '[data-target=loading-message]'
+            loading: '[data-target=loading-message]',
+            refresh: '[data-action=refresh]'
         },
 
         events: {
-            'click @ui.removeAll': 'clickRemoveAll'
+            'click @ui.removeAll': 'clickRemoveAll',
+            'click @ui.refresh': 'refreshCount'
         },
 
         modelEvents: {
-            'request': 'showLoad'
+            'request': 'showLoad',
+            'sync': 'enableRefreshButton',
+            'change': 'disableRefreshButton'
         },
 
         collectionEvents: {
@@ -41,6 +45,8 @@ define([
             attrs.prettyCount = c.utils.prettyNumber(
                 attrs.count, c.config.get('threshold'));
 
+            attrs.showDistinctButton = !c.config.get('distinctCountAutoRefresh');
+
             return attrs;
         },
 
@@ -55,7 +61,9 @@ define([
         showLoad: function() {
             this.ui.count.hide();
             this.ui.units.hide();
-            this.ui.loading.show();
+            if (c.config.get('distinctCountAutoRefresh')) {
+                this.ui.loading.show();
+            }
         },
 
         showCount: function() {
@@ -64,6 +72,15 @@ define([
             this.ui.loading.hide();
             this.render();
         },
+
+        enableRefreshButton: function() {
+            this.ui.refresh.removeProp('disabled');
+        },
+
+        disableRefreshButton: function() {
+            this.ui.refresh.prop('disabled', true);
+            this.ui.loading.hide();
+        },
 
         renderRemoveAll: function() {
             // Required filters cannot be removed, so filter them out
@@ -72,6 +89,12 @@ define([
             });
 
             this.ui.removeAll.prop('disabled', !models.length);
+        },
+
+        refreshCount:function(){
+           this.model.stats.manualFetch();
+           this.ui.refresh.prop('disabled', true);
+           this.ui.loading.show();
         }
     });
 

diff --git a/src/templates/context/actions.html b/src/templates/context/actions.html
@@ -1,4 +1,7 @@
 <div class=pull-right>
+    <% if (data.showDistinctButton) { %>
+    <button data-action=refresh class='btn btn-info btn-mini' title='Retrieve Distinct Count' disabled><i class='icon-refresh icon-white'></i></button>
+    <% } %>
     <button data-action=remove class='btn btn-danger btn-mini' title='Remove All Filters' disabled><i class='icon-remove icon-white'></i></button>
 </div>