97 lines
11 KiB
HTML
97 lines
11 KiB
HTML
<!DOCTYPE html> <html> <head> <title>base.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="base.html"> base.js </a> <a class="source" href="csv.html"> csv.js </a> <a class="source" href="dataproxy.html"> dataproxy.js </a> <a class="source" href="elasticsearch.html"> elasticsearch.js </a> <a class="source" href="gdocs.html"> gdocs.js </a> <a class="source" href="memory.html"> memory.js </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> base.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> <h1>Recline Backends</h1>
|
|
|
|
<p>Backends are connectors to backend data sources and stores</p>
|
|
|
|
<p>This is just the base module containing a template Base class and convenience methods.</p> </td> <td class="code"> <div class="highlight"><pre><span class="k">this</span><span class="p">.</span><span class="nx">recline</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">recline</span> <span class="o">||</span> <span class="p">{};</span>
|
|
<span class="k">this</span><span class="p">.</span><span class="nx">recline</span><span class="p">.</span><span class="nx">Backend</span> <span class="o">=</span> <span class="k">this</span><span class="p">.</span><span class="nx">recline</span><span class="p">.</span><span class="nx">Backend</span> <span class="o">||</span> <span class="p">{};</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h2>recline.Backend.Base</h2>
|
|
|
|
<p>Exemplar 'class' for backends showing what a base class would look like.</p> </td> <td class="code"> <div class="highlight"><pre><span class="k">this</span><span class="p">.</span><span class="nx">recline</span><span class="p">.</span><span class="nx">Backend</span><span class="p">.</span><span class="nx">Base</span> <span class="o">=</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <h3><strong>type</strong></h3>
|
|
|
|
<p>'type' of this backend. This should be either the class path for this
|
|
object as a string (e.g. recline.Backend.Memory) or for Backends within
|
|
recline.Backend module it may be their class name.</p>
|
|
|
|
<p>This value is used as an identifier for this backend when initializing
|
|
backends (see recline.Model.Dataset.initialize).</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">this</span><span class="p">.</span><span class="nx">__type__</span> <span class="o">=</span> <span class="s1">'base'</span><span class="p">;</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <h3>readonly</h3>
|
|
|
|
<p>Class level attribute indicating that this backend is read-only (that
|
|
is, cannot be written to).</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">this</span><span class="p">.</span><span class="nx">readonly</span> <span class="o">=</span> <span class="kc">true</span><span class="p">;</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <h3>sync</h3>
|
|
|
|
<p>An implementation of Backbone.sync that will be used to override
|
|
Backbone.sync on operations for Datasets and Documents which are using this backend.</p>
|
|
|
|
<p>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.</p>
|
|
|
|
<p>For backends supporting write operations you must implement update and delete support for Document objects.</p>
|
|
|
|
<p>All code paths should return an object conforming to the jquery promise API.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">this</span><span class="p">.</span><span class="nx">sync</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">method</span><span class="p">,</span> <span class="nx">model</span><span class="p">,</span> <span class="nx">options</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="p">},</span>
|
|
</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <h3>query</h3>
|
|
|
|
<p>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.</p>
|
|
|
|
<p>@param {recline.model.Dataset} model: Dataset model.</p>
|
|
|
|
<p>@param {Object} queryObj: object describing a query (usually produced by
|
|
using recline.Model.Query and calling toJSON on it).</p>
|
|
|
|
<p>The structure of data in the Query object or
|
|
Hash should follow that defined in <a
|
|
href="http://github.com/okfn/recline/issues/34">issue 34</a>.
|
|
(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).</p>
|
|
|
|
<p>@returns {Promise} promise API object. The promise resolve method will
|
|
be called on query completion with a QueryResult object.</p>
|
|
|
|
<p>A QueryResult has the following structure (modelled closely on
|
|
ElasticSearch - see <a
|
|
href="https://github.com/okfn/recline/issues/57">this issue for more
|
|
details</a>):</p>
|
|
|
|
<pre>
|
|
{
|
|
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 <http://www.elasticsearch.org/guide/reference/api/search/facets/>)
|
|
}
|
|
}
|
|
</pre> </td> <td class="code"> <div class="highlight"><pre> <span class="k">this</span><span class="p">.</span><span class="nx">query</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">model</span><span class="p">,</span> <span class="nx">queryObj</span><span class="p">)</span> <span class="p">{}</span>
|
|
<span class="p">};</span></pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <h3>makeRequest</h3>
|
|
|
|
<p>Just $.ajax but in any headers in the 'headers' attribute of this
|
|
Backend instance. Example:</p>
|
|
|
|
<pre>
|
|
var jqxhr = this._makeRequest({
|
|
url: the-url
|
|
});
|
|
</pre> </td> <td class="code"> <div class="highlight"><pre><span class="k">this</span><span class="p">.</span><span class="nx">recline</span><span class="p">.</span><span class="nx">Backend</span><span class="p">.</span><span class="nx">makeRequest</span> <span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">data</span><span class="p">,</span> <span class="nx">headers</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="kd">var</span> <span class="nx">extras</span> <span class="o">=</span> <span class="p">{};</span>
|
|
<span class="k">if</span> <span class="p">(</span><span class="nx">headers</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">extras</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="nx">beforeSend</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">req</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">_</span><span class="p">.</span><span class="nx">each</span><span class="p">(</span><span class="nx">headers</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">value</span><span class="p">,</span> <span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
|
|
<span class="nx">req</span><span class="p">.</span><span class="nx">setRequestHeader</span><span class="p">(</span><span class="nx">key</span><span class="p">,</span> <span class="nx">value</span><span class="p">);</span>
|
|
<span class="p">});</span>
|
|
<span class="p">}</span>
|
|
<span class="p">};</span>
|
|
<span class="p">}</span>
|
|
<span class="kd">var</span> <span class="nx">data</span> <span class="o">=</span> <span class="nx">_</span><span class="p">.</span><span class="nx">extend</span><span class="p">(</span><span class="nx">extras</span><span class="p">,</span> <span class="nx">data</span><span class="p">);</span>
|
|
<span class="k">return</span> <span class="nx">$</span><span class="p">.</span><span class="nx">ajax</span><span class="p">(</span><span class="nx">data</span><span class="p">);</span>
|
|
<span class="p">};</span>
|
|
|
|
</pre></div> </td> </tr> </tbody> </table> </div> </body> </html> |