jscriptCore.tmpl | searchcode

/opendap/src/main/java/opendap/servers/www/jscriptCore.tmpl

https://github.com/blazetopher/THREDDS
Go Template | 395 lines | 344 code | 51 blank | 0 comment | 0 complexity | d0d32c7b86c74177375248018298ee7a MD5 | raw file



// -*- Java -*-



/////////////////////////////////////////////////////////////////////////////

// This file is part of the "Java-DAP" project, a Java implementation

// of the OPeNDAP Data Access Protocol.

//

// Copyright (c) 2007 OPeNDAP, Inc.

//

// This library is free software; you can redistribute it and/or

// modify it under the terms of the GNU Lesser General Public

// License as published by the Free Software Foundation; either

// version 2.1 of the License, or (at your option) any later version.

//

// This library is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

// Lesser General Public License for more details.

//

// You should have received a copy of the GNU Lesser General Public

// License along with this library; if not, write to the Free Software

// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

//

// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.

/////////////////////////////////////////////////////////////////////////////



//

// Authors:

//	jhrg,jimg	James Gallagher (jgallagher@gso.uri.edu)



var reflection_cgi = "http://unidata.ucar.edu/cgi-bin/dods/posturl.pl";



// Event handlers for the disposition button.



// The ascii_button handler sends data to a new window. The user can then

// save the data to a file.



function ascii_button() {

    var url = new String(document.forms[0].url.value);



    var url_parts = url.split("?");

    /* handle case where constraint is null. */

    if (url_parts[1] != null) {

        var ascii_url = url_parts[0] + ".ascii?" + url_parts[1];

    }

    else {

        var ascii_url = url_parts[0] + ".ascii?";

    }



    window.open(ascii_url, "ASCII_Data");

}



/* The binary_button handler loads the data to the current window. Since it

   is binary, Netscape will ask the user for a filename and save the data

   to that file. */



function binary_button() {

    var url = new String(document.forms[0].url.value);



    var url_parts = url.split("?");

    /* handle case where constraint is null. */

    if (url_parts[1] != null) {

        var binary_url = url_parts[0] + ".dods?" + url_parts[1];

    }

    else {

        var binary_url = url_parts[0] + ".dods?";

    }



    window.location = binary_url;

}



/* Route the URL to Matlab, IDL, .... Users must add an entry into their mime

   types file (aka list of Netscape helper applications) so that the URL will

   be fedd into Matlab which must, in addition, be running loaddods.



   Note that reflection_cgi is a global JavaScript variable set at the

   begining of this `file'. */



function program_button() {

    var program_url = new String(document.forms[0].url.value);



    /* Build a call to the reflector CGI. */

    var CGI = reflection_cgi + "?" + "url=" + program_url + "&disposition=matlab";



    window.location = CGI;

}



var help = 0;			// Our friend, the help window.



function help_button() {

    // Check the global to keep from opening the window again if it is

    // already visible. I think Netscape handles this but I know it will

    // write the contents over and over again. This preents that, too.

    // 10/8/99 jhrg

    if (help && !help.closed)

	return;



    // Resize on Netscape 4 is hosed. When enabled, if a user resizes then

    // the root window's document gets reloaded. This does not happen on IE5.

    // regardless, with scrollbars we don't absolutely need to be able to

    // resize. 10/8/99 jhrg

    help = window.open("", "help", "scrollbars,dependent,width=600,height=400");

    write_help_contents(help);

}



function write_help_contents() {

    help.document.writeln("<html><head><title> " +

"Help for the DODS Dataset Access Form</title></head><body><form> " +

"<center><h2>Help for the DODS Dataset Access Form</h2></center> " +

"This form displays information from the dataset whose URL is shown in " +

"the <em>DataURL</em> field. Each variable in this dataset is shown " +

"below in the section labeled <em>Variables</em>. " +

"<ul>" +

"<li>To select a variable click on the checkbox to its left. " +

"<li>To constrain a variable that you've selected, edit the information " +

"that appears in the text boxes below the variable. " +

"<li>To get ASCII or binary values for the variables you've selected, " +

"click on the <em>Get ASCII</em> or <em>Get Binary</em> buttons. " +

//  "<li>To use the <em>Send to Program</em> feature you must install a web " +

//  "helper application that can route the DODS URL built by this form to a " +

//  "client. Look on the <a " +

//  "href=\"http://unidata.ucar.edu/packages/dods/\" target=\"DODS\"> " +

//  "DODS home page (http://unidata.ucar.edu/packages/dods/)</a> " +

//  "for a suitable client. " +

//  "</ul>" +

"Note that the URL displayed in the <em>DataURL</em> field is updated " +

"as you select and/or constrain variables. The URL in this field can be " +

"cut and pasted in various DODS clients such as the Matlab and IDL " +

"command extensions. See the <a " +

"href=\"http://unidata.ucar.edu/packages/dods/\" target=\"DODS\"> " +

"DODS home page</a> for " +

"information about those clients. " +

"<p><hr><p> " +

"<center> " +

"<input type=\"button\" value=\"Close\" onclick=\"self.close()\"> " +

"</center></form></body></html>");

}



function open_dods_home() {

    window.open("http://unidata.ucar.edu/packages/dods/", "DODS_HOME_PAGE");

}





// Helper functions for the form.



function describe_index() {

   defaultStatus = "Enter start, stride and stop for the array dimension.";

}



function describe_selection() {

   defaultStatus = "Enter a relational expression (e.g., <20).";

}



function describe_operator() {

   defaultStatus = "Choose a relational operator. Use - to enter a function name).";

}



function describe_projection() {

   defaultStatus = "Add this variable to the projection.";

}



///////////////////////////////////////////////////////////

// The dods_url object.

///////////////////////////////////////////////////////////



// CTOR for dods_url

// Create the DODS URL object.

function dods_url(base_url) {

    this.url = base_url;

    this.projection = "";

    this.selection = "";

    this.num_dods_vars = 0;

    this.dods_vars = new Array();



    this.build_constraint = build_constraint;

    this.add_dods_var = add_dods_var;

    this.update_url = update_url;

}



// Method of dods_url

// Add the projection and selection to the displayed URL.

function update_url() {

    this.build_constraint();

    var url_text = this.url;

    // Only add the projection & selection (and ?) if there really are

    // constraints!

    if (this.projection.length + this.selection.length > 0)

        url_text += "?" + this.projection + this.selection;

    document.forms[0].url.value = url_text;

}



// Method of dods_url

// Scan all the form elements and pick out the various pieces of constraint

// information. Add these to the dods_url instance.

function build_constraint() {

    var p = "";

    var s = "";

    for (var i = 0; i < this.num_dods_vars; ++i) {

        if (this.dods_vars[i].is_projected == 1) {

	    // The comma is a clause separator.

	    if (p.length > 0)

	        p += ",";

            p += this.dods_vars[i].get_projection();

	}

	var temp_s = this.dods_vars[i].get_selection();

	if (temp_s.length > 0)

	    s += "&" + temp_s;    // The ampersand is a prefix to the clause.

    }



    this.projection = p;

    this.selection = s;

}



// Method of dods_url

// Add the variable to the dods_var array of dods_vars. The var_index is the

// number of *this particular* variable in the dataset, zero-based.

function add_dods_var(dods_var) {

    this.dods_vars[this.num_dods_vars] = dods_var;

    this.num_dods_vars++;

}



/////////////////////////////////////////////////////////////////

// dods_var

/////////////////////////////////////////////////////////////////



// CTOR for dods_var

// name: the name of the variable from DODS' perspective.

// js_var_name: the name of the variable within the form.

// is_array: 1 if this is an array, 0 otherwise.

function dods_var(name, js_var_name, is_array) {

    // Common members

    this.name = name;

    this.js_var_name = js_var_name;

    this.is_projected = 0;

    if (is_array > 0) {

        this.is_array = 1;

        this.num_dims = 0;        // Holds the number of dimensions

        this.dims = new Array(); // Holds the length of the dimensions



        this.add_dim = add_dim;

        this.display_indices = display_indices;

        this.erase_indices = erase_indices;

    }

    else

        this.is_array = 0;



    this.handle_projection_change = handle_projection_change;

    this.get_projection = get_projection;

    this.get_selection = get_selection;

}



// Method of dods_var

// Add a dimension to a DODS Array object.

function add_dim(dim_size) {

    this.dims[this.num_dims] = dim_size;

    this.num_dims++;

}



// Method of dods_var

// Add the array indices to the text widgets associated with this DODS

// array object. The text widgets are names <var_name>_0, <var_name>_1, ...

// <var_name>_n for an array with size N+1.

function display_indices() {

    for (var i = 0; i < this.num_dims; ++i) {

        var end_index = this.dims[i]-1;

        var s = "0:1:" + end_index.toString();

	var text_widget = "document.forms[0]." + this.js_var_name + "_" + i.toString();

	eval(text_widget).value = s;

    }

}



// Method of dods_var

// Use this to remove index information from a DODS array object.

function erase_indices() {

    for (var i = 0; i < this.num_dims; ++i) {

	var text_widget = "document.forms[0]." + this.js_var_name + "_" + i.toString();

	eval(text_widget).value = "";

    }

}



// Method of  dods_var

function handle_projection_change(check_box) {

    if (check_box.checked) {

        this.is_projected = 1;

	if (this.is_array == 1)

	    this.display_indices();

    }

    else {

        this.is_projected = 0;

	if (this.is_array == 1)

	    this.erase_indices();

    }



    DODS_URL.update_url();

}





// Method of dods_var

// Get the projection sub-expression for this variable.

function get_projection() {

    var p = "";

    if (this.is_array == 1) {

        p = this.name;		// ***

        for (var i = 0; i < this.num_dims; ++i) {

	    var text_widget = "document.forms[0]." + this.js_var_name + "_" + i.toString();

	    p += "[" + eval(text_widget).value + "]";

	}

    }

    else {

	p = this.name;		// ***

    }



    return p;

}



// Method of dods_var

// Get the selection (which is null for arrays).

function get_selection() {

    var s = "";

    if (this.is_array == 1) {

        return s;

    }

    else {

	var text_widget = "document.forms[0]." + this.js_var_name + "_selection";

        if (eval(text_widget).value != "") {

            var oper_widget_name = "document.forms[0]." + this.js_var_name + "_operator";

            var oper_widget = eval(oper_widget_name);

	    var operator = oper_widget.options[oper_widget.selectedIndex].value;

            // If the operator is `-' then don't prepend the variable name!

            // This provides a way for users to enter function names as

            // selection clauses.

            if (operator == "-")

                s = eval(text_widget).value;

            else

	        s = this.name + operator + eval(text_widget).value; // ***

        }

    }



    return s;

}



// $Log: jscriptCore.tmpl,v $

// Revision 1.1  2003/08/12 23:51:27  ndp

// Mass check in to begin Java-OPeNDAP development work

//

// Revision 1.1  2002/03/26 19:57:17  ndp

// *** empty log message ***

//

// Revision 1.4  2001/09/17 23:05:53  ndp

// *** empty log message ***

//

// Revision 1.1.2.3  2001/09/10 21:48:07  jimg

// Removed the `Send to Program' button and its help text.

//

// Revision 1.1.2.2  2001/09/10 19:32:28  jimg

// Fixed two problems: 1) Variable names in the JavaScript code sometimes

// contained spaces since they were made using the dataset's variable name.

// The names are now filtered through id2www and esc2underscore. 2) The CE

// sometimes contained spaces, again, because dataset variable names were

// used to build the CE. I filtered the names with id2www_ce before passing

// them to the JavaScript code.

//

// Revision 1.1.2.1  2001/01/26 04:01:13  jimg

// Added

//

// Revision 1.5  2000/11/09 21:04:37  jimg

// Merged changes from release-3-1. There was a goof and a bunch of the

// changes never made it to the branch. I merged the entire branch.

// There maybe problems still...

//

// Revision 1.4  2000/10/03 20:07:21  jimg

// Moved Logs to the end of each file.

//

// Revision 1.3  1999/05/18 20:08:18  jimg

// Fixed massive problems introduced by the String to string changes.

//

// Revision 1.2  2000/11/09 21:04:37  jimg

// Merged changes from release-3-1. There was a goof and a bunch of the

// changes never made it to the branch. I merged the entire branch.

// There maybe problems still...

//

// Revision 1.1.2.3  1999/10/13 17:02:55  jimg

// Changed location of posturl.pl.

//

// Revision 1.1.2.2  1999/10/11 17:57:32  jimg

// Fixed a bug which showed up in IE 5. Objects in IE 5 cannot use eval() to

// name a field and access a property of that field in the same statement.

// Instead, the use of eval to name a field and the access to that (new)

// field must be broken up. I think this is the case because IE 5's parser

// thinks `eval' is, in this situation, an object property. Of course,

// there's no eval property per se, so script execution halts. See the use of

// the document.forms[0].<text_widget> stuff in the method display_indices().

//

// Revision 1.1.2.1  1999/10/09 00:30:36  jimg

// Created.