model.js | ||
|---|---|---|
Recline Backbone Models | this.recline = this.recline || {};
this.recline.Model = this.recline.Model || {};
-(function($, my) { | |
A Dataset model+(function($, my) { | ||
A Dataset modelA model has the following (non-Backbone) attributes: -
| my.Dataset = Backbone.Model.extend({
- __type__: 'Dataset',
- initialize: function(model, backend) {
+ | 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) {
@@ -26,7 +38,7 @@ currently loaded for viewing (you update currentDocuments by calling query)
this.queryState = new my.Query();
this.queryState.bind('change', this.query);
this.queryState.bind('facet:add', this.query);
- }, | |
query+ }, | ||
queryAJAX method with promise API to get documents from the backend. @@ -79,14 +91,14 @@ also returned. | data.fields = this.fields.toJSON(); return data; } -}); | |
A Document (aka Row)+}); | ||
A Document (aka Row)A single entry or row in the dataset | my.Document = Backbone.Model.extend({
__type__: 'Document'
-}); | |
A Backbone collection of Documents | my.DocumentList = Backbone.Collection.extend({
+}); | |
A Backbone collection of Documents | my.DocumentList = Backbone.Collection.extend({
__type__: 'DocumentList',
model: my.Document
-}); | |
A Field (aka Column) on a Dataset+}); | ||
A Field (aka Column) on a DatasetFollowing attributes as standard: @@ -99,8 +111,8 @@ also returned. | id: null, label: null, type: 'String' - }, | |
| In addition to normal backbone initialization via a Hash you can also -just pass a single argument representing id to the ctor | initialize: function(data) { | |
| if a hash not passed in the first argument is set as value for key 0 | if ('0' in data) {
+ },
+ initialize: function(data) { | |
| 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) {
@@ -111,25 +123,81 @@ just pass a single argument representing id to the ctor |
my.FieldList = Backbone.Collection.extend({
model: my.Field
-}); |
A Query object storing Dataset Query state | my.Query = Backbone.Model.extend({
+}); | |
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. + +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: + +
Additions: + +
Examples + +
+{
+ q: 'quick brown fox',
+ filters: [
+ { term: { 'owner': 'jones' } }
+ ]
+}
+ | my.Query = Backbone.Model.extend({
defaults: function() {
return {
size: 100
, from: 0
- , facets: {} | |
| http://www.elasticsearch.org/guide/reference/query-dsl/and-filter.html -, filter: {} -list of simple filters which will be add to 'add' filter of filter | , filters: []
+ , facets: {} | |
| http://www.elasticsearch.org/guide/reference/query-dsl/and-filter.html +, filter: {} | | |
| list of simple filters which will be add to 'add' filter of filter | , filters: []
}
- }, | |
| Set (update or add) a terms filter -http://www.elasticsearch.org/guide/reference/query-dsl/terms-filter.html | addTermFilter: function(fieldId, value) {
+ }, | |
addTermFilter+ +Set (update or add) a terms filter to filters + +See http://www.elasticsearch.org/guide/reference/query-dsl/terms-filter.html | 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 ... | this.trigger('change');
- },
- 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)) {
+ this.set({filters: filters}); | |
| change does not seem to be triggered ... | this.trigger('change');
+ }, | |
addFacet+ +Add a Facet to this query + +See http://www.elasticsearch.org/guide/reference/api/search/facets/ | 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] = {
@@ -138,15 +206,56 @@ http://www.elasticsearch.org/guide/reference/query-dsl/terms-filter.html
this.set({facets: facets}, {silent: true});
this.trigger('facet:add', this);
}
-}); | |
A Facet (Result) | my.Facet = Backbone.Model.extend({
+}); | |
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: +http://www.elasticsearch.org/guide/reference/api/search/facets/ + +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 number of tokens in the facet | total: 0, | |
| number of facet values not included in the returned facets | other: 0, | |
| number of documents which have no value for the field | missing: 0, | |
| term object ({term: , count: ...}) | terms: []
+ _type: 'terms',
+ total: 0,
+ other: 0,
+ missing: 0,
+ terms: []
}
}
-}); | |
A Collection/List of Facets | my.FacetList = Backbone.Collection.extend({
+}); | |
A Collection/List of Facets | my.FacetList = Backbone.Collection.extend({
model: my.Facet
-}); | |
Backend registry+}); | ||
Backend registryBackends will register themselves by id into this registry | my.backends = {};
diff --git a/index.html b/index.html
index a246a01f..e7b7d616 100644
--- a/index.html
+++ b/index.html
@@ -84,11 +84,11 @@
Recline has a simple structure layered on top of the basic Model/View distinction inherent in Backbone. -Models: there are two main model objects: +Models+There are two main model objects:
Additional, related models: +
More detail of how these work can be found in the Model source docs. -Backends connect Dataset and Documents to data from a + Backends+Backends connect Dataset and Documents 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 and doing bulk transforms on the backend. @@ -231,7 +245,8 @@ 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. -Views: complementing the model are various Views (you can + Views+Complementing the model are various Views (you can also easily write your own). Each view holds a pointer to a Dataset:
There are additional views which do not display a whole dataset but which +are useful: +
Source Docs (via Docco)+Models and Views (Widgets)+ +Backends+
|