Javascript Data Request Form: Difference between revisions

From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
(→‎DAS/DDS Javascript API: Fleshed out tentative API)
Line 44: Line 44:
The public interface allows developers to easily fetch JSON-encoded DAS and DDS data from a data source.
The public interface allows developers to easily fetch JSON-encoded DAS and DDS data from a data source.


<pre><code>
<code><pre>
var dasData = fetchDAS("http://test.com/data.gz");
var dasData = fetchDAS("http://test.com/data.gz");
var ddsData = fetchDDS("http://test.com/data.gz");
var ddsData = fetchDDS("http://test.com/data.gz");
</code></pre>
</pre></code>


==== HTTP request generator ====
==== HTTP request generator ====
This critical piece will handle fetching the raw DAS or DDS data from the server.
This critical piece will handle fetching the raw DAS or DDS data from the server.


<pre><code>
<code><pre>
var rawDASData = fetch({"url" : "http://test.com/data.gz.das", "callback" : onDataReceived});
var rawDASData = fetch({"url" : "http://test.com/data.gz.das", "callback" : onDataReceived});
</code></pre>
</pre></code>


==== DAS parser ====
==== DAS parser ====
The DAS parser will convert the raw DAS data into a Javascript-accessible JSON object.
The DAS parser will convert the raw DAS data into a Javascript-accessible JSON object.


<pre><code>
<code><pre>
var dasParser = createDASParser();
var dasParser = createDASParser();
var dasData = dasParser.parse(rawDASData);
var dasData = dasParser.parse(rawDASData);
</code></pre>
</pre></code>


==== DDS parser ====
==== DDS parser ====
Like the DAS parser, the DDS parser will translate a raw DDS string into a JSON object.
Like the DAS parser, the DDS parser will translate a raw DDS string into a JSON object.


<pre><code>
<code><pre>
var ddsParser = createDDSParser();
var ddsParser = createDDSParser();
var ddsData = ddsParser.parse(rawDDSData);
var ddsData = ddsParser.parse(rawDDSData);
</code></pre>
</pre></code>

Revision as of 20:18, 15 April 2010

My goal is to create a Javascript API for accessing OpenDAP metadata and an intuitive, Javascript-based data-request construction form.

Plan of action

  1. Create generalized Javascript OpenDAP-metadata bridge
    1. Write Javascript OpenDAP-metadata retrieval module (may involve server-side modifications)
    2. Write OpenDAP-metadata parser
    3. Write JSON emitter
  2. Create data request form constructor using metadata bridge
    1. Write basic form constructor to build simple but clear HTML forms
    2. Add more advanced form controls (maps, timelines, etc.) for more capable browsers

Execution path

  1. User requests data-request form
  2. Server sends simple HTML page with form-generation Javascript
  3. Javascript requests DDS and DAS for selected data
  4. Javascript parses DDS and DAS to generate HTML form
  5. User requests data through form
  6. Server returns user-selected data

Application structure

Form generator

Public interface

The public interface gives developers a dead-simple interface to create data-specific request forms.

createDataRequestForm({"url" : "http://test.com/data.gz", "containerID" : "requestform"});

Generator

The heart of the form generator transforms the JSON-encoded DAS and DDS into an interactive HTML form.

var generator = createFormGenerator();
var form = generator.generateForm(dasData, ddsData);
document.appendChild(form);

DAS/DDS Javascript API

Public interface

The public interface allows developers to easily fetch JSON-encoded DAS and DDS data from a data source.

var dasData = fetchDAS("http://test.com/data.gz");
var ddsData = fetchDDS("http://test.com/data.gz");

HTTP request generator

This critical piece will handle fetching the raw DAS or DDS data from the server.

var rawDASData = fetch({"url" : "http://test.com/data.gz.das", "callback" : onDataReceived});

DAS parser

The DAS parser will convert the raw DAS data into a Javascript-accessible JSON object.

var dasParser = createDASParser();
var dasData = dasParser.parse(rawDASData);

DDS parser

Like the DAS parser, the DDS parser will translate a raw DDS string into a JSON object.

var ddsParser = createDDSParser();
var ddsData = ddsParser.parse(rawDDSData);