// adapted from https://github.com/harthur/costco. heather rules var costco = function() { function evalFunction(funcString) { try { eval("var editFunc = " + funcString); } catch(e) { return {errorMessage: e+""}; } return editFunc; } function previewTransform(docs, editFunc, currentColumn) { var preview = []; var updated = mapDocs($.extend(true, {}, docs), editFunc); for (var i = 0; i < updated.docs.length; i++) { var before = docs[i] , after = updated.docs[i] ; if (!after) after = {}; if (currentColumn) { preview.push({before: JSON.stringify(before[currentColumn]), after: JSON.stringify(after[currentColumn])}); } else { preview.push({before: JSON.stringify(before), after: JSON.stringify(after)}); } } return preview; } function mapDocs(docs, editFunc) { var edited = [] , deleted = [] , failed = [] ; var updatedDocs = _.map(docs, function(doc) { try { var updated = editFunc(_.clone(doc)); } catch(e) { failed.push(doc); return; } if(updated === null) { updated = {_deleted: true}; edited.push(updated); deleted.push(doc); } else if(updated && !_.isEqual(updated, doc)) { edited.push(updated); } return updated; }); return { edited: edited, docs: updatedDocs, deleted: deleted, failed: failed }; } return { evalFunction: evalFunction, previewTransform: previewTransform, mapDocs: mapDocs }; }(); // # Recline Backbone Models this.recline = this.recline || {}; this.recline.Model = this.recline.Model || {}; (function($, my) { // ## A Dataset model // // A model has the following (non-Backbone) attributes: // // @property {FieldList} fields: (aka columns) is a `FieldList` listing all the // fields on this Dataset (this can be set explicitly, or, will be set by // Dataset.fetch() or Dataset.query() // // @property {DocumentList} currentDocuments: a `DocumentList` containing the // Documents we have currently loaded for viewing (updated by calling query // method) // // @property {number} docCount: total number of documents in this dataset // // @property {Backend} backend: the Backend (instance) for this Dataset // // @property {Query} queryState: `Query` object which stores current // queryState. queryState may be edited by other components (e.g. a query // editor view) changes will trigger a Dataset query. // // @property {FacetList} facets: FacetList object containing all current // Facets. my.Dataset = Backbone.Model.extend({ __type__: 'Dataset', // ### initialize // // Sets up instance properties (see above) initialize: function(model, backend) { _.bindAll(this, 'query'); this.backend = backend; if (backend && backend.constructor == String) { this.backend = my.backends[backend]; } this.fields = new my.FieldList(); this.currentDocuments = new my.DocumentList(); this.facets = new my.FacetList(); this.docCount = null; this.queryState = new my.Query(); this.queryState.bind('change', this.query); this.queryState.bind('facet:add', this.query); }, // ### query // // AJAX method with promise API to get documents from the backend. // // It will query based on current query state (given by this.queryState) // updated by queryObj (if provided). // // Resulting DocumentList are used to reset this.currentDocuments and are // also returned. query: function(queryObj) { var self = this; this.trigger('query:start'); var actualQuery = self._prepareQuery(queryObj); var dfd = $.Deferred(); this.backend.query(this, actualQuery).done(function(queryResult) { self.docCount = queryResult.total; var docs = _.map(queryResult.hits, function(hit) { var _doc = new my.Document(hit._source); _doc.backend = self.backend; _doc.dataset = self; return _doc; }); self.currentDocuments.reset(docs); if (queryResult.facets) { var facets = _.map(queryResult.facets, function(facetResult, facetId) { facetResult.id = facetId; return new my.Facet(facetResult); }); self.facets.reset(facets); } self.trigger('query:done'); dfd.resolve(self.currentDocuments); }) .fail(function(arguments) { self.trigger('query:fail', arguments); dfd.reject(arguments); }); return dfd.promise(); }, _prepareQuery: function(newQueryObj) { if (newQueryObj) { this.queryState.set(newQueryObj); } var out = this.queryState.toJSON(); return out; }, toTemplateJSON: function() { var data = this.toJSON(); data.docCount = this.docCount; data.fields = this.fields.toJSON(); return data; } }); // ## A Document (aka Row) // // A single entry or row in the dataset my.Document = Backbone.Model.extend({ __type__: 'Document', initialize: function() { _.bindAll(this, 'getFieldValue'); }, // ### getFieldValue // // For the provided Field get the corresponding rendered computed data value // for this document. getFieldValue: function(field) { var val = this.get(field.id); if (field.deriver) { val = field.deriver(val, field, this); } if (field.renderer) { val = field.renderer(val, field, this); } return val; } }); // ## A Backbone collection of Documents my.DocumentList = Backbone.Collection.extend({ __type__: 'DocumentList', model: my.Document }); // ## A Field (aka Column) on a Dataset // // Following (Backbone) attributes as standard: // // * id: a unique identifer for this field- usually this should match the key in the documents hash // * label: (optional: defaults to id) the visible label used for this field // * type: (optional: defaults to string) the type of the data in this field. Should be a string as per type names defined by ElasticSearch - see Types list on // * format: (optional) used to indicate how the data should be formatted. For example: // * type=date, format=yyyy-mm-dd // * type=float, format=percentage // * type=float, format='###,###.##' // * is_derived: (default: false) attribute indicating this field has no backend data but is just derived from other fields (see below). // // Following additional instance properties: // // @property {Function} renderer: a function to render the data for this field. // Signature: function(value, field, doc) where value is the value of this // cell, field is corresponding field object and document is the document // object. Note that implementing functions can ignore arguments (e.g. // function(value) would be a valid formatter function). // // @property {Function} deriver: a function to derive/compute the value of data // in this field as a function of this field's value (if any) and the current // document, its signature and behaviour is the same as for renderer. Use of // this function allows you to define an entirely new value for data in this // field. This provides support for a) 'derived/computed' fields: i.e. fields // whose data are functions of the data in other fields b) transforming the // value of this field prior to rendering. my.Field = Backbone.Model.extend({ // ### defaults - define default values defaults: { label: null, type: 'string', format: null, is_derived: false }, // ### initialize // // @param {Object} data: standard Backbone model attributes // // @param {Object} options: renderer and/or deriver functions. initialize: function(data, options) { // if a hash not passed in the first argument throw error if ('0' in data) { throw new Error('Looks like you did not pass a proper hash with id to Field constructor'); } if (this.attributes.label === null) { this.set({label: this.id}); } if (options) { this.renderer = options.renderer; this.deriver = options.deriver; } if (!this.renderer) { this.renderer = this.defaultRenderers[this.get('type')]; } }, defaultRenderers: { object: function(val, field, doc) { return JSON.stringify(val); }, 'float': function(val, field, doc) { var format = field.get('format'); if (format === 'percentage') { return val + '%'; } } } }); my.FieldList = Backbone.Collection.extend({ model: my.Field }); // ## Query // // Query instances encapsulate a query to the backend (see query method on backend). Useful both // for creating queries and for storing and manipulating query state - // e.g. from a query editor). // // **Query Structure and format** // // Query structure should follow that of [ElasticSearch query // language](http://www.elasticsearch.org/guide/reference/api/search/). // // **NB: It is up to specific backends how to implement and support this query // structure. Different backends might choose to implement things differently // or not support certain features. Please check your backend for details.** // // Query object has the following key attributes: // // * size (=limit): number of results to return // * from (=offset): offset into result set - http://www.elasticsearch.org/guide/reference/api/search/from-size.html // * sort: sort order - // * query: Query in ES Query DSL // * filter: See filters and Filtered Query // * fields: set of fields to return - http://www.elasticsearch.org/guide/reference/api/search/fields.html // * facets: specification of facets - see http://www.elasticsearch.org/guide/reference/api/search/facets/ // // Additions: // // * q: either straight text or a hash will map directly onto a [query_string // query](http://www.elasticsearch.org/guide/reference/query-dsl/query-string-query.html) // in backend // // * Of course this can be re-interpreted by different backends. E.g. some // may just pass this straight through e.g. for an SQL backend this could be // the full SQL query // // * filters: dict of ElasticSearch filters. These will be and-ed together for // execution. // // **Examples** // //
// {
//    q: 'quick brown fox',
//    filters: [
//      { term: { 'owner': 'jones' } }
//    ]
// }
// 
my.Query = Backbone.Model.extend({ defaults: function() { return { size: 100, from: 0, facets: {}, // // , filter: {} filters: [] }; }, // #### addTermFilter // // Set (update or add) a terms filter to filters // // See addTermFilter: function(fieldId, value) { var filters = this.get('filters'); var filter = { term: {} }; filter.term[fieldId] = value; filters.push(filter); this.set({filters: filters}); // change does not seem to be triggered automatically if (value) { this.trigger('change'); } else { // adding a new blank filter and do not want to trigger a new query this.trigger('change:filters:new-blank'); } }, // ### removeFilter // // Remove a filter from filters at index filterIndex removeFilter: function(filterIndex) { var filters = this.get('filters'); filters.splice(filterIndex, 1); this.set({filters: filters}); this.trigger('change'); }, // ### addFacet // // Add a Facet to this query // // See addFacet: function(fieldId) { var facets = this.get('facets'); // Assume id and fieldId should be the same (TODO: this need not be true if we want to add two different type of facets on same field) if (_.contains(_.keys(facets), fieldId)) { return; } facets[fieldId] = { terms: { field: fieldId } }; this.set({facets: facets}, {silent: true}); this.trigger('facet:add', this); }, addHistogramFacet: function(fieldId) { var facets = this.get('facets'); facets[fieldId] = { date_histogram: { field: fieldId, interval: 'day' } }; this.set({facets: facets}, {silent: true}); this.trigger('facet:add', this); } }); // ## A Facet (Result) // // Object to store Facet information, that is summary information (e.g. values // and counts) about a field obtained by some faceting method on the // backend. // // Structure of a facet follows that of Facet results in ElasticSearch, see: // // // Specifically the object structure of a facet looks like (there is one // addition compared to ElasticSearch: the "id" field which corresponds to the // key used to specify this facet in the facet query): // //
// {
//   "id": "id-of-facet",
//   // type of this facet (terms, range, histogram etc)
//   "_type" : "terms",
//   // total number of tokens in the facet
//   "total": 5,
//   // @property {number} number of documents which have no value for the field
//   "missing" : 0,
//   // number of facet values not included in the returned facets
//   "other": 0,
//   // term object ({term: , count: ...})
//   "terms" : [ {
//       "term" : "foo",
//       "count" : 2
//     }, {
//       "term" : "bar",
//       "count" : 2
//     }, {
//       "term" : "baz",
//       "count" : 1
//     }
//   ]
// }
// 
my.Facet = Backbone.Model.extend({ defaults: function() { return { _type: 'terms', total: 0, other: 0, missing: 0, terms: [] }; } }); // ## A Collection/List of Facets my.FacetList = Backbone.Collection.extend({ model: my.Facet }); // ## Backend registry // // Backends will register themselves by id into this registry my.backends = {}; }(jQuery, this.recline.Model)); /*jshint multistr:true */ var util = function() { var templates = { transformActions: '
  • Global transform...
  • ', cellEditor: ' \ \ ', editPreview: ' \
    \ \ \ \ \ \ \ \ \ {{#rows}} \ \ \ \ \ {{/rows}} \ \
    \ before \ \ after \
    \ {{before}} \ \ {{after}} \
    \
    \ ' }; $.fn.serializeObject = function() { var o = {}; var a = this.serializeArray(); $.each(a, function() { if (o[this.name]) { if (!o[this.name].push) { o[this.name] = [o[this.name]]; } o[this.name].push(this.value || ''); } else { o[this.name] = this.value || ''; } }); return o; }; function registerEmitter() { var Emitter = function(obj) { this.emit = function(obj, channel) { if (!channel) channel = 'data'; this.trigger(channel, obj); }; }; MicroEvent.mixin(Emitter); return new Emitter(); } function listenFor(keys) { var shortcuts = { // from jquery.hotkeys.js 8: "backspace", 9: "tab", 13: "return", 16: "shift", 17: "ctrl", 18: "alt", 19: "pause", 20: "capslock", 27: "esc", 32: "space", 33: "pageup", 34: "pagedown", 35: "end", 36: "home", 37: "left", 38: "up", 39: "right", 40: "down", 45: "insert", 46: "del", 96: "0", 97: "1", 98: "2", 99: "3", 100: "4", 101: "5", 102: "6", 103: "7", 104: "8", 105: "9", 106: "*", 107: "+", 109: "-", 110: ".", 111 : "/", 112: "f1", 113: "f2", 114: "f3", 115: "f4", 116: "f5", 117: "f6", 118: "f7", 119: "f8", 120: "f9", 121: "f10", 122: "f11", 123: "f12", 144: "numlock", 145: "scroll", 191: "/", 224: "meta" }; window.addEventListener("keyup", function(e) { var pressed = shortcuts[e.keyCode]; if(_.include(keys, pressed)) app.emitter.emit("keyup", pressed); }, false); } function observeExit(elem, callback) { var cancelButton = elem.find('.cancelButton'); // TODO: remove (commented out as part of Backbon-i-fication // app.emitter.on('esc', function() { // cancelButton.click(); // app.emitter.clear('esc'); // }); cancelButton.click(callback); } function show( thing ) { $('.' + thing ).show(); $('.' + thing + '-overlay').show(); } function hide( thing ) { $('.' + thing ).hide(); $('.' + thing + '-overlay').hide(); // TODO: remove or replace (commented out as part of Backbon-i-fication // if (thing === "dialog") app.emitter.clear('esc'); // todo more elegant solution } function position( thing, elem, offset ) { var position = $(elem.target).position(); if (offset) { if (offset.top) position.top += offset.top; if (offset.left) position.left += offset.left; } $('.' + thing + '-overlay').show().click(function(e) { $(e.target).hide(); $('.' + thing).hide(); }); $('.' + thing).show().css({top: position.top + $(elem.target).height(), left: position.left}); } function render( template, target, options ) { if ( !options ) options = {data: {}}; if ( !options.data ) options = {data: options}; var html = $.mustache( templates[template], options.data ); var targetDom = null; if (target instanceof jQuery) { targetDom = target; } else { targetDom = $( "." + target + ":first" ); } if( options.append ) { targetDom.append( html ); } else { targetDom.html( html ); } // TODO: remove (commented out as part of Backbon-i-fication // if (template in app.after) app.after[template](); } return { registerEmitter: registerEmitter, listenFor: listenFor, show: show, hide: hide, position: position, render: render, observeExit: observeExit }; }(); /*jshint multistr:true */ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { // ## Graph view for a Dataset using Flot graphing library. // // Initialization arguments: // // * model: recline.Model.Dataset // * config: (optional) graph configuration hash of form: // // { // group: {column name for x-axis}, // series: [{column name for series A}, {column name series B}, ... ], // graphType: 'line' // } // // NB: should *not* provide an el argument to the view but must let the view // generate the element itself (you can then append view.el to the DOM. my.FlotGraph = Backbone.View.extend({ tagName: "div", className: "data-graph-container", template: ' \
    \
    \

    Help »

    \

    To create a chart select a column (group) to use as the x-axis \ then another column (Series A) to plot against it.

    \

    You can add add \ additional series by clicking the "Add series" button

    \
    \
    \
    \ \
    \ \
    \ \
    \ \
    \
    \
    \ \
    \ \
    \
    \
    \
    \
    \ \
    \ \
    \
    \
    \ \ ', events: { 'change form select': 'onEditorSubmit', 'click .editor-add': 'addSeries', 'click .action-remove-series': 'removeSeries', 'click .action-toggle-help': 'toggleHelp' }, initialize: function(options, config) { var self = this; this.el = $(this.el); _.bindAll(this, 'render', 'redraw'); // we need the model.fields to render properly this.model.bind('change', this.render); this.model.fields.bind('reset', this.render); this.model.fields.bind('add', this.render); this.model.currentDocuments.bind('add', this.redraw); this.model.currentDocuments.bind('reset', this.redraw); var configFromHash = my.parseHashQueryString().graph; if (configFromHash) { configFromHash = JSON.parse(configFromHash); } this.chartConfig = _.extend({ group: null, series: [], graphType: 'lines-and-points' }, configFromHash, config ); this.render(); }, render: function() { htmls = $.mustache(this.template, this.model.toTemplateJSON()); $(this.el).html(htmls); // now set a load of stuff up this.$graph = this.el.find('.panel.graph'); // for use later when adding additional series // could be simpler just to have a common template! this.$seriesClone = this.el.find('.editor-series').clone(); this._updateSeries(); return this; }, onEditorSubmit: function(e) { var select = this.el.find('.editor-group select'); $editor = this; var series = this.$series.map(function () { return $(this).val(); }); this.chartConfig.series = $.makeArray(series); this.chartConfig.group = this.el.find('.editor-group select').val(); this.chartConfig.graphType = this.el.find('.editor-type select').val(); // update navigation var qs = my.parseHashQueryString(); qs.graph = JSON.stringify(this.chartConfig); my.setHashQueryString(qs); this.redraw(); }, redraw: function() { // There appear to be issues generating a Flot graph if either: // * The relevant div that graph attaches to his hidden at the moment of creating the plot -- Flot will complain with // // Uncaught Invalid dimensions for plot, width = 0, height = 0 // * There is no data for the plot -- either same error or may have issues later with errors like 'non-existent node-value' var areWeVisible = !jQuery.expr.filters.hidden(this.el[0]); if ((!areWeVisible || this.model.currentDocuments.length === 0)) { return; } var series = this.createSeries(); var options = this.getGraphOptions(this.chartConfig.graphType); this.plot = $.plot(this.$graph, series, options); this.setupTooltips(); // create this.plot and cache it // if (!this.plot) { // this.plot = $.plot(this.$graph, series, options); // } else { // this.plot.parseOptions(options); // this.plot.setData(this.createSeries()); // this.plot.resize(); // this.plot.setupGrid(); // this.plot.draw(); // } }, // needs to be function as can depend on state getGraphOptions: function(typeId) { var self = this; // special tickformatter to show labels rather than numbers var tickFormatter = function (val) { if (self.model.currentDocuments.models[val]) { var out = self.model.currentDocuments.models[val].get(self.chartConfig.group); // if the value was in fact a number we want that not the if (typeof(out) == 'number') { return val; } else { return out; } } return val; }; // TODO: we should really use tickFormatter and 1 interval ticks if (and // only if) x-axis values are non-numeric // However, that is non-trivial to work out from a dataset (datasets may // have no field type info). Thus at present we only do this for bars. var options = { lines: { series: { lines: { show: true } } }, points: { series: { points: { show: true } }, grid: { hoverable: true, clickable: true } }, 'lines-and-points': { series: { points: { show: true }, lines: { show: true } }, grid: { hoverable: true, clickable: true } }, bars: { series: { lines: {show: false}, bars: { show: true, barWidth: 1, align: "center", fill: true, horizontal: true } }, grid: { hoverable: true, clickable: true }, yaxis: { tickSize: 1, tickLength: 1, tickFormatter: tickFormatter, min: -0.5, max: self.model.currentDocuments.length - 0.5 } } }; return options[typeId]; }, setupTooltips: function() { var self = this; function showTooltip(x, y, contents) { $('
    ' + contents + '
    ').css( { position: 'absolute', display: 'none', top: y + 5, left: x + 5, border: '1px solid #fdd', padding: '2px', 'background-color': '#fee', opacity: 0.80 }).appendTo("body").fadeIn(200); } var previousPoint = null; this.$graph.bind("plothover", function (event, pos, item) { if (item) { if (previousPoint != item.datapoint) { previousPoint = item.datapoint; $("#flot-tooltip").remove(); var x = item.datapoint[0]; var y = item.datapoint[1]; // convert back from 'index' value on x-axis (e.g. in cases where non-number values) if (self.model.currentDocuments.models[x]) { x = self.model.currentDocuments.models[x].get(self.chartConfig.group); } else { x = x.toFixed(2); } y = y.toFixed(2); var content = _.template('<%= group %> = <%= x %>, <%= series %> = <%= y %>', { group: self.chartConfig.group, x: x, series: item.series.label, y: y }); showTooltip(item.pageX, item.pageY, content); } } else { $("#flot-tooltip").remove(); previousPoint = null; } }); }, createSeries: function () { var self = this; var series = []; if (this.chartConfig) { $.each(this.chartConfig.series, function (seriesIndex, field) { var points = []; $.each(self.model.currentDocuments.models, function (index, doc) { var x = doc.get(self.chartConfig.group); var y = doc.get(field); if (typeof x === 'string') { x = index; } // horizontal bar chart if (self.chartConfig.graphType == 'bars') { points.push([y, x]); } else { points.push([x, y]); } }); series.push({data: points, label: field}); }); } return series; }, // Public: Adds a new empty series select box to the editor. // // All but the first select box will have a remove button that allows them // to be removed. // // Returns itself. addSeries: function (e) { e.preventDefault(); var element = this.$seriesClone.clone(), label = element.find('label'), index = this.$series.length; this.el.find('.editor-series-group').append(element); this._updateSeries(); label.append(' [Remove]'); label.find('span').text(String.fromCharCode(this.$series.length + 64)); return this; }, // Public: Removes a series list item from the editor. // // Also updates the labels of the remaining series elements. removeSeries: function (e) { e.preventDefault(); var $el = $(e.target); $el.parent().parent().remove(); this._updateSeries(); this.$series.each(function (index) { if (index > 0) { var labelSpan = $(this).prev().find('span'); labelSpan.text(String.fromCharCode(index + 65)); } }); this.onEditorSubmit(); }, toggleHelp: function() { this.el.find('.editor-info').toggleClass('editor-hide-info'); }, // Private: Resets the series property to reference the select elements. // // Returns itself. _updateSeries: function () { this.$series = this.el.find('.editor-series select'); } }); })(jQuery, recline.View); /*jshint multistr:true */ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { // ## DataGrid // // Provides a tabular view on a Dataset. // // Initialize it with a `recline.Model.Dataset`. my.DataGrid = Backbone.View.extend({ tagName: "div", className: "recline-grid-container", initialize: function(modelEtc) { var self = this; this.el = $(this.el); _.bindAll(this, 'render'); this.model.currentDocuments.bind('add', this.render); this.model.currentDocuments.bind('reset', this.render); this.model.currentDocuments.bind('remove', this.render); this.state = {}; this.hiddenFields = []; }, events: { 'click .column-header-menu': 'onColumnHeaderClick', 'click .row-header-menu': 'onRowHeaderClick', 'click .root-header-menu': 'onRootHeaderClick', 'click .data-table-menu li a': 'onMenuClick' }, // TODO: delete or re-enable (currently this code is not used from anywhere except deprecated or disabled methods (see above)). // showDialog: function(template, data) { // if (!data) data = {}; // util.show('dialog'); // util.render(template, 'dialog-content', data); // util.observeExit($('.dialog-content'), function() { // util.hide('dialog'); // }) // $('.dialog').draggable({ handle: '.dialog-header', cursor: 'move' }); // }, // ====================================================== // Column and row menus onColumnHeaderClick: function(e) { this.state.currentColumn = $(e.target).closest('.column-header').attr('data-field'); }, onRowHeaderClick: function(e) { this.state.currentRow = $(e.target).parents('tr:first').attr('data-id'); }, onRootHeaderClick: function(e) { var tmpl = ' \ {{#columns}} \
  • Show column: {{.}}
  • \ {{/columns}}'; var tmp = $.mustache(tmpl, {'columns': this.hiddenFields}); this.el.find('.root-header-menu .dropdown-menu').html(tmp); }, onMenuClick: function(e) { var self = this; e.preventDefault(); var actions = { bulkEdit: function() { self.showTransformColumnDialog('bulkEdit', {name: self.state.currentColumn}); }, facet: function() { self.model.queryState.addFacet(self.state.currentColumn); }, facet_histogram: function() { self.model.queryState.addHistogramFacet(self.state.currentColumn); }, filter: function() { self.model.queryState.addTermFilter(self.state.currentColumn, ''); }, transform: function() { self.showTransformDialog('transform'); }, sortAsc: function() { self.setColumnSort('asc'); }, sortDesc: function() { self.setColumnSort('desc'); }, hideColumn: function() { self.hideColumn(); }, showColumn: function() { self.showColumn(e); }, deleteRow: function() { var doc = _.find(self.model.currentDocuments.models, function(doc) { // important this is == as the currentRow will be string (as comes // from DOM) while id may be int return doc.id == self.state.currentRow; }); doc.destroy().then(function() { self.model.currentDocuments.remove(doc); my.notify("Row deleted successfully"); }).fail(function(err) { my.notify("Errorz! " + err); }); } }; actions[$(e.target).attr('data-action')](); }, showTransformColumnDialog: function() { var $el = $('.dialog-content'); util.show('dialog'); var view = new my.ColumnTransform({ model: this.model }); view.state = this.state; view.render(); $el.empty(); $el.append(view.el); util.observeExit($el, function() { util.hide('dialog'); }); $('.dialog').draggable({ handle: '.dialog-header', cursor: 'move' }); }, showTransformDialog: function() { var $el = $('.dialog-content'); util.show('dialog'); var view = new recline.View.DataTransform({ }); view.render(); $el.empty(); $el.append(view.el); util.observeExit($el, function() { util.hide('dialog'); }); $('.dialog').draggable({ handle: '.dialog-header', cursor: 'move' }); }, setColumnSort: function(order) { var sort = [{}]; sort[0][this.state.currentColumn] = {order: order}; this.model.query({sort: sort}); }, hideColumn: function() { this.hiddenFields.push(this.state.currentColumn); this.render(); }, showColumn: function(e) { this.hiddenFields = _.without(this.hiddenFields, $(e.target).data('column')); this.render(); }, // ====================================================== // #### Templating template: ' \ \ \ \ {{#notEmpty}} \ \ {{/notEmpty}} \ {{#fields}} \ \ {{/fields}} \ \ \ \
    \
    \ \ \
    \ \
    \ \ {{label}} \
    \ ', toTemplateJSON: function() { var modelData = this.model.toJSON(); modelData.notEmpty = ( this.fields.length > 0 ); // TODO: move this sort of thing into a toTemplateJSON method on Dataset? modelData.fields = _.map(this.fields, function(field) { return field.toJSON(); }); return modelData; }, render: function() { var self = this; this.fields = this.model.fields.filter(function(field) { return _.indexOf(self.hiddenFields, field.id) == -1; }); var htmls = $.mustache(this.template, this.toTemplateJSON()); this.el.html(htmls); this.model.currentDocuments.forEach(function(doc) { var tr = $(''); self.el.find('tbody').append(tr); var newView = new my.DataGridRow({ model: doc, el: tr, fields: self.fields }); newView.render(); }); this.el.toggleClass('no-hidden', (self.hiddenFields.length === 0)); return this; } }); // ## 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 FieldList in the constructor options. This should be list of fields for the DataGrid. // // Example: // //
    // var row = new DataGridRow({
    //   model: dataset-document,
    //     el: dom-element,
    //     fields: mydatasets.fields // a FieldList object
    //   });
    // 
    my.DataGridRow = Backbone.View.extend({ initialize: function(initData) { _.bindAll(this, 'render'); this._fields = initData.fields; this.el = $(this.el); this.model.bind('change', this.render); }, template: ' \ \
    \ \ \
    \ \ {{#cells}} \ \
    \   \
    {{{value}}}
    \
    \ \ {{/cells}} \ ', events: { 'click .data-table-cell-edit': 'onEditClick', 'click .data-table-cell-editor .okButton': 'onEditorOK', 'click .data-table-cell-editor .cancelButton': 'onEditorCancel' }, toTemplateJSON: function() { var self = this; var doc = this.model; var cellData = this._fields.map(function(field) { return { field: field.id, value: doc.getFieldValue(field) }; }); return { id: this.id, cells: cellData }; }, render: function() { this.el.attr('data-id', this.model.id); var html = $.mustache(this.template, this.toTemplateJSON()); $(this.el).html(html); return this; }, // =================== // Cell Editor methods onEditClick: function(e) { var editing = this.el.find('.data-table-cell-editor-editor'); if (editing.length > 0) { editing.parents('.data-table-cell-value').html(editing.text()).siblings('.data-table-cell-edit').removeClass("hidden"); } $(e.target).addClass("hidden"); var cell = $(e.target).siblings('.data-table-cell-value'); cell.data("previousContents", cell.text()); util.render('cellEditor', cell, {value: cell.text()}); }, onEditorOK: function(e) { var cell = $(e.target); var rowId = cell.parents('tr').attr('data-id'); var field = cell.parents('td').attr('data-field'); var newValue = cell.parents('.data-table-cell-editor').find('.data-table-cell-editor-editor').val(); var newData = {}; newData[field] = newValue; this.model.set(newData); my.notify("Updating row...", {loader: true}); this.model.save().then(function(response) { my.notify("Row updated successfully", {category: 'success'}); }) .fail(function() { my.notify('Error saving row', { category: 'error', persist: true }); }); }, onEditorCancel: function(e) { var cell = $(e.target).parents('.data-table-cell-value'); cell.html(cell.data('previousContents')).siblings('.data-table-cell-edit').removeClass("hidden"); } }); })(jQuery, recline.View); /*jshint multistr:true */ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; (function($, my) { // ## Map view for a Dataset using Leaflet mapping library. // // This view allows to plot gereferenced documents on a map. The location // information can be provided either via a field with // [GeoJSON](http://geojson.org) objects or two fields with latitude and // longitude coordinates. // // Initialization arguments: // // * options: initial options. They must contain a model: // // { // model: {recline.Model.Dataset} // } // // * config: (optional) map configuration hash (not yet used) // // my.Map = Backbone.View.extend({ tagName: 'div', className: 'data-map-container', template: ' \
    \
    \
    \
    \ \ \
    \
    \ \
    \ \
    \ \
    \ \
    \
    \ \
    \
    \ \
    \ \
    \ \ \
    \
    \ ', // These are the default field names that will be used if found. // If not found, the user will need to define the fields via the editor. latitudeFieldNames: ['lat','latitude'], longitudeFieldNames: ['lon','longitude'], geometryFieldNames: ['geom','the_geom','geometry','spatial','location'], // Define here events for UI elements events: { 'click .editor-update-map': 'onEditorSubmit', 'change .editor-field-type': 'onFieldTypeChange' }, initialize: function(options, config) { var self = this; this.el = $(this.el); // Listen to changes in the fields this.model.bind('change', function() { self._setupGeometryField(); }); this.model.fields.bind('add', this.render); this.model.fields.bind('reset', function(){ self._setupGeometryField() self.render() }); // Listen to changes in the documents this.model.currentDocuments.bind('add', function(doc){self.redraw('add',doc)}); this.model.currentDocuments.bind('remove', function(doc){self.redraw('remove',doc)}); this.model.currentDocuments.bind('reset', function(){self.redraw('reset')}); // If the div was hidden, Leaflet needs to recalculate some sizes // to display properly this.bind('view:show',function(){ self.map.invalidateSize(); }); this.mapReady = false; this.render(); }, // Public: Adds the necessary elements to the page. // // Also sets up the editor fields and the map if necessary. render: function() { var self = this; htmls = $.mustache(this.template, this.model.toTemplateJSON()); $(this.el).html(htmls); this.$map = this.el.find('.panel.map'); if (this.geomReady && this.model.fields.length){ if (this._geomFieldName){ this._selectOption('editor-geom-field',this._geomFieldName); $('#editor-field-type-geom').attr('checked','checked').change(); } else{ this._selectOption('editor-lon-field',this._lonFieldName); this._selectOption('editor-lat-field',this._latFieldName); $('#editor-field-type-latlon').attr('checked','checked').change(); } } this.model.bind('query:done', function() { if (!self.geomReady){ self._setupGeometryField(); } if (!self.mapReady){ self._setupMap(); } self.redraw(); }); return this; }, // Public: Redraws the features on the map according to the action provided // // Actions can be: // // * reset: Clear all features // * add: Add one or n features (documents) // * remove: Remove one or n features (documents) // * refresh: Clear existing features and add all current documents // redraw: function(action,doc){ var self = this; action = action || 'refresh'; if (this.geomReady && this.mapReady){ if (action == 'reset'){ this.features.clearLayers(); } else if (action == 'add' && doc){ this._add(doc); } else if (action == 'remove' && doc){ this._remove(doc); } else if (action == 'refresh'){ this.features.clearLayers(); this._add(this.model.currentDocuments.models); } } }, // // UI Event handlers // // Public: Update map with user options // // Right now the only configurable option is what field(s) contains the // location information. // onEditorSubmit: function(e){ e.preventDefault(); if ($('#editor-field-type-geom').attr('checked')){ this._geomFieldName = $('.editor-geom-field > select > option:selected').val(); this._latFieldName = this._lonFieldName = false; } else { this._geomFieldName = false; this._latFieldName = $('.editor-lat-field > select > option:selected').val(); this._lonFieldName = $('.editor-lon-field > select > option:selected').val(); } this.geomReady = (this._geomFieldName || (this._latFieldName && this._lonFieldName)); this.redraw(); return false; }, // Public: Shows the relevant select lists depending on the location field // type selected. // onFieldTypeChange: function(e){ if (e.target.value == 'geom'){ $('.editor-field-type-geom').show(); $('.editor-field-type-latlon').hide(); } else { $('.editor-field-type-geom').hide(); $('.editor-field-type-latlon').show(); } }, // Private: Add one or n features to the map // // For each document passed, a GeoJSON geometry will be extracted and added // to the features layer. If an exception is thrown, the process will be // stopped and an error notification shown. // // Each feature will have a popup associated with all the document fields. // _add: function(docs){ var self = this; if (!(docs instanceof Array)) docs = [docs]; _.every(docs,function(doc){ var feature = self._getGeometryFromDocument(doc); if (typeof feature === 'undefined'){ // Empty field return true; } else if (feature instanceof Object){ // Build popup contents // TODO: mustache? html = '' for (key in doc.attributes){ html += '
    ' + key + ': '+ doc.attributes[key] + '
    ' } feature.properties = {popupContent: html}; // Add a reference to the model id, which will allow us to // link this Leaflet layer to a Recline doc feature.properties.cid = doc.cid; try { self.features.addGeoJSON(feature); } catch (except) { var msg = 'Wrong geometry value'; if (except.message) msg += ' (' + except.message + ')'; my.notify(msg,{category:'error'}); return false; } } else { my.notify('Wrong geometry value',{category:'error'}); return false; } return true; }); }, // Private: Remove one or n features to the map // _remove: function(docs){ var self = this; if (!(docs instanceof Array)) docs = [docs]; _.each(doc,function(doc){ for (key in self.features._layers){ if (self.features._layers[key].cid == doc.cid){ self.features.removeLayer(self.features._layers[key]); } } }); }, // Private: Return a GeoJSON geomtry extracted from the document fields // _getGeometryFromDocument: function(doc){ if (this.geomReady){ if (this._geomFieldName){ // We assume that the contents of the field are a valid GeoJSON object return doc.attributes[this._geomFieldName]; } else if (this._lonFieldName && this._latFieldName){ // We'll create a GeoJSON like point object from the two lat/lon fields return { type: 'Point', coordinates: [ doc.attributes[this._lonFieldName], doc.attributes[this._latFieldName] ] }; } return null; } }, // Private: Check if there is a field with GeoJSON geometries or alternatively, // two fields with lat/lon values. // // If not found, the user can define them via the UI form. _setupGeometryField: function(){ var geomField, latField, lonField; this._geomFieldName = this._checkField(this.geometryFieldNames); this._latFieldName = this._checkField(this.latitudeFieldNames); this._lonFieldName = this._checkField(this.longitudeFieldNames); this.geomReady = (this._geomFieldName || (this._latFieldName && this._lonFieldName)); }, // Private: Check if a field in the current model exists in the provided // list of names. // // _checkField: function(fieldNames){ var field; var modelFieldNames = this.model.fields.pluck('id'); for (var i = 0; i < fieldNames.length; i++){ for (var j = 0; j < modelFieldNames.length; j++){ if (modelFieldNames[j].toLowerCase() == fieldNames[i].toLowerCase()) return modelFieldNames[j]; } } return null; }, // Private: Sets up the Leaflet map control and the features layer. // // The map uses a base layer from [MapQuest](http://www.mapquest.com) based // on [OpenStreetMap](http://openstreetmap.org). // _setupMap: function(){ this.map = new L.Map(this.$map.get(0)); var mapUrl = "http://otile{s}.mqcdn.com/tiles/1.0.0/osm/{z}/{x}/{y}.png"; var osmAttribution = 'Map data © 2011 OpenStreetMap contributors, Tiles Courtesy of MapQuest '; var bg = new L.TileLayer(mapUrl, {maxZoom: 18, attribution: osmAttribution ,subdomains: '1234'}); this.map.addLayer(bg); this.features = new L.GeoJSON(); this.features.on('featureparse', function (e) { if (e.properties && e.properties.popupContent){ e.layer.bindPopup(e.properties.popupContent); } if (e.properties && e.properties.cid){ e.layer.cid = e.properties.cid; } }); this.map.addLayer(this.features); this.map.setView(new L.LatLng(0, 0), 2); this.mapReady = true; }, // Private: Helper function to select an option from a select list // _selectOption: function(id,value){ var options = $('.' + id + ' > select > option'); if (options){ options.each(function(opt){ if (this.value == value) { $(this).attr('selected','selected'); return false; } }); } } }); })(jQuery, recline.View); /*jshint multistr:true */ this.recline = this.recline || {}; this.recline.View = this.recline.View || {}; // Views module following classic module pattern (function($, my) { // View (Dialog) for doing data transformations on whole dataset. my.DataTransform = Backbone.View.extend({ className: 'transform-view', template: ' \
    \ Recursive transform on all rows \
    \
    \
    \

    Traverse and transform objects by visiting every node on a recursive walk using js-traverse.

    \ \ \ \ \ \ \
    \
    \ \ \ \ \ \ \ \ \ \ \ \ \ \
    \ Expression \
    \
    \ \
    \
    \ No syntax error. \
    \
    \ Preview \
    \
    \
    \
    \
    \
    \
    \
    \
    \
    \ \ ', initialize: function() { this.el = $(this.el); }, render: function() { this.el.html(this.template); } }); // View (Dialog) for doing data transformations (on columns of data). my.ColumnTransform = Backbone.View.extend({ className: 'transform-column-view', template: ' \
    \ Functional transform on column {{name}} \
    \
    \
    \ \ \ \ \ \ \
    \
    \ \ \ \ \ \ \ \ \ \ \ \ \ \
    \ Expression \
    \
    \ \
    \
    \ No syntax error. \
    \
    \ Preview \
    \
    \
    \
    \
    \
    \
    \
    \
    \
    \ \ ', events: { 'click .okButton': 'onSubmit', 'keydown .expression-preview-code': 'onEditorKeydown' }, initialize: function() { this.el = $(this.el); }, render: function() { var htmls = $.mustache(this.template, {name: this.state.currentColumn} ); this.el.html(htmls); // Put in the basic (identity) transform script // TODO: put this into the template? var editor = this.el.find('.expression-preview-code'); editor.val("function(doc) {\n doc['"+ this.state.currentColumn+"'] = doc['"+ this.state.currentColumn+"'];\n return doc;\n}"); editor.focus().get(0).setSelectionRange(18, 18); editor.keydown(); }, onSubmit: function(e) { var self = this; var funcText = this.el.find('.expression-preview-code').val(); var editFunc = costco.evalFunction(funcText); if (editFunc.errorMessage) { my.notify("Error with function! " + editFunc.errorMessage); return; } util.hide('dialog'); my.notify("Updating all visible docs. This could take a while...", {persist: true, loader: true}); var docs = self.model.currentDocuments.map(function(doc) { return doc.toJSON(); }); // TODO: notify about failed docs? var toUpdate = costco.mapDocs(docs, editFunc).edited; var totalToUpdate = toUpdate.length; function onCompletedUpdate() { totalToUpdate += -1; if (totalToUpdate === 0) { my.notify(toUpdate.length + " documents updated successfully"); alert('WARNING: We have only updated the docs in this view. (Updating of all docs not yet implemented!)'); self.remove(); } } // TODO: Very inefficient as we search through all docs every time! _.each(toUpdate, function(editedDoc) { var realDoc = self.model.currentDocuments.get(editedDoc.id); realDoc.set(editedDoc); realDoc.save().then(onCompletedUpdate).fail(onCompletedUpdate); }); }, onEditorKeydown: function(e) { var self = this; // if you don't setTimeout it won't grab the latest character if you call e.target.value window.setTimeout( function() { var errors = self.el.find('.expression-preview-parsing-status'); var editFunc = costco.evalFunction(e.target.value); if (!editFunc.errorMessage) { errors.text('No syntax error.'); var docs = self.model.currentDocuments.map(function(doc) { return doc.toJSON(); }); var previewData = costco.previewTransform(docs, editFunc, self.state.currentColumn); util.render('editPreview', 'expression-preview-container', {rows: previewData}); } else { errors.text(editFunc.errorMessage); } }, 1, true); } }); })(jQuery, recline.View); /*jshint multistr:true */ 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: ' \
    \
    \ \
    \ \
    \ Results found {{docCount}} \
    \ \
    \
    \
    \
    \ \ \
    \ ', events: { 'click .menu-right a': 'onMenuClick' }, initialize: function(options) { var self = this; this.el = $(this.el); this.config = _.extend({ readOnly: false }, options.config); if (this.config.readOnly) { this.setReadOnly(); } // Hash of 'page' views (i.e. those for whole page) keyed by page name if (options.views) { this.pageViews = options.views; } else { this.pageViews = [{ id: 'grid', label: 'Grid', view: new my.DataGrid({ model: this.model }) }]; } // this must be called after pageViews are created this.render(); this.router = new Backbone.Router(); this.setupRouting(); this.model.bind('query:start', function() { my.notify('Loading data', {loader: true}); }); this.model.bind('query:done', function() { my.clearNotifications(); self.el.find('.doc-count').text(self.model.docCount || 'Unknown'); my.notify('Data loaded', {category: 'success'}); // update navigation var qs = my.parseHashQueryString(); qs.reclineQuery = JSON.stringify(self.model.queryState.toJSON()); var out = my.getNewHashForQueryString(qs); self.router.navigate(out); }); this.model.bind('query:fail', function(error) { my.clearNotifications(); 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 // note this.model and dataset returned are the same this.model.fetch() .done(function(dataset) { var queryState = my.parseHashQueryString().reclineQuery; if (queryState) { queryState = JSON.parse(queryState); } self.model.query(queryState); }) .fail(function(error) { my.notify(error.message, {category: 'error', persist: true}); }); }, setReadOnly: function() { this.el.addClass('read-only'); }, render: function() { var tmplData = this.model.toTemplateJSON(); tmplData.displayCount = this.config.displayCount; tmplData.views = this.pageViews; var template = $.mustache(this.template, tmplData); $(this.el).html(template); var $dataViewContainer = this.el.find('.data-view-container'); _.each(this.pageViews, function(view, pageName) { $dataViewContainer.append(view.view.el); }); var queryEditor = new my.QueryEditor({ model: this.model.queryState }); this.el.find('.query-editor-here').append(queryEditor.el); var filterEditor = new my.FilterEditor({ model: this.model.queryState }); this.$filterEditor = filterEditor.el; this.el.find('.header').append(filterEditor.el); var facetViewer = new my.FacetViewer({ model: this.model }); this.$facetViewer = facetViewer.el; this.el.find('.header').append(facetViewer.el); }, setupRouting: function() { var self = this; // Default route this.router.route(/^(\?.*)?$/, this.pageViews[0].id, function(queryString) { self.updateNav(self.pageViews[0].id, queryString); }); $.each(this.pageViews, function(idx, view) { self.router.route(/^([^?]+)(\?.*)?/, 'view', function(viewId, queryString) { self.updateNav(viewId, queryString); }); }); }, 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) { view.view.el.show(); view.view.trigger('view:show'); } else { view.view.el.hide(); view.view.trigger('view:hide'); } }); }, onMenuClick: function(e) { e.preventDefault(); var action = $(e.target).attr('data-action'); if (action === 'filters') { this.$filterEditor.show(); } else if (action === 'facets') { this.$facetViewer.show(); } } }); my.QueryEditor = Backbone.View.extend({ className: 'recline-query-editor', template: ' \
    \
    \ \ \
    \ \ \
    \ ', events: { 'submit form': 'onFormSubmit', 'click .action-pagination-update': 'onPaginationUpdate' }, initialize: function() { _.bindAll(this, 'render'); this.el = $(this.el); this.model.bind('change', this.render); this.render(); }, onFormSubmit: function(e) { e.preventDefault(); var query = this.el.find('.text-query input').val(); var newFrom = parseInt(this.el.find('input[name="from"]').val()); var newSize = parseInt(this.el.find('input[name="to"]').val()) - newFrom; this.model.set({size: newSize, from: newFrom, q: query}); }, onPaginationUpdate: function(e) { e.preventDefault(); var $el = $(e.target); var newFrom = 0; if ($el.parent().hasClass('prev')) { newFrom = this.model.get('from') - Math.max(0, this.model.get('size')); } else { newFrom = this.model.get('from') + this.model.get('size'); } this.model.set({from: newFrom}); }, render: function() { var tmplData = this.model.toJSON(); tmplData.to = this.model.get('from') + this.model.get('size'); var templated = $.mustache(this.template, tmplData); this.el.html(templated); } }); my.FilterEditor = Backbone.View.extend({ className: 'recline-filter-editor well', template: ' \ × \
    \
    \

    Filters

    \
    \
    \
    \
    \
    \ {{#termFilters}} \
    \ \
    \
    \ \ \
    \
    \
    \ {{/termFilters}} \
    \
    \

    To add a filter use the column menu in the grid view.

    \ \
    \ \
    \
    \ ', events: { 'click .js-hide': 'onHide', 'click .js-remove-filter': 'onRemoveFilter', 'submit form': 'onTermFiltersUpdate' }, initialize: function() { this.el = $(this.el); _.bindAll(this, 'render'); this.model.bind('change', this.render); this.model.bind('change:filters:new-blank', this.render); this.render(); }, render: function() { var tmplData = $.extend(true, {}, this.model.toJSON()); // we will use idx in list as there id ... tmplData.filters = _.map(tmplData.filters, function(filter, idx) { filter.id = idx; return filter; }); tmplData.termFilters = _.filter(tmplData.filters, function(filter) { return filter.term !== undefined; }); tmplData.termFilters = _.map(tmplData.termFilters, function(filter) { var fieldId = _.keys(filter.term)[0]; return { id: filter.id, fieldId: fieldId, label: fieldId, value: filter.term[fieldId] }; }); var out = $.mustache(this.template, tmplData); this.el.html(out); // are there actually any facets to show? if (this.model.get('filters').length > 0) { this.el.show(); } else { this.el.hide(); } }, onHide: function(e) { e.preventDefault(); this.el.hide(); }, onRemoveFilter: function(e) { e.preventDefault(); var $target = $(e.target); var filterId = $target.closest('.filter').attr('data-filter-id'); this.model.removeFilter(filterId); }, onTermFiltersUpdate: function(e) { var self = this; e.preventDefault(); var filters = self.model.get('filters'); var $form = $(e.target); _.each($form.find('input'), function(input) { var $input = $(input); var filterIndex = parseInt($input.attr('data-filter-id')); var value = $input.val(); var fieldId = $input.attr('data-filter-field'); filters[filterIndex].term[fieldId] = value; }); self.model.set({filters: filters}); self.model.trigger('change'); } }); my.FacetViewer = Backbone.View.extend({ className: 'recline-facet-viewer well', template: ' \ × \
    \
    \

    Facets

    \
    \ {{#facets}} \ \ {{/facets}} \
    \ ', events: { 'click .js-hide': 'onHide', 'click .js-facet-filter': 'onFacetFilter' }, initialize: function(model) { _.bindAll(this, 'render'); this.el = $(this.el); this.model.facets.bind('all', this.render); this.model.fields.bind('all', this.render); this.render(); }, render: function() { var tmplData = { facets: this.model.facets.toJSON(), fields: this.model.fields.toJSON() }; tmplData.facets = _.map(tmplData.facets, function(facet) { if (facet._type === 'date_histogram') { facet.entries = _.map(facet.entries, function(entry) { entry.term = new Date(entry.time).toDateString(); return entry; }); } return facet; }); var templated = $.mustache(this.template, tmplData); this.el.html(templated); // are there actually any facets to show? if (this.model.facets.length > 0) { this.el.show(); } else { this.el.hide(); } }, onHide: function(e) { e.preventDefault(); this.el.hide(); }, onFacetFilter: function(e) { var $target= $(e.target); var fieldId = $target.closest('.facet-summary').attr('data-facet'); var value = $target.attr('data-value'); this.model.queryState.addTermFilter(fieldId, value); } }); /* ========================================================== */ // ## Miscellaneous Utilities var urlPathRegex = /^([^?]+)(\?.*)?/; // Parse the Hash section of a URL into path and query string my.parseHashUrl = function(hashUrl) { var parsed = urlPathRegex.exec(hashUrl); if (parsed === null) { return {}; } else { return { path: parsed[1], query: parsed[2] || '' }; } }; // Parse a URL query string (?xyz=abc...) into a dictionary. my.parseQueryString = function(q) { if (!q) { return {}; } var urlParams = {}, e, d = function (s) { return unescape(s.replace(/\+/g, " ")); }, r = /([^&=]+)=?([^&]*)/g; if (q && q.length && q[0] === '?') { q = q.slice(1); } while (e = r.exec(q)) { // TODO: have values be array as query string allow repetition of keys urlParams[d(e[1])] = d(e[2]); } return urlParams; }; // Parse the query string out of the URL hash my.parseHashQueryString = function() { q = my.parseHashUrl(window.location.hash).query; return my.parseQueryString(q); }; // Compse a Query String my.composeQueryString = function(queryParams) { var queryString = '?'; var items = []; $.each(queryParams, function(key, value) { items.push(key + '=' + value); }); queryString += items.join('&'); return queryString; }; my.getNewHashForQueryString = function(queryParams) { var queryPart = my.composeQueryString(queryParams); if (window.location.hash) { // slice(1) to remove # at start return window.location.hash.split('?')[0].slice(1) + queryPart; } else { return queryPart; } }; my.setHashQueryString = function(queryParams) { window.location.hash = my.getNewHashForQueryString(queryParams); }; // ## notify // // Create a notification (a div.alert in div.alert-messsages) using provide messages and options. Options are: // // * category: warning (default), success, error // * persist: if true alert is persistent, o/w hidden after 3s (default = false) // * loader: if true show loading spinner my.notify = function(message, options) { if (!options) options = {}; var tmplData = _.extend({ msg: message, category: 'warning' }, options); var _template = ' \
    × \ {{msg}} \ {{#loader}} \   \ {{/loader}} \
    '; var _templated = $.mustache(_template, tmplData); _templated = $(_templated).appendTo($('.recline-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 = $('.recline-data-explorer .alert-messages .alert'); $notifications.remove(); }; })(jQuery, recline.View); // # Recline Backends // // Backends are connectors to backend data sources and stores // // This is just the base module containing a template Base class and convenience methods. this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; (function($, my) { // ## Backbone.sync // // Override Backbone.sync to hand off to sync function in relevant backend Backbone.sync = function(method, model, options) { return model.backend.sync(method, model, options); }; // ## recline.Backend.Base // // Base class for backends providing a template and convenience functions. // You do not have to inherit from this class but even when not it does provide guidance on the functions you must implement. // // Note also that while this (and other Backends) are implemented as Backbone models this is just a convenience. my.Base = Backbone.Model.extend({ // ### sync // // An implementation of Backbone.sync that will be used to override // Backbone.sync on operations for Datasets and Documents which are using this backend. // // For read-only implementations you will need only to implement read method // for Dataset models (and even this can be a null operation). The read method // should return relevant metadata for the Dataset. We do not require read support // for Documents because they are loaded in bulk by the query method. // // For backends supporting write operations you must implement update and delete support for Document objects. // // All code paths should return an object conforming to the jquery promise API. sync: function(method, model, options) { }, // ### query // // Query the backend for documents returning them in bulk. This method will // be used by the Dataset.query method to search the backend for documents, // retrieving the results in bulk. // // @param {recline.model.Dataset} model: Dataset model. // // @param {Object} queryObj: object describing a query (usually produced by // using recline.Model.Query and calling toJSON on it). // // The structure of data in the Query object or // Hash should follow that defined in issue 34. // (Of course, if you are writing your own backend, and hence // have control over the interpretation of the query object, you // can use whatever structure you like). // // @returns {Promise} promise API object. The promise resolve method will // be called on query completion with a QueryResult object. // // A QueryResult has the following structure (modelled closely on // ElasticSearch - see this issue for more // details): // //
        // {
        //   total: // (required) total number of results (can be null)
        //   hits: [ // (required) one entry for each result document
        //     {
        //        _score:   // (optional) match score for document
        //        _type: // (optional) document type
        //        _source: // (required) document/row object
        //     } 
        //   ],
        //   facets: { // (optional) 
        //     // facet results (as per )
        //   }
        // }
        // 
    query: function(model, queryObj) { }, // convenience method to convert simple set of documents / rows to a QueryResult _docsToQueryResult: function(rows) { var hits = _.map(rows, function(row) { return { _source: row }; }); return { total: null, hits: hits }; }, // ## _wrapInTimeout // // Convenience method providing a crude way to catch backend errors on JSONP calls. // Many of backends use JSONP and so will not get error messages and this is // a crude way to catch those errors. _wrapInTimeout: function(ourFunction) { var dfd = $.Deferred(); var timeout = 5000; var timer = setTimeout(function() { dfd.reject({ message: 'Request Error: Backend did not respond after ' + (timeout / 1000) + ' seconds' }); }, timeout); ourFunction.done(function(arguments) { clearTimeout(timer); dfd.resolve(arguments); }) .fail(function(arguments) { clearTimeout(timer); dfd.reject(arguments); }) ; return dfd.promise(); } }); }(jQuery, this.recline.Backend)); this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; (function($, my) { // ## DataProxy Backend // // For connecting to [DataProxy-s](http://github.com/okfn/dataproxy). // // When initializing the DataProxy backend you can set the following attributes: // // * dataproxy: {url-to-proxy} (optional). Defaults to http://jsonpdataproxy.appspot.com // // Datasets using using this backend should set the following attributes: // // * url: (required) url-of-data-to-proxy // * format: (optional) csv | xls (defaults to csv if not specified) // // Note that this is a **read-only** backend. my.DataProxy = my.Base.extend({ defaults: { dataproxy_url: 'http://jsonpdataproxy.appspot.com' }, sync: function(method, model, options) { var self = this; if (method === "read") { if (model.__type__ == 'Dataset') { // Do nothing as we will get fields in query step (and no metadata to // retrieve) var dfd = $.Deferred(); dfd.resolve(model); return dfd.promise(); } } else { alert('This backend only supports read operations'); } }, query: function(dataset, queryObj) { var self = this; var base = this.get('dataproxy_url'); var data = { url: dataset.get('url'), 'max-results': queryObj.size, type: dataset.get('format') }; var jqxhr = $.ajax({ url: base, data: data, dataType: 'jsonp' }); var dfd = $.Deferred(); this._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) { tmp[key] = doc[idx]; }); return tmp; }); dfd.resolve(self._docsToQueryResult(_out)); }) .fail(function(arguments) { dfd.reject(arguments); }); return dfd.promise(); } }); recline.Model.backends['dataproxy'] = new my.DataProxy(); }(jQuery, this.recline.Backend)); this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; (function($, my) { // ## ElasticSearch Backend // // Connecting to [ElasticSearch](http://www.elasticsearch.org/). // // 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 = my.Base.extend({ _getESUrl: function(dataset) { var out = dataset.get('elasticsearch_url'); if (out) return out; out = dataset.get('webstore_url'); if (out) return out; out = dataset.get('url'); return out; }, sync: function(method, model, options) { var self = this; if (method === "read") { if (model.__type__ == 'Dataset') { var base = self._getESUrl(model); var schemaUrl = base + '/_mapping'; var jqxhr = $.ajax({ url: schemaUrl, dataType: 'jsonp' }); var dfd = $.Deferred(); this._wrapInTimeout(jqxhr).done(function(schema) { // only one top level key in ES = the type so we can ignore it var key = _.keys(schema)[0]; var fieldData = _.map(schema[key].properties, function(dict, fieldName) { dict.id = fieldName; return dict; }); model.fields.reset(fieldData); dfd.resolve(model, jqxhr); }) .fail(function(arguments) { dfd.reject(arguments); }); return dfd.promise(); } } else { alert('This backend currently only supports read operations'); } }, _normalizeQuery: function(queryObj) { var out = queryObj.toJSON ? queryObj.toJSON() : _.extend({}, queryObj); if (out.q !== undefined && out.q.trim() === '') { delete out.q; } if (!out.q) { out.query = { match_all: {} }; } else { out.query = { query_string: { query: out.q } }; delete out.q; } // now do filters (note the *plural*) if (out.filters && out.filters.length) { if (!out.filter) { out.filter = {}; } if (!out.filter.and) { out.filter.and = []; } out.filter.and = out.filter.and.concat(out.filters); } if (out.filters !== undefined) { delete out.filters; } return out; }, query: function(model, queryObj) { var queryNormalized = this._normalizeQuery(queryObj); var data = {source: JSON.stringify(queryNormalized)}; var base = this._getESUrl(model); var jqxhr = $.ajax({ url: base + '/_search', data: data, dataType: 'jsonp' }); var dfd = $.Deferred(); // TODO: fail case jqxhr.done(function(results) { _.each(results.hits.hits, function(hit) { if (!('id' in hit._source) && hit._id) { hit._source.id = hit._id; } }); if (results.facets) { results.hits.facets = results.facets; } dfd.resolve(results.hits); }); return dfd.promise(); } }); recline.Model.backends['elasticsearch'] = new my.ElasticSearch(); }(jQuery, this.recline.Backend)); this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; (function($, my) { // ## Google spreadsheet backend // // Connect to Google Docs spreadsheet. // // Dataset must have a url attribute pointing to the Gdocs // spreadsheet's JSON feed e.g. // //
      // var dataset = new recline.Model.Dataset({
      //     url: 'https://spreadsheets.google.com/feeds/list/0Aon3JiuouxLUdDQwZE1JdV94cUd6NWtuZ0IyWTBjLWc/od6/public/values?alt=json'
      //   },
      //   'gdocs'
      // );
      // 
    my.GDoc = my.Base.extend({ getUrl: function(dataset) { var url = dataset.get('url'); if (url.indexOf('feeds/list') != -1) { return url; } else { // https://docs.google.com/spreadsheet/ccc?key=XXXX#gid=0 var regex = /.*spreadsheet\/ccc?.*key=([^#?&+]+).*/; var matches = url.match(regex); if (matches) { var key = matches[1]; var worksheet = 1; var out = 'https://spreadsheets.google.com/feeds/list/' + key + '/' + worksheet + '/public/values?alt=json'; return out; } else { alert('Failed to extract gdocs key from ' + url); } } }, sync: function(method, model, options) { var self = this; if (method === "read") { var dfd = $.Deferred(); var dataset = model; var url = this.getUrl(model); $.getJSON(url, function(d) { result = self.gdocsToJavascript(d); model.fields.reset(_.map(result.field, function(fieldId) { return {id: fieldId}; }) ); // cache data onto dataset (we have loaded whole gdoc it seems!) model._dataCache = result.data; dfd.resolve(model); }); return dfd.promise(); } }, query: function(dataset, queryObj) { var dfd = $.Deferred(); var fields = _.pluck(dataset.fields.toJSON(), 'id'); // zip the fields with the data rows to produce js objs // TODO: factor this out as a common method with other backends var objs = _.map(dataset._dataCache, function (d) { var obj = {}; _.each(_.zip(fields, d), function (x) { obj[x[0]] = x[1]; }); return obj; }); dfd.resolve(this._docsToQueryResult(objs)); return dfd; }, gdocsToJavascript: function(gdocsSpreadsheet) { /* :options: (optional) optional argument dictionary: columnsToUse: list of columns to use (specified by field names) colTypes: dictionary (with column names as keys) specifying types (e.g. range, percent for use in conversion). :return: tabular data object (hash with keys: field and data). Issues: seems google docs return columns in rows in random order and not even sure whether consistent across rows. */ var options = {}; if (arguments.length > 1) { options = arguments[1]; } var results = { 'field': [], 'data': [] }; // default is no special info on type of columns var colTypes = {}; if (options.colTypes) { colTypes = options.colTypes; } // either extract column headings from spreadsheet directly, or used supplied ones if (options.columnsToUse) { // columns set to subset supplied results.field = options.columnsToUse; } else { // set columns to use to be all available if (gdocsSpreadsheet.feed.entry.length > 0) { for (var k in gdocsSpreadsheet.feed.entry[0]) { if (k.substr(0, 3) == 'gsx') { var col = k.substr(4); results.field.push(col); } } } } // converts non numberical values that should be numerical (22.3%[string] -> 0.223[float]) var rep = /^([\d\.\-]+)\%$/; $.each(gdocsSpreadsheet.feed.entry, function (i, entry) { var row = []; for (var k in results.field) { var col = results.field[k]; var _keyname = 'gsx$' + col; var value = entry[_keyname]['$t']; // if labelled as % and value contains %, convert if (colTypes[col] == 'percent') { if (rep.test(value)) { var value2 = rep.exec(value); var value3 = parseFloat(value2); value = value3 / 100; } } row.push(value); } results.data.push(row); }); return results; } }); recline.Model.backends['gdocs'] = new my.GDoc(); }(jQuery, this.recline.Backend)); this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; (function($, my) { my.loadFromCSVFile = function(file, callback) { var metadata = { id: file.name, file: file }; var reader = new FileReader(); // TODO reader.onload = function(e) { var dataset = my.csvToDataset(e.target.result); callback(dataset); }; reader.onerror = function (e) { alert('Failed to load file. Code: ' + e.target.error.code); }; reader.readAsText(file); }; my.csvToDataset = function(csvString) { var out = my.parseCSV(csvString); fields = _.map(out[0], function(cell) { return { id: cell, label: cell }; }); var data = _.map(out.slice(1), function(row) { var _doc = {}; _.each(out[0], function(fieldId, idx) { _doc[fieldId] = row[idx]; }); return _doc; }); var dataset = recline.Backend.createDataset(data, fields); return dataset; }; // Converts a Comma Separated Values string into an array of arrays. // Each line in the CSV becomes an array. // // Empty fields are converted to nulls and non-quoted numbers are converted to integers or floats. // // @return The CSV parsed as an array // @type Array // // @param {String} s The string to convert // @param {Boolean} [trm=false] If set to True leading and trailing whitespace is stripped off of each non-quoted field as it is imported // // Heavily based on uselesscode's JS CSV parser (MIT Licensed): // thttp://www.uselesscode.org/javascript/csv/ my.parseCSV= function(s, trm) { // Get rid of any trailing \n s = chomp(s); var cur = '', // The character we are currently processing. inQuote = false, fieldQuoted = false, field = '', // Buffer for building up the current field row = [], out = [], i, processField; processField = function (field) { if (fieldQuoted !== true) { // If field is empty set to null if (field === '') { field = null; // If the field was not quoted and we are trimming fields, trim it } else if (trm === true) { field = trim(field); } // Convert unquoted numbers to their appropriate types if (rxIsInt.test(field)) { field = parseInt(field, 10); } else if (rxIsFloat.test(field)) { field = parseFloat(field, 10); } } return field; }; for (i = 0; i < s.length; i += 1) { cur = s.charAt(i); // If we are at a EOF or EOR if (inQuote === false && (cur === ',' || cur === "\n")) { field = processField(field); // Add the current field to the current row row.push(field); // If this is EOR append row to output and flush row if (cur === "\n") { out.push(row); row = []; } // Flush the field buffer field = ''; fieldQuoted = false; } else { // If it's not a ", add it to the field buffer if (cur !== '"') { field += cur; } else { if (!inQuote) { // We are not in a quote, start a quote inQuote = true; fieldQuoted = true; } else { // Next char is ", this is an escaped " if (s.charAt(i + 1) === '"') { field += '"'; // Skip the next char i += 1; } else { // It's not escaping, so end quote inQuote = false; } } } } } // Add the last field field = processField(field); row.push(field); out.push(row); return out; }; var rxIsInt = /^\d+$/, rxIsFloat = /^\d*\.\d+$|^\d+\.\d*$/, // If a string has leading or trailing space, // contains a comma double quote or a newline // it needs to be quoted in CSV output rxNeedsQuoting = /^\s|\s$|,|"|\n/, trim = (function () { // Fx 3.1 has a native trim function, it's about 10x faster, use it if it exists if (String.prototype.trim) { return function (s) { return s.trim(); }; } else { return function (s) { return s.replace(/^\s*/, '').replace(/\s*$/, ''); }; } }()); function chomp(s) { if (s.charAt(s.length - 1) !== "\n") { // Does not end with \n, just return string return s; } else { // Remove the \n return s.substring(0, s.length - 1); } } }(jQuery, this.recline.Backend)); this.recline = this.recline || {}; this.recline.Backend = this.recline.Backend || {}; (function($, my) { // ## createDataset // // Convenience function to create a simple 'in-memory' dataset in one step. // // @param data: list of hashes for each document/row in the data ({key: // value, key: value}) // @param fields: (optional) list of field hashes (each hash defining a hash // as per recline.Model.Field). If fields not specified they will be taken // from the data. // @param metadata: (optional) dataset metadata - see recline.Model.Dataset. // If not defined (or id not provided) id will be autogenerated. my.createDataset = function(data, fields, metadata) { if (!metadata) { metadata = {}; } if (!metadata.id) { metadata.id = String(Math.floor(Math.random() * 100000000) + 1); } var backend = recline.Model.backends['memory']; var datasetInfo = { documents: data, metadata: metadata }; if (fields) { datasetInfo.fields = fields; } else { if (data) { datasetInfo.fields = _.map(data[0], function(value, key) { return {id: key}; }); } } backend.addDataset(datasetInfo); var dataset = new recline.Model.Dataset({id: metadata.id}, 'memory'); dataset.fetch(); return dataset; }; // ## Memory Backend - uses in-memory data // // 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: // //
      //  // Backend setup
      //  var backend = recline.Backend.Memory();
      //  backend.addDataset({
      //    metadata: {
      //      id: 'my-id',
      //      title: 'My Title'
      //    },
      //    fields: [{id: 'x'}, {id: 'y'}, {id: 'z'}],
      //    documents: [
      //        {id: 0, x: 1, y: 2, z: 3},
      //        {id: 1, x: 2, y: 4, z: 6}
      //      ]
      //  });
      //  // later ...
      //  var dataset = Dataset({id: 'my-id'}, 'memory');
      //  dataset.fetch();
      //  etc ...
      //  
    my.Memory = my.Base.extend({ initialize: function() { this.datasets = {}; }, addDataset: function(data) { this.datasets[data.metadata.id] = $.extend(true, {}, data); }, sync: function(method, model, options) { var self = this; var dfd = $.Deferred(); if (method === "read") { if (model.__type__ == 'Dataset') { var rawDataset = this.datasets[model.id]; model.set(rawDataset.metadata); model.fields.reset(rawDataset.fields); model.docCount = rawDataset.documents.length; dfd.resolve(model); } return dfd.promise(); } else if (method === 'update') { if (model.__type__ == 'Document') { _.each(self.datasets[model.dataset.id].documents, function(doc, idx) { if(doc.id === model.id) { self.datasets[model.dataset.id].documents[idx] = model.toJSON(); } }); dfd.resolve(model); } return dfd.promise(); } else if (method === 'delete') { if (model.__type__ == 'Document') { var rawDataset = self.datasets[model.dataset.id]; var newdocs = _.reject(rawDataset.documents, function(doc) { return (doc.id === model.id); }); rawDataset.documents = newdocs; dfd.resolve(model); } return dfd.promise(); } else { alert('Not supported: sync on Memory backend with method ' + method + ' and model ' + model); } }, query: function(model, queryObj) { var dfd = $.Deferred(); var out = {}; var numRows = queryObj.size; var start = queryObj.from; results = this.datasets[model.id].documents; _.each(queryObj.filters, function(filter) { results = _.filter(results, function(doc) { var fieldId = _.keys(filter.term)[0]; return (doc[fieldId] == filter.term[fieldId]); }); }); // not complete sorting! _.each(queryObj.sort, function(sortObj) { var fieldName = _.keys(sortObj)[0]; results = _.sortBy(results, function(doc) { var _out = doc[fieldName]; return (sortObj[fieldName].order == 'asc') ? _out : -1*_out; }); }); out.facets = this._computeFacets(results, queryObj); var total = results.length; resultsObj = this._docsToQueryResult(results.slice(start, start+numRows)); _.extend(out, resultsObj); out.total = total; dfd.resolve(out); return dfd.promise(); }, _computeFacets: function(documents, queryObj) { var facetResults = {}; if (!queryObj.facets) { return facetsResults; } _.each(queryObj.facets, function(query, facetId) { facetResults[facetId] = new recline.Model.Facet({id: facetId}).toJSON(); facetResults[facetId].termsall = {}; }); // faceting _.each(documents, function(doc) { _.each(queryObj.facets, function(query, facetId) { var fieldId = query.terms.field; var val = doc[fieldId]; var tmp = facetResults[facetId]; if (val) { tmp.termsall[val] = tmp.termsall[val] ? tmp.termsall[val] + 1 : 1; } else { tmp.missing = tmp.missing + 1; } }); }); _.each(queryObj.facets, function(query, facetId) { var tmp = facetResults[facetId]; var terms = _.map(tmp.termsall, function(count, term) { return { term: term, count: count }; }); tmp.terms = _.sortBy(terms, function(item) { // want descending order return -item.count; }); tmp.terms = tmp.terms.slice(0, 10); }); return facetResults; } }); recline.Model.backends['memory'] = new my.Memory(); }(jQuery, this.recline.Backend));