clearNotifications
Clear all existing notifications | my.clearNotifications = function() {
- var $notifications = $('.data-explorer .alert-message');
+ var $notifications = $('.data-explorer .alert-messages .alert');
$notifications.remove();
}
diff --git a/make b/make
index 9177a082..02a3d5b9 100755
--- a/make
+++ b/make
@@ -1,15 +1,34 @@
-#!/bin/bash
-echo "** Combining js files"
-cat src/*.js src/backend/*.js > recline.js
+#!/usr/bin/env python
+import sys
+import os
-# build docs
-echo "** Building docs"
-docco src/model.js src/view.js src/view-grid.js src/view-flot-graph.js
-mkdir -p /tmp/recline-docs
-mkdir -p docs/backend
-PWD=`pwd`
-FILES=$PWD/src/backend/*.js
-DEST=$PWD/docs/backend
-cd /tmp/recline-docs && docco $FILES && mv docs/* $DEST
-echo "** Docs built ok"
+def cat():
+ print("** Combining js files")
+ cmd = 'cat src/*.js src/backend/*.js > recline.js'
+ os.system(cmd)
+
+def docs():
+ # build docs
+ print("** Building docs")
+ cmd = 'docco src/model.js src/view.js src/view-grid.js src/view-flot-graph.js'
+ os.system(cmd)
+ os.makedirs('/tmp/recline-docs')
+ os.system('mkdir -p docs/backend')
+ files = '%s/src/backend/*.js' % os.getcwd()
+ dest = '%s/docs/backend' % os.getcwd()
+ os.system('cd /tmp/recline-docs && docco %s && mv docs/* %s' % (files, dest))
+ print("** Docs built ok")
+
+if __name__ == '__main__':
+ if not len(sys.argv) > 1:
+ print 'make cat | docs | all'
+ sys.exit(1)
+ action = sys.argv[1]
+ if action == 'cat':
+ cat()
+ elif action == 'docs':
+ docs()
+ elif action == 'all':
+ cat()
+ docs()
diff --git a/recline.js b/recline.js
index ce3a2046..0add56e4 100644
--- a/recline.js
+++ b/recline.js
@@ -812,7 +812,7 @@ my.DataGrid = Backbone.View.extend({
template: ' \
\
\
- \
+ \
\
\
{{#notEmpty}} \
@@ -872,7 +872,8 @@ my.DataGrid = Backbone.View.extend({
// ## DataGridRow View for rendering an individual document.
//
// Since we want this to update in place it is up to creator to provider the element to attach to.
-// In addition you must pass in a fields in the constructor options. This should be list of fields for the DataGrid.
+//
+// In addition you *must* pass in a FieldList in the constructor options. This should be list of fields for the DataGrid.
//
// Additional options can be passed in a second hash argument. Options:
//
@@ -881,6 +882,19 @@ my.DataGrid = Backbone.View.extend({
// corresponding field object and document is the document object. Note
// that implementing functions can ignore arguments (e.g.
// function(value) would be a valid cellRenderer function).
+//
+// Example:
+//
+//
+// var row = new DataGridRow({
+// model: dataset-document,
+// el: dom-element,
+// fields: mydatasets.fields // a FieldList object
+// }, {
+// cellRenderer: my-cell-renderer-function
+// }
+// );
+//
my.DataGridRow = Backbone.View.extend({
initialize: function(initData, options) {
_.bindAll(this, 'render');
@@ -932,9 +946,8 @@ my.DataGridRow = Backbone.View.extend({
return this;
},
- // Cell Editor
- // ===========
-
+ // ===================
+ // Cell Editor methods
onEditClick: function(e) {
var editing = this.el.find('.data-table-cell-editor-editor');
if (editing.length > 0) {
@@ -976,339 +989,6 @@ my.DataGridRow = Backbone.View.extend({
this.recline = this.recline || {};
this.recline.View = this.recline.View || {};
-(function($, my) {
-// ## DataExplorer
-//
-// The primary view for the entire application. Usage:
-//
-//
-// var myExplorer = new model.recline.DataExplorer({
-// model: {{recline.Model.Dataset instance}}
-// el: {{an existing dom element}}
-// views: {{page views}}
-// config: {{config options -- see below}}
-// });
-//
-//
-// ### Parameters
-//
-// **model**: (required) Dataset instance.
-//
-// **el**: (required) DOM element.
-//
-// **views**: (optional) the views (Grid, Graph etc) for DataExplorer to
-// show. This is an array of view hashes. If not provided
-// just initialize a DataGrid with id 'grid'. Example:
-//
-//
-// var views = [
-// {
-// id: 'grid', // used for routing
-// label: 'Grid', // used for view switcher
-// view: new recline.View.DataGrid({
-// model: dataset
-// })
-// },
-// {
-// id: 'graph',
-// label: 'Graph',
-// view: new recline.View.FlotGraph({
-// model: dataset
-// })
-// }
-// ];
-//
-//
-// **config**: Config options like:
-//
-// * readOnly: true/false (default: false) value indicating whether to
-// operate in read-only mode (hiding all editing options).
-//
-// NB: the element already being in the DOM is important for rendering of
-// FlotGraph subview.
-my.DataExplorer = Backbone.View.extend({
- template: ' \
- \
- \
- \
- \
- \
- \
- \
- × \
- {{msg}} \
- {{#loader}} \
-  \
- {{/loader}} \
- \
- ';
- var _templated = $.mustache(_template, tmplData);
- _templated = $(_templated).appendTo($('.data-explorer .alert-messages'));
- if (!options.persist) {
- setTimeout(function() {
- $(_templated).fadeOut(1000, function() {
- $(this).remove();
- });
- }, 1000);
- }
-}
-
-// ## clearNotifications
-//
-// Clear all existing notifications
-my.clearNotifications = function() {
- var $notifications = $('.data-explorer .alert-message');
- $notifications.remove();
-}
-
-})(jQuery, recline.View);
-
-this.recline = this.recline || {};
-this.recline.View = this.recline.View || {};
-
// Views module following classic module pattern
(function($, my) {
@@ -1512,6 +1192,356 @@ my.ColumnTransform = Backbone.View.extend({
});
})(jQuery, recline.View);
+this.recline = this.recline || {};
+this.recline.View = this.recline.View || {};
+
+(function($, my) {
+// ## DataExplorer
+//
+// The primary view for the entire application. Usage:
+//
+//
+// var myExplorer = new model.recline.DataExplorer({
+// model: {{recline.Model.Dataset instance}}
+// el: {{an existing dom element}}
+// views: {{page views}}
+// config: {{config options -- see below}}
+// });
+//
+//
+// ### Parameters
+//
+// **model**: (required) Dataset instance.
+//
+// **el**: (required) DOM element.
+//
+// **views**: (optional) the views (Grid, Graph etc) for DataExplorer to
+// show. This is an array of view hashes. If not provided
+// just initialize a DataGrid with id 'grid'. Example:
+//
+//
+// var views = [
+// {
+// id: 'grid', // used for routing
+// label: 'Grid', // used for view switcher
+// view: new recline.View.DataGrid({
+// model: dataset
+// })
+// },
+// {
+// id: 'graph',
+// label: 'Graph',
+// view: new recline.View.FlotGraph({
+// model: dataset
+// })
+// }
+// ];
+//
+//
+// **config**: Config options like:
+//
+// * readOnly: true/false (default: false) value indicating whether to
+// operate in read-only mode (hiding all editing options).
+//
+// NB: the element already being in the DOM is important for rendering of
+// FlotGraph subview.
+my.DataExplorer = Backbone.View.extend({
+ template: ' \
+ \
+ \
+ \
+ \
+ \
+ \
+ \
+ × \
+ {{msg}} \
+ {{#loader}} \
+ \
+ {{/loader}} \
+ ';
+ var _templated = $.mustache(_template, tmplData);
+ _templated = $(_templated).appendTo($('.data-explorer .alert-messages'));
+ if (!options.persist) {
+ setTimeout(function() {
+ $(_templated).fadeOut(1000, function() {
+ $(this).remove();
+ });
+ }, 1000);
+ }
+}
+
+// ## clearNotifications
+//
+// Clear all existing notifications
+my.clearNotifications = function() {
+ var $notifications = $('.data-explorer .alert-messages .alert');
+ $notifications.remove();
+}
+
+})(jQuery, recline.View);
+
// # Recline Backends
//
// Backends are connectors to backend data sources and stores
@@ -1580,29 +1610,10 @@ this.recline.Backend = this.recline.Backend || {};
var self = this;
if (method === "read") {
if (model.__type__ == 'Dataset') {
- var base = self.get('dataproxy_url');
- // TODO: should we cache for extra efficiency
- var data = {
- url: model.get('url')
- , 'max-results': 1
- , type: model.get('format') || 'csv'
- };
- var jqxhr = $.ajax({
- url: base
- , data: data
- , dataType: 'jsonp'
- });
+ // Do nothing as we will get fields in query step (and no metadata to
+ // retrieve)
var dfd = $.Deferred();
- my.wrapInTimeout(jqxhr).done(function(results) {
- model.fields.reset(_.map(results.fields, function(fieldId) {
- return {id: fieldId};
- })
- );
- dfd.resolve(model, jqxhr);
- })
- .fail(function(arguments) {
- dfd.reject(arguments);
- });
+ dfd.resolve(model);
return dfd.promise();
}
} else {
@@ -1622,7 +1633,14 @@ this.recline.Backend = this.recline.Backend || {};
, dataType: 'jsonp'
});
var dfd = $.Deferred();
- jqxhr.done(function(results) {
+ my.wrapInTimeout(jqxhr).done(function(results) {
+ if (results.error) {
+ dfd.reject(results.error);
+ }
+ dataset.fields.reset(_.map(results.fields, function(fieldId) {
+ return {id: fieldId};
+ })
+ );
var _out = _.map(results.data, function(doc) {
var tmp = {};
_.each(results.fields, function(key, idx) {
@@ -1631,6 +1649,9 @@ this.recline.Backend = this.recline.Backend || {};
return tmp;
});
dfd.resolve(_out);
+ })
+ .fail(function(arguments) {
+ dfd.reject(arguments);
});
return dfd.promise();
}
@@ -1645,10 +1666,21 @@ this.recline.Backend = this.recline.Backend || {};
(function($, my) {
// ## ElasticSearch Backend
//
- // Connecting to [ElasticSearch](http://www.elasticsearch.org/)
+ // Connecting to [ElasticSearch](http://www.elasticsearch.org/).
//
- // To use this backend ensure your Dataset has a elasticsearch_url,
- // webstore_url or url attribute (used in that order)
+ // To use this backend ensure your Dataset has one of the following
+ // attributes (first one found is used):
+ //
+ //
+ // elasticsearch_url
+ // webstore_url
+ // url
+ //
+ //
+ // This should point to the ES type url. E.G. for ES running on
+ // localhost:9200 with index twitter and type tweet it would be
+ //
+ // http://localhost:9200/twitter/tweet
my.ElasticSearch = Backbone.Model.extend({
_getESUrl: function(dataset) {
var out = dataset.get('elasticsearch_url');
@@ -1861,15 +1893,12 @@ this.recline.Backend = this.recline.Backend || {};
(function($, my) {
// ## Memory Backend - uses in-memory data
//
- // This is very artificial and is really only designed for testing
- // purposes.
- //
// To use it you should provide in your constructor data:
//
// * metadata (including fields array)
// * documents: list of hashes, each hash being one doc. A doc *must* have an id attribute which is unique.
//
- // Example:
+ // Example:
//
//
// // Backend setup
@@ -1886,7 +1915,7 @@ this.recline.Backend = this.recline.Backend || {};
// ]
// });
// // later ...
- // var dataset = Dataset({id: 'my-id'});
+ // var dataset = Dataset({id: 'my-id'}, 'memory');
// dataset.fetch();
// etc ...
//
diff --git a/src/backend/dataproxy.js b/src/backend/dataproxy.js
index 60cf5482..45abc89a 100644
--- a/src/backend/dataproxy.js
+++ b/src/backend/dataproxy.js
@@ -24,29 +24,10 @@ this.recline.Backend = this.recline.Backend || {};
var self = this;
if (method === "read") {
if (model.__type__ == 'Dataset') {
- var base = self.get('dataproxy_url');
- // TODO: should we cache for extra efficiency
- var data = {
- url: model.get('url')
- , 'max-results': 1
- , type: model.get('format') || 'csv'
- };
- var jqxhr = $.ajax({
- url: base
- , data: data
- , dataType: 'jsonp'
- });
+ // Do nothing as we will get fields in query step (and no metadata to
+ // retrieve)
var dfd = $.Deferred();
- my.wrapInTimeout(jqxhr).done(function(results) {
- model.fields.reset(_.map(results.fields, function(fieldId) {
- return {id: fieldId};
- })
- );
- dfd.resolve(model, jqxhr);
- })
- .fail(function(arguments) {
- dfd.reject(arguments);
- });
+ dfd.resolve(model);
return dfd.promise();
}
} else {
@@ -66,7 +47,14 @@ this.recline.Backend = this.recline.Backend || {};
, dataType: 'jsonp'
});
var dfd = $.Deferred();
- jqxhr.done(function(results) {
+ my.wrapInTimeout(jqxhr).done(function(results) {
+ if (results.error) {
+ dfd.reject(results.error);
+ }
+ dataset.fields.reset(_.map(results.fields, function(fieldId) {
+ return {id: fieldId};
+ })
+ );
var _out = _.map(results.data, function(doc) {
var tmp = {};
_.each(results.fields, function(key, idx) {
@@ -75,6 +63,9 @@ this.recline.Backend = this.recline.Backend || {};
return tmp;
});
dfd.resolve(_out);
+ })
+ .fail(function(arguments) {
+ dfd.reject(arguments);
});
return dfd.promise();
}
diff --git a/src/view-grid.js b/src/view-grid.js
index c079226b..9a0d5345 100644
--- a/src/view-grid.js
+++ b/src/view-grid.js
@@ -160,7 +160,7 @@ my.DataGrid = Backbone.View.extend({
template: ' \
\
\
- \
+ \
\
\
{{#notEmpty}} \
diff --git a/src/view.js b/src/view.js
index 4aa7d252..7c9aa408 100644
--- a/src/view.js
+++ b/src/view.js
@@ -104,17 +104,30 @@ my.DataExplorer = Backbone.View.extend({
this.router = new Backbone.Router();
this.setupRouting();
- this.model.bind('query:start', function(eventName) {
+ this.model.bind('query:start', function() {
my.notify('Loading data', {loader: true});
});
- this.model.bind('query:done', function(eventName) {
+ this.model.bind('query:done', function() {
my.clearNotifications();
self.el.find('.doc-count').text(self.model.docCount || 'Unknown');
my.notify('Data loaded', {category: 'success'});
});
- this.model.bind('query:fail', function(eventName, error) {
+ this.model.bind('query:fail', function(error) {
my.clearNotifications();
- my.notify(error.message, {category: 'error', persist: true});
+ var msg = '';
+ if (typeof(error) == 'string') {
+ msg = error;
+ } else if (typeof(error) == 'object') {
+ if (error.title) {
+ msg = error.title + ': ';
+ }
+ if (error.message) {
+ msg += error.message;
+ }
+ } else {
+ msg = 'There was an error querying the backend';
+ }
+ my.notify(msg, {category: 'error', persist: true});
});
// retrieve basic data like fields etc
@@ -164,8 +177,10 @@ my.DataExplorer = Backbone.View.extend({
updateNav: function(pageName, queryString) {
this.el.find('.navigation li').removeClass('active');
+ this.el.find('.navigation li a').removeClass('disabled');
var $el = this.el.find('.navigation li a[href=#' + pageName + ']');
$el.parent().addClass('active');
+ $el.addClass('disabled');
// show the specific page
_.each(this.pageViews, function(view, idx) {
if (view.id === pageName) {
@@ -181,13 +196,16 @@ my.DataExplorer = Backbone.View.extend({
my.QueryEditor = Backbone.View.extend({
className: 'recline-query-editor',
template: ' \
- |