[#129,refactor][l]: ([s] in effort) rename Document to Record - fixes #129.

library.html

@@ -13,7 +13,7 @@ title: Library - Home
 
   <p>Building on <a href="http://backbonejs.com/">Backbone</a>, Recline
   supplies components and structure to data-heavy applications by providing a
-  set of models (Dataset, Document/Row, Field) and views (Grid, Map, Graph
+  set of models (Dataset, Record/Row, Field) and views (Grid, Map, Graph
   etc).</p>
 
   <h2 id="examples">Examples</h2>
@@ -52,7 +52,7 @@ title: Library - Home
       <h4>Create a new Backend</h4>
     </div>
     <div class="span3 well">
-      <h4>Create a Custom Document Object</h4>
+      <h4>Create a Custom Record Object</h4>
     </div>
   </div>
 
@@ -70,10 +70,10 @@ title: Library - Home
         <p>There are two main model objects:</p>
         <ul>
           <li><a href="docs/model.html#dataset">Dataset</a>: represents the dataset.
-          Holds dataset info and a pointer to list of data items (Documents in our
+          Holds dataset info and a pointer to list of data items (Records in our
           terminology) which it can load from the relevant Backend.</li>
-          <li><a href="docs/model.html#document">Document</a>: an individual data item
+          <li><a href="docs/model.html#record">Record</a>: an individual data item
-          (e.g. a row from a relational database or a spreadsheet, a document from from
+          (e.g. a row from a relational database or a spreadsheet, a record from from
           a document DB like CouchDB or MongoDB).</li>
         </ul>
         
@@ -84,7 +84,7 @@ title: Library - Home
           <li><a href="docs/model.html#query">Query</a>: an object to encapsulate a
           query to the backend (useful both for creating queries and for storing and
           manipulating query state - e.g. from a query editor).</li>
-          <li><a href="docs/model.html#facte">Facet</a>: Object to store Facet
+          <li><a href="docs/model.html#facet">Facet</a>: 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.</li>
         </ul>
@@ -97,13 +97,13 @@ title: Library - Home
 
       <div class="span6">
         <h4>Backends</h4>
-        <p>Backends connect Dataset and Documents to data from a
+        <p>Backends connect Dataset and Records to data from a
         specific 'Backend' data source. They provide methods for loading and saving
-        Datasets and individuals Documents as well as for bulk loading via a query API
+        Datasets and individuals Records as well as for bulk loading via a query API
         and doing bulk transforms on the backend.</p>
         
         <p>A template Base class can be found <a href="docs/backend/base.html">in the
-          Backend base module of the source docs</a>. It documents both the relevant
+          Backend base module of the source docs</a>. It records both the relevant
         methods a Backend must have and (optionally) provides a base 'class' for
         inheritance. You can also find detailed examples of backend implementations in
         the source documentation below.</p>

src/backend/base.js

@@ -29,14 +29,14 @@ this.recline.Backend.Base = function() {
   // ### 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.
+  // Backbone.sync on operations for Datasets and Records 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 Records 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.
+  // For backends supporting write operations you must implement update and delete support for Record objects.
   //
   // All code paths should return an object conforming to the jquery promise API.
   this.sync = function(method, model, options) {
@@ -44,8 +44,8 @@ this.recline.Backend.Base = function() {
   
   // ### query
   //
-  // Query the backend for documents returning them in bulk. This method will
+  // Query the backend for records returning them in bulk. This method will
-  // be used by the Dataset.query method to search the backend for documents,
+  // be used by the Dataset.query method to search the backend for records,
   // retrieving the results in bulk.
   //
   // @param {recline.model.Dataset} model: Dataset model.
@@ -71,11 +71,11 @@ this.recline.Backend.Base = function() {
   // <pre>
   // {
   //   total: // (required) total number of results (can be null)
-  //   hits: [ // (required) one entry for each result document
+  //   hits: [ // (required) one entry for each result record
   //     {
-  //        _score:   // (optional) match score for document
+  //        _score:   // (optional) match score for record
-  //        _type: // (optional) document type
+  //        _type: // (optional) record type
-  //        _source: // (required) document/row object
+  //        _source: // (required) record/row object
   //     } 
   //   ],
   //   facets: { // (optional) 

src/backend/elasticsearch.js

@@ -39,7 +39,7 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
 
     // ### get
     //
-    // Get document corresponding to specified id
+    // Get record corresponding to specified id
     //
     // @return promise compatible deferred object.
     this.get = function(id) {
@@ -52,7 +52,7 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
 
     // ### upsert
     //
-    // create / update a document to ElasticSearch backend
+    // create / update a record to ElasticSearch backend
     //
     // @param {Object} doc an object to insert to the index.
     // @return deferred supporting promise API
@@ -72,7 +72,7 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
 
     // ### delete
     //
-    // Delete a document from the ElasticSearch backend.
+    // Delete a record from the ElasticSearch backend.
     //
     // @param {Object} id id of object to delete
     // @return deferred supporting promise API
@@ -154,7 +154,7 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
     // Backbone sync implementation for this backend.
     //
     // URL of ElasticSearch endpoint to use must be specified on the dataset
-    // (and on a Document via its dataset attribute) by the dataset having a
+    // (and on a Record via its dataset attribute) by the dataset having a
     // url attribute.
     this.sync = function(method, model, options) {
       if (model.__type__ == 'Dataset') {
@@ -180,15 +180,15 @@ this.recline.Backend.ElasticSearch = this.recline.Backend.ElasticSearch || {};
             dfd.reject(arguments);
           });
           return dfd.promise();
-        } else if (model.__type__ == 'Document') {
+        } else if (model.__type__ == 'Record') {
           return es.get(model.dataset.id);
         }
       } else if (method === 'update') {
-        if (model.__type__ == 'Document') {
+        if (model.__type__ == 'Record') {
           return es.upsert(model.toJSON());
         }
       } else if (method === 'delete') {
-        if (model.__type__ == 'Document') {
+        if (model.__type__ == 'Record') {
           return es.delete(model.id);
         }
       }

src/backend/memory.js

@@ -7,7 +7,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
   //
   // 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:
+  // @param data: list of hashes for each record/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
@@ -76,7 +76,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
       results = results.slice(start, start+numRows);
       return {
         total: total,
-        documents: results,
+        records: results,
         facets: facets
       };
     };
@@ -118,7 +118,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
       return results;
     };
 
-    this.computeFacets = function(documents, queryObj) {
+    this.computeFacets = function(records, queryObj) {
       var facetResults = {};
       if (!queryObj.facets) {
         return facetResults;
@@ -129,7 +129,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
         facetResults[facetId].termsall = {};
       });
       // faceting
-      _.each(documents, function(doc) {
+      _.each(records, function(doc) {
         _.each(queryObj.facets, function(query, facetId) {
           var fieldId = query.terms.field;
           var val = doc[fieldId];
@@ -172,13 +172,13 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
         }
         return dfd.promise();
       } else if (method === 'update') {
-        if (model.__type__ == 'Document') {
+        if (model.__type__ == 'Record') {
           model.dataset._dataCache.update(model.toJSON());
           dfd.resolve(model);
         }
         return dfd.promise();
       } else if (method === 'delete') {
-        if (model.__type__ == 'Document') {
+        if (model.__type__ == 'Record') {
           model.dataset._dataCache.delete(model.toJSON());
           dfd.resolve(model);
         }
@@ -191,7 +191,7 @@ this.recline.Backend.Memory = this.recline.Backend.Memory || {};
     this.query = function(model, queryObj) {
       var dfd = $.Deferred();
       var results = model._dataCache.query(queryObj);
-      var hits = _.map(results.documents, function(row) {
+      var hits = _.map(results.records, function(row) {
         return { _source: row };
       });
       var out = {

src/model.js

@@ -12,11 +12,11 @@ this.recline.Model = this.recline.Model || {};
 // 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
+// @property {RecordList} currentRecords: a `RecordList` containing the
-// Documents we have currently loaded for viewing (updated by calling query
+// Records we have currently loaded for viewing (updated by calling query
 // method)
 //
-// @property {number} docCount: total number of documents in this dataset
+// @property {number} docCount: total number of records in this dataset
 //
 // @property {Backend} backend: the Backend (instance) for this Dataset.
 //
@@ -48,7 +48,7 @@ my.Dataset = Backbone.Model.extend({
       this.backend = this._backendFromString(backend);
     }
     this.fields = new my.FieldList();
-    this.currentDocuments = new my.DocumentList();
+    this.currentRecords = new my.RecordList();
     this.facets = new my.FacetList();
     this.docCount = null;
     this.queryState = new my.Query();
@@ -58,12 +58,12 @@ my.Dataset = Backbone.Model.extend({
 
   // ### query
   //
-  // AJAX method with promise API to get documents from the backend.
+  // AJAX method with promise API to get records 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
+  // Resulting RecordList are used to reset this.currentRecords and are
   // also returned.
   query: function(queryObj) {
     var self = this;
@@ -73,12 +73,12 @@ my.Dataset = Backbone.Model.extend({
     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);
+        var _doc = new my.Record(hit._source);
         _doc.backend = self.backend;
         _doc.dataset = self;
         return _doc;
       });
-      self.currentDocuments.reset(docs);
+      self.currentRecords.reset(docs);
       if (queryResult.facets) {
         var facets = _.map(queryResult.facets, function(facetResult, facetId) {
           facetResult.id = facetId;
@@ -87,7 +87,7 @@ my.Dataset = Backbone.Model.extend({
         self.facets.reset(facets);
       }
       self.trigger('query:done');
-      dfd.resolve(self.currentDocuments);
+      dfd.resolve(self.currentRecords);
     })
     .fail(function(arguments) {
       self.trigger('query:fail', arguments);
@@ -176,11 +176,11 @@ my.Dataset.restore = function(state) {
   return dataset;
 };
 
-// ## <a id="document">A Document (aka Row)</a>
+// ## <a id="record">A Record (aka Row)</a>
 // 
 // A single entry or row in the dataset
-my.Document = Backbone.Model.extend({
+my.Record = Backbone.Model.extend({
-  __type__: 'Document',
+  __type__: 'Record',
   initialize: function() {
     _.bindAll(this, 'getFieldValue');
   },
@@ -188,7 +188,7 @@ my.Document = Backbone.Model.extend({
   // ### getFieldValue
   //
   // For the provided Field get the corresponding rendered computed data value
-  // for this document.
+  // for this record.
   getFieldValue: function(field) {
     var val = this.get(field.id);
     if (field.deriver) {
@@ -211,17 +211,17 @@ my.Document = Backbone.Model.extend({
   }
 });
 
-// ## A Backbone collection of Documents
+// ## A Backbone collection of Records
-my.DocumentList = Backbone.Collection.extend({
+my.RecordList = Backbone.Collection.extend({
-  __type__: 'DocumentList',
+  __type__: 'RecordList',
-  model: my.Document
+  model: my.Record
 });
 
 // ## <a id="field">A Field (aka Column) on a Dataset</a>
 // 
 // Following (Backbone) attributes as standard:
 //
-// * id: a unique identifer for this field- usually this should match the key in the documents hash
+// * id: a unique identifer for this field- usually this should match the key in the records 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 <http://www.elasticsearch.org/guide/reference/mapping/>
 // * format: (optional) used to indicate how the data should be formatted. For example:
@@ -234,13 +234,13 @@ my.DocumentList = Backbone.Collection.extend({
 // 
 // @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
+// cell, field is corresponding field object and record is the record
 // 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
+// record, 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
@@ -461,7 +461,7 @@ my.Query = Backbone.Model.extend({
 //   "_type" : "terms",
 //   // total number of tokens in the facet
 //   "total": 5,
-//   // @property {number} number of documents which have no value for the field
+//   // @property {number} number of records which have no value for the field
 //   "missing" : 0,
 //   // number of facet values not included in the returned facets
 //   "other": 0,

src/view-graph.js

@@ -97,8 +97,8 @@ my.Graph = Backbone.View.extend({
     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.currentRecords.bind('add', this.redraw);
-    this.model.currentDocuments.bind('reset', this.redraw);
+    this.model.currentRecords.bind('reset', this.redraw);
     // because we cannot redraw when hidden we may need when becoming visible
     this.bind('view:show', function() {
       if (this.needToRedraw) {
@@ -181,7 +181,7 @@ my.Graph = Backbone.View.extend({
     //   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)) {
+    if ((!areWeVisible || this.model.currentRecords.length === 0)) {
       this.needToRedraw = true;
       return;
     }
@@ -209,8 +209,8 @@ my.Graph = Backbone.View.extend({
     // 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 tickFormatter = function (val) {
-      if (self.model.currentDocuments.models[val]) {
+      if (self.model.currentRecords.models[val]) {
-        var out = self.model.currentDocuments.models[val].get(self.state.attributes.group);
+        var out = self.model.currentRecords.models[val].get(self.state.attributes.group);
         // if the value was in fact a number we want that not the 
         if (typeof(out) == 'number') {
           return val;
@@ -266,7 +266,7 @@ my.Graph = Backbone.View.extend({
           tickLength: 1,
           tickFormatter: tickFormatter,
           min: -0.5,
-          max: self.model.currentDocuments.length - 0.5
+          max: self.model.currentRecords.length - 0.5
         }
       }
     };
@@ -304,8 +304,8 @@ my.Graph = Backbone.View.extend({
             y = _tmp;
           }
           // convert back from 'index' value on x-axis (e.g. in cases where non-number values)
-          if (self.model.currentDocuments.models[x]) {
+          if (self.model.currentRecords.models[x]) {
-            x = self.model.currentDocuments.models[x].get(self.state.attributes.group);
+            x = self.model.currentRecords.models[x].get(self.state.attributes.group);
           } else {
             x = x.toFixed(2);
           }
@@ -339,7 +339,7 @@ my.Graph = Backbone.View.extend({
     var series = [];
     _.each(this.state.attributes.series, function(field) {
       var points = [];
-      _.each(self.model.currentDocuments.models, function(doc, index) {
+      _.each(self.model.currentRecords.models, function(doc, index) {
         var xfield = self.model.fields.get(self.state.attributes.group);
         var x = doc.getFieldValue(xfield);
         // time series

src/view-grid.js

@@ -17,9 +17,9 @@ my.Grid = Backbone.View.extend({
     var self = this;
     this.el = $(this.el);
     _.bindAll(this, 'render', 'onHorizontalScroll');
-    this.model.currentDocuments.bind('add', this.render);
+    this.model.currentRecords.bind('add', this.render);
-    this.model.currentDocuments.bind('reset', this.render);
+    this.model.currentRecords.bind('reset', this.render);
-    this.model.currentDocuments.bind('remove', this.render);
+    this.model.currentRecords.bind('remove', this.render);
     this.tempState = {};
     var state = _.extend({
         hiddenFields: []
@@ -77,13 +77,13 @@ my.Grid = Backbone.View.extend({
       showColumn: function() { self.showColumn(e); },
       deleteRow: function() {
         var self = this;
-        var doc = _.find(self.model.currentDocuments.models, function(doc) {
+        var doc = _.find(self.model.currentRecords.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.tempState.currentRow;
         });
         doc.destroy().then(function() { 
-            self.model.currentDocuments.remove(doc);
+            self.model.currentRecords.remove(doc);
             self.trigger('recline:flash', {message: "Row deleted successfully"});
           }).fail(function(err) {
             self.trigger('recline:flash', {message: "Errorz! " + err});
@@ -213,7 +213,7 @@ my.Grid = Backbone.View.extend({
     });
     var htmls = Mustache.render(this.template, this.toTemplateJSON());
     this.el.html(htmls);
-    this.model.currentDocuments.forEach(function(doc) {
+    this.model.currentRecords.forEach(function(doc) {
       var tr = $('<tr />');
       self.el.find('tbody').append(tr);
       var newView = new my.GridRow({
@@ -246,7 +246,7 @@ my.Grid = Backbone.View.extend({
   }
 });
 
-// ## GridRow View for rendering an individual document.
+// ## GridRow View for rendering an individual record.
 //
 // Since we want this to update in place it is up to creator to provider the element to attach to.
 //
@@ -256,7 +256,7 @@ my.Grid = Backbone.View.extend({
 //
 // <pre>
 // var row = new GridRow({
-//   model: dataset-document,
+//   model: dataset-record,
 //     el: dom-element,
 //     fields: mydatasets.fields // a FieldList object
 //   });

src/view-map.js

@@ -7,7 +7,7 @@ this.recline.View = this.recline.View || {};
 
 // ## Map view for a Dataset using Leaflet mapping library.
 //
-// This view allows to plot gereferenced documents on a map. The location
+// This view allows to plot gereferenced records 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.
@@ -115,14 +115,14 @@ my.Map = Backbone.View.extend({
       self.render()
     });
 
-    // Listen to changes in the documents
+    // Listen to changes in the records
-    this.model.currentDocuments.bind('add', function(doc){self.redraw('add',doc)});
+    this.model.currentRecords.bind('add', function(doc){self.redraw('add',doc)});
-    this.model.currentDocuments.bind('change', function(doc){
+    this.model.currentRecords.bind('change', function(doc){
         self.redraw('remove',doc);
         self.redraw('add',doc);
     });
-    this.model.currentDocuments.bind('remove', function(doc){self.redraw('remove',doc)});
+    this.model.currentRecords.bind('remove', function(doc){self.redraw('remove',doc)});
-    this.model.currentDocuments.bind('reset', function(){self.redraw('reset')});
+    this.model.currentRecords.bind('reset', function(){self.redraw('reset')});
 
     this.bind('view:show',function(){
       // If the div was hidden, Leaflet needs to recalculate some sizes
@@ -184,9 +184,9 @@ my.Map = Backbone.View.extend({
   // Actions can be:
   //
   // * reset: Clear all features
-  // * add: Add one or n features (documents)
+  // * add: Add one or n features (records)
-  // * remove: Remove one or n features (documents)
+  // * remove: Remove one or n features (records)
-  // * refresh: Clear existing features and add all current documents
+  // * refresh: Clear existing features and add all current records
   redraw: function(action, doc){
     var self = this;
     action = action || 'refresh';
@@ -201,7 +201,7 @@ my.Map = Backbone.View.extend({
     if (this.geomReady && this.mapReady){
       if (action == 'reset' || action == 'refresh'){
         this.features.clearLayers();
-        this._add(this.model.currentDocuments.models);
+        this._add(this.model.currentRecords.models);
       } else if (action == 'add' && doc){
         this._add(doc);
       } else if (action == 'remove' && doc){
@@ -266,11 +266,11 @@ my.Map = Backbone.View.extend({
 
   // Private: Add one or n features to the map
   //
-  // For each document passed, a GeoJSON geometry will be extracted and added
+  // For each record 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.
+  // Each feature will have a popup associated with all the record fields.
   //
   _add: function(docs){
     var self = this;
@@ -281,7 +281,7 @@ my.Map = Backbone.View.extend({
     var wrongSoFar = 0;
     _.every(docs,function(doc){
       count += 1;
-      var feature = self._getGeometryFromDocument(doc);
+      var feature = self._getGeometryFromRecord(doc);
       if (typeof feature === 'undefined' || feature === null){
         // Empty field
         return true;
@@ -338,9 +338,9 @@ my.Map = Backbone.View.extend({
 
   },
 
-  // Private: Return a GeoJSON geomtry extracted from the document fields
+  // Private: Return a GeoJSON geomtry extracted from the record fields
   //
-  _getGeometryFromDocument: function(doc){
+  _getGeometryFromRecord: function(doc){
     if (this.geomReady){
       if (this.state.get('geomField')){
         var value = doc.get(this.state.get('geomField'));

src/view-slickgrid.js

@@ -19,9 +19,9 @@ my.SlickGrid = Backbone.View.extend({
     var self = this;
     this.el = $(this.el);
     _.bindAll(this, 'render');
-    this.model.currentDocuments.bind('add', this.render);
+    this.model.currentRecords.bind('add', this.render);
-    this.model.currentDocuments.bind('reset', this.render);
+    this.model.currentRecords.bind('reset', this.render);
-    this.model.currentDocuments.bind('remove', this.render);
+    this.model.currentRecords.bind('remove', this.render);
 
     var state = _.extend({
         hiddenColumns: [],
@@ -110,7 +110,7 @@ my.SlickGrid = Backbone.View.extend({
 
     var data = [];
 
-    this.model.currentDocuments.each(function(doc){
+    this.model.currentRecords.each(function(doc){
       var row = {};
       self.model.fields.each(function(field){
         row[field.id] = doc.getFieldValue(field);

src/view-timeline.js

@@ -31,7 +31,7 @@ my.Timeline = Backbone.View.extend({
     this.model.fields.bind('reset', function() {
       self._setupTemporalField();
     });
-    this.model.currentDocuments.bind('all', function() {
+    this.model.currentRecords.bind('all', function() {
       self.reloadData();
     });
     var stateData = _.extend({
@@ -78,11 +78,11 @@ my.Timeline = Backbone.View.extend({
         ]
       }
     };
-    this.model.currentDocuments.each(function(doc) {
+    this.model.currentRecords.each(function(doc) {
       var start = doc.get(self.state.get('startField'));
       if (start) {
-        var end = moment(doc.get(self.state.get('endField')));
+        var end = doc.get(self.state.get('endField'));
-        end = end ? end.toDate() : null;
+        end = end ? moment(end).toDate() : null;
         var tlEntry = {
           "startDate": moment(start).toDate(),
           "endDate": end,

src/view-transform-dialog.js

@@ -98,7 +98,7 @@ my.ColumnTransform = Backbone.View.extend({
     }
     this.el.modal('hide');
     this.trigger('recline:flash', {message: "Updating all visible docs. This could take a while...", persist: true, loader: true});
-      var docs = self.model.currentDocuments.map(function(doc) {
+      var docs = self.model.currentRecords.map(function(doc) {
        return doc.toJSON();
       });
     // TODO: notify about failed docs? 
@@ -107,14 +107,14 @@ my.ColumnTransform = Backbone.View.extend({
     function onCompletedUpdate() {
       totalToUpdate += -1;
       if (totalToUpdate === 0) {
-        self.trigger('recline:flash', {message: toUpdate.length + " documents updated successfully"});
+        self.trigger('recline:flash', {message: toUpdate.length + " records 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);
+      var realDoc = self.model.currentRecords.get(editedDoc.id);
       realDoc.set(editedDoc);
       realDoc.save().then(onCompletedUpdate).fail(onCompletedUpdate);
     });
@@ -158,7 +158,7 @@ my.ColumnTransform = Backbone.View.extend({
       var editFunc = costco.evalFunction(e.target.value);
       if (!editFunc.errorMessage) {
         errors.text('No syntax error.');
-        var docs = self.model.currentDocuments.map(function(doc) {
+        var docs = self.model.currentRecords.map(function(doc) {
           return doc.toJSON();
         });
         var previewData = costco.previewTransform(docs, editFunc, self.state.currentColumn);

test/backend.elasticsearch.test.js

@@ -155,11 +155,11 @@ test("write", function() {
   stop();
 
   var id = parseInt(Math.random()*100000000).toString();
-  var doc = {
+  var rec = {
     id: id,
     title: 'my title'
   };
-  var jqxhr = backend.upsert(doc);
+  var jqxhr = backend.upsert(rec);
   jqxhr.done(function(data) {
     ok(data.ok);
     equal(data._id, id);
@@ -167,16 +167,16 @@ test("write", function() {
     equal(data._version, 1);
     
     // update
-    doc.title = 'new title';
+    rec.title = 'new title';
-    var jqxhr = backend.upsert(doc);
+    var jqxhr = backend.upsert(rec);
     jqxhr.done(function(data) {
       equal(data._version, 2);
 
       // delete
-      var jqxhr = backend.delete(doc.id);
+      var jqxhr = backend.delete(rec.id);
       jqxhr.done(function(data) {
         ok(data.ok);
-        doc = null;
+        rec = null;
 
         // try to get ...
         var jqxhr = backend.get(id);
@@ -233,10 +233,10 @@ test("query", function() {
 
   dataset.fetch().done(function(dataset) {
     deepEqual(['_created', '_last_modified', 'end', 'owner', 'start', 'title'], _.pluck(dataset.fields.toJSON(), 'id'));
-    dataset.query().then(function(docList) {
+    dataset.query().then(function(recList) {
       equal(3, dataset.docCount);
-      equal(3, docList.length);
+      equal(3, recList.length);
-      equal('Note 1', docList.models[0].get('title'));
+      equal('Note 1', recList.models[0].get('title'));
       start();
     });
   });
@@ -254,14 +254,14 @@ test("write", function() {
   stop();
 
   var id = parseInt(Math.random()*100000000).toString();
-  var doc = new recline.Model.Document({
+  var rec = new recline.Model.Record({
     id: id,
     title: 'my title'
   });
-  doc.backend = backend;
+  rec.backend = backend;
-  doc.dataset = dataset;
+  rec.dataset = dataset;
-  dataset.currentDocuments.add(doc);
+  dataset.currentRecords.add(rec);
-  var jqxhr = doc.save();
+  var jqxhr = rec.save();
   jqxhr.done(function(data) {
     ok(data.ok);
     equal(data._id, id);
@@ -269,29 +269,29 @@ test("write", function() {
     equal(data._version, 1);
     
     // update
-    doc.set({title: 'new title'});
+    rec.set({title: 'new title'});
-    var jqxhr = doc.save();
+    var jqxhr = rec.save();
     jqxhr.done(function(data) {
       equal(data._version, 2);
 
       // delete
-      var jqxhr = doc.destroy();
+      var jqxhr = rec.destroy();
       jqxhr.done(function(data) {
         ok(data.ok);
-        doc = null;
+        rec = null;
 
         // try to get ...
-        var olddoc = new recline.Model.Document({id: id});
+        var oldrec = new recline.Model.Record({id: id});
-        equal(olddoc.get('title'), null);
+        equal(oldrec.get('title'), null);
-        olddoc.dataset = dataset;
+        oldrec.dataset = dataset;
-        olddoc.backend = backend;
+        oldrec.backend = backend;
-        var jqxhr = olddoc.fetch();
+        var jqxhr = oldrec.fetch();
         jqxhr.done(function(data) {
           // should not be here
           ok(false, 'Should have got 404');
         }).error(function(error) {
           equal(error.status, 404);
-          equal(typeof olddoc.get('title'), 'undefined');
+          equal(typeof oldrec.get('title'), 'undefined');
           start();
         });
       });

test/backend/csv.test.js

@@ -26,7 +26,7 @@ test("parseCSV", function() {
   '"Other, AN", 12:35\n';
   var dataset = recline.Backend.CSV.csvToDataset(csv);
   dataset.query();
-  equal(dataset.currentDocuments.length, 3);
+  equal(dataset.currentRecords.length, 3);
 });
 
 test("parseCSVsemicolon", function() {

test/backend/memory.test.js

@@ -30,8 +30,8 @@ test('query', function () {
     , from: 2
   };
   var out = data.query(queryObj);
-  deepEqual(out.documents[0], memoryData[2]);
+  deepEqual(out.records[0], memoryData[2]);
-  equal(out.documents.length, 4);
+  equal(out.records.length, 4);
   equal(out.total, 6);
 });
 
@@ -43,18 +43,18 @@ test('query sort', function () {
     ]
   };
   var out = data.query(queryObj);
-  equal(out.documents[0].x, 6);
+  equal(out.records[0].x, 6);
 });
 
 test('query string', function () {
   var data = _wrapData();
   var out = data.query({q: 'UK'});
   equal(out.total, 3);
-  deepEqual(_.pluck(out.documents, 'country'), ['UK', 'UK', 'UK']);
+  deepEqual(_.pluck(out.records, 'country'), ['UK', 'UK', 'UK']);
 
   var out = data.query({q: 'UK 6'})
   equal(out.total, 1);
-  deepEqual(out.documents[0].id, 1);
+  deepEqual(out.records[0].id, 1);
 });
 
 test('filters', function () {
@@ -63,7 +63,7 @@ test('filters', function () {
   query.addTermFilter('country', 'UK');
   var out = data.query(query.toJSON());
   equal(out.total, 3);
-  deepEqual(_.pluck(out.documents, 'country'), ['UK', 'UK', 'UK']);
+  deepEqual(_.pluck(out.records, 'country'), ['UK', 'UK', 'UK']);
 });
 
 test('facet', function () {
@@ -118,7 +118,7 @@ var memoryData = {
     , id: 'test-dataset'
   },
   fields: [{id: 'x'}, {id: 'y'}, {id: 'z'}, {id: 'country'}, {id: 'label'}],
-  documents: [
+  records: [
     {id: 0, x: 1, y: 2, z: 3, country: 'DE', label: 'first'}
     , {id: 1, x: 2, y: 4, z: 6, country: 'UK', label: 'second'}
     , {id: 2, x: 3, y: 6, z: 9, country: 'US', label: 'third'}
@@ -129,16 +129,16 @@ var memoryData = {
 };
 
 function makeBackendDataset() {
-  var dataset = new recline.Backend.Memory.createDataset(memoryData.documents, null, memoryData.metadata);
+  var dataset = new recline.Backend.Memory.createDataset(memoryData.records, null, memoryData.metadata);
   return dataset;
 }
 
 test('createDataset', function () {
-  var dataset = recline.Backend.Memory.createDataset(memoryData.documents);
+  var dataset = recline.Backend.Memory.createDataset(memoryData.records);
   equal(dataset.fields.length, 6);
   deepEqual(['id', 'x', 'y', 'z', 'country', 'label'], dataset.fields.pluck('id'));
   dataset.query();
-  equal(memoryData.documents.length, dataset.currentDocuments.length);
+  equal(memoryData.records.length, dataset.currentRecords.length);
 });
 
 test('basics', function () {
@@ -162,8 +162,8 @@ test('query', function () {
     size: 4
     , from: 2
   };
-  dataset.query(queryObj).then(function(documentList) {
+  dataset.query(queryObj).then(function(recordList) {
-    deepEqual(data[2], documentList.models[0].toJSON());
+    deepEqual(data[2], recordList.models[0].toJSON());
   });
 });
 
@@ -177,7 +177,7 @@ test('query sort', function () {
     ]
   };
   dataset.query(queryObj).then(function() {
-    var doc0 = dataset.currentDocuments.models[0].toJSON();
+    var doc0 = dataset.currentRecords.models[0].toJSON();
     equal(doc0.x, 6);
   });
 });
@@ -186,13 +186,13 @@ test('query string', function () {
   var dataset = makeBackendDataset();
   dataset.fetch();
   dataset.query({q: 'UK'}).then(function() {
-    equal(dataset.currentDocuments.length, 3);
+    equal(dataset.currentRecords.length, 3);
-    deepEqual(dataset.currentDocuments.pluck('country'), ['UK', 'UK', 'UK']);
+    deepEqual(dataset.currentRecords.pluck('country'), ['UK', 'UK', 'UK']);
   });
 
   dataset.query({q: 'UK 6'}).then(function() {
-    equal(dataset.currentDocuments.length, 1);
+    equal(dataset.currentRecords.length, 1);
-    deepEqual(dataset.currentDocuments.models[0].id, 1);
+    deepEqual(dataset.currentRecords.models[0].id, 1);
   });
 });
 
@@ -200,8 +200,8 @@ test('filters', function () {
   var dataset = makeBackendDataset();
   dataset.queryState.addTermFilter('country', 'UK');
   dataset.query().then(function() {
-    equal(dataset.currentDocuments.length, 3);
+    equal(dataset.currentRecords.length, 3);
-    deepEqual(dataset.currentDocuments.pluck('country'), ['UK', 'UK', 'UK']);
+    deepEqual(dataset.currentRecords.pluck('country'), ['UK', 'UK', 'UK']);
   });
 });
 
@@ -247,7 +247,7 @@ test('update and delete', function () {
     // Test Delete
     doc1.destroy().then(function() {
       equal(data.data.length, 5);
-      equal(data.data[0].x, memoryData.documents[1].x);
+      equal(data.data[0].x, memoryData.records[1].x);
     });
   });
 });

test/model.test.js

@@ -39,7 +39,7 @@ test('Field: basics', function () {
 });
 
 test('Field: default renderers', function () {
-  var doc = new recline.Model.Document({
+  var doc = new recline.Model.Record({
     x: 12.3,
     myobject: {a: 1, b: 2},
     link: 'http://abc.com/',
@@ -74,7 +74,7 @@ test('Field: default renderers', function () {
 });
 
 test('Field: custom deriver and renderer', function () {
-  var doc = new recline.Model.Document({x: 123});
+  var doc = new recline.Model.Record({x: 123});
   var cellRenderer = function(value, field) {
     return '<span class="field-' + field.id + '">' + value + '</span>';
   }

test/view-grid.test.js

@@ -38,7 +38,7 @@ test('state', function () {
 test('new GridRow View', function () {
   var $el = $('<tr />');
   $('.fixtures .test-datatable').append($el);
-  var doc = new recline.Model.Document({
+  var doc = new recline.Model.Record({
     'id': 1,
     'b': '2',
     'a': '1'

test/view-map.test.js

@@ -11,12 +11,12 @@ var GeoJSONFixture = {
         {id: 'z'},
         {id: 'geom'}
       ];
-    var documents = [
+    var records = [
       {id: 0, x: 1, y: 2, z: 3, geom: '{"type":"Point","coordinates":[13.40,52.35]}'},
       {id: 1, x: 2, y: 4, z: 6, geom: {type:"Point",coordinates:[13.40,52.35]}},
       {id: 2, x: 3, y: 6, z: 9, geom: {type:"LineString",coordinates:[[100.0, 0.0],[101.0, 1.0]]}}
     ];
-    var dataset = recline.Backend.Memory.createDataset(documents, fields);
+    var dataset = recline.Backend.Memory.createDataset(records, fields);
     return dataset;
   }
 };
@@ -55,12 +55,12 @@ test('Lat/Lon geom fields', function () {
   // Check that all markers were created
   equal(_getFeaturesCount(view.features),6);
 
-  // Delete a document
+  // Delete a record
-  view.model.currentDocuments.remove(view.model.currentDocuments.get('1'));
+  view.model.currentRecords.remove(view.model.currentRecords.get('1'));
   equal(_getFeaturesCount(view.features),5);
 
   // Add a new one
-  view.model.currentDocuments.add({id: 7, x: 7, y: 14, z: 21, country: 'KX', label: 'seventh', lat:13.23, lon:23.56}),
+  view.model.currentRecords.add({id: 7, x: 7, y: 14, z: 21, country: 'KX', label: 'seventh', lat:13.23, lon:23.56}),
   equal(_getFeaturesCount(view.features),6);
 
   view.remove();
@@ -79,12 +79,12 @@ test('GeoJSON geom field', function () {
   // Check that all features were created
   equal(_getFeaturesCount(view.features),3);
 
-  // Delete a document
+  // Delete a record
-  view.model.currentDocuments.remove(view.model.currentDocuments.get('2'));
+  view.model.currentRecords.remove(view.model.currentRecords.get('2'));
   equal(_getFeaturesCount(view.features),2);
 
   // Add it back
-  view.model.currentDocuments.add({id: 2, x: 3, y: 6, z: 9, geom: {type:"LineString",coordinates:[[100.0, 0.0],[101.0, 1.0]]}}),
+  view.model.currentRecords.add({id: 2, x: 3, y: 6, z: 9, geom: {type:"LineString",coordinates:[[100.0, 0.0],[101.0, 1.0]]}}),
   equal(_getFeaturesCount(view.features),3);
 
   view.remove();

test/view-slickgrid.test.js

@@ -16,7 +16,7 @@ test('basic', function () {
   assertPresent('.slick-header-column[title="x"]');
   equal($('.slick-header-column').length,dataset.fields.length);
 
-  equal(dataset.currentDocuments.length,view.grid.getDataLength());
+  equal(dataset.currentRecords.length,view.grid.getDataLength());
 
   view.remove();
 });

test/view-timeline.test.js

@@ -17,16 +17,16 @@ test('extract dates and timelineJSON', function () {
         'headline': '',
         'date': [
           {
-            'startDate': '2012-03-20',
+            'startDate': new Date('2012-03-20'),
             'endDate': null,
-            'headline': '2012-03-20',
+            'headline': '1',
-            'text': ''
+            'text': '<div><strong>Date</strong>: 2012-03-20</div><div><strong>title</strong>: 1</div>'
           },
           {
-            'startDate': '2012-03-25',
+            'startDate': new Date('2012-03-25'),
             'endDate': null,
-            'headline': '2012-03-25',
+            'headline': '2',
-            'text': ''
+            'text': '<div><strong>Date</strong>: 2012-03-25</div><div><strong>title</strong>: 2</div>'
           }
         ]
       }