Javascript Data Request Form: Difference between revisions
From OPeNDAP Documentation
⧼opendap2-jumptonavigation⧽
EvanKroske (talk | contribs) (Added execution path and started application structure) |
EvanKroske (talk | contribs) (→DAS/DDS Javascript API: Fleshed out tentative API) |
||
Line 40: | Line 40: | ||
=== DAS/DDS Javascript API === | === DAS/DDS Javascript API === | ||
==== Public interface ==== | ==== Public interface ==== | ||
The public interface allows developers to easily fetch JSON-encoded DAS and DDS data from a data source. | |||
<pre><code> | |||
var dasData = fetchDAS("http://test.com/data.gz"); | |||
var ddsData = fetchDDS("http://test.com/data.gz"); | |||
</code></pre> | |||
==== HTTP request generator ==== | ==== HTTP request generator ==== | ||
This critical piece will handle fetching the raw DAS or DDS data from the server. | |||
<pre><code> | |||
var rawDASData = fetch({"url" : "http://test.com/data.gz.das", "callback" : onDataReceived}); | |||
</code></pre> | |||
==== DAS parser ==== | ==== DAS parser ==== | ||
The DAS parser will convert the raw DAS data into a Javascript-accessible JSON object. | |||
<pre><code> | |||
var dasParser = createDASParser(); | |||
var dasData = dasParser.parse(rawDASData); | |||
</code></pre> | |||
==== DDS parser ==== | ==== DDS parser ==== | ||
Like the DAS parser, the DDS parser will translate a raw DDS string into a JSON object. | |||
<pre><code> | |||
var ddsParser = createDDSParser(); | |||
var ddsData = ddsParser.parse(rawDDSData); | |||
</code></pre> |
Revision as of 20:15, 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
- Create generalized Javascript OpenDAP-metadata bridge
- Write Javascript OpenDAP-metadata retrieval module (may involve server-side modifications)
- Write OpenDAP-metadata parser
- Write JSON emitter
- Create data request form constructor using metadata bridge
- Write basic form constructor to build simple but clear HTML forms
- Add more advanced form controls (maps, timelines, etc.) for more capable browsers
Execution path
- User requests data-request form
- Server sends simple HTML page with form-generation Javascript
- Javascript requests DDS and DAS for selected data
- Javascript parses DDS and DAS to generate HTML form
- User requests data through form
- 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.
<code> var dasData = fetchDAS("http://test.com/data.gz"); var ddsData = fetchDDS("http://test.com/data.gz"); </code>
HTTP request generator
This critical piece will handle fetching the raw DAS or DDS data from the server.
<code> var rawDASData = fetch({"url" : "http://test.com/data.gz.das", "callback" : onDataReceived}); </code>
DAS parser
The DAS parser will convert the raw DAS data into a Javascript-accessible JSON object.
<code> var dasParser = createDASParser(); var dasData = dasParser.parse(rawDASData); </code>
DDS parser
Like the DAS parser, the DDS parser will translate a raw DDS string into a JSON object.
<code> var ddsParser = createDDSParser(); var ddsData = ddsParser.parse(rawDDSData); </code>