(function($){
var debug=false;
-// debug=true
+ debug=true
var QueryTable = Plugin.extend({
// $(window).unbind('QueryTable');
var query = manifold.query_store.find_analyzed_query(this.options.query_uuid);
- this.method = query.object;
-
- var keys = manifold.metadata.get_key(this.method);
- this.key = (keys && keys.length == 1) ? keys[0] : null;
+ this.object = query.object;
+
+ //// we need 2 different keys
+ // * canonical_key is the primary key as derived from metadata (typically: urn)
+ // and is used to communicate about a given record with the other plugins
+ // * init_key is a key that both kinds of records
+ // (i.e. records returned by both queries) must have (typically: hrn or hostname)
+ // in general query_all will return well populated records, but query
+ // returns records with only the fields displayed on startup
+ var keys = manifold.metadata.get_key(this.object);
+ this.canonical_key = (keys && keys.length == 1) ? keys[0] : undefined;
+ //
+ this.init_key = this.options.init_key;
+ // have init_key default to canonical_key
+ this.init_key = this.init_key || this.canonical_key;
+ // sanity check
+ if ( ! this.init_key ) messages.warning ("QueryTable : cannot find init_key");
+ if ( ! this.canonical_key ) messages.warning ("QueryTable : cannot find canonical_key");
+ if (debug) messages.debug("querytable: canonical_key="+this.canonical_key+" init_key="+this.init_key);
/* Setup query and record handlers */
this.listen_query(options.query_uuid);
return (tabIndex.length > 0) ? tabIndex[0] : -1;
}, // getColIndex
- checkbox_html : function (key, value)
- {
+ // create a checkbox <input> tag
+ // computes 'id' attribute from canonical_key (using flat_id)
+ // computes 'init_id' from init_key for initialization phase
+ checkbox_html : function (record) {
var result="";
// Prefix id with plugin_uuid
result += "<input";
result += " class='querytable-checkbox'";
- result += " id='" + this.flat_id(this.id('checkbox', value)) + "'";
- result += " name='" + key + "'";
+ // compute id from canonical_key
+ var id = record[this.canonical_key]
+ // normalize using flat_id - see plugin.js
+ id = this.flat_id(id)
+// if (debug) messages.debug("checkbox_html, id="+id);
+ result += " id='" + id + "'";
+ // compute init_id too
+ var init_id=record[this.init_key];
+ init_id=this.flat_id(init_id);
+ // wrap up
+ result += "init_id='" + init_id + "'";
+ // set value for posting events upon user's clicks
+ result += " value='"+record[this.canonical_key]+"'";
result += " type='checkbox'";
result += " autocomplete='off'";
- result += " value='" + value + "'";
result += "></input>";
return result;
- }, // checkbox
+ },
new_record: function(record)
// catch up with the last column if checkboxes were requested
if (this.options.checkboxes) {
// Use a key instead of hostname (hard coded...)
- line.push(this.checkbox_html(this.key, record[this.key]));
+ line.push(this.checkbox_html(record));
}
// adding an array in one call is *much* more efficient
this.table.fnSetColumnVis(index, false);
},
- set_checkbox: function(record, checked)
- {
- /* Default: checked = true */
+ // this is used at init-time, at which point only init_key can make sense
+ // (because the argument record, if it comes from query, might not have canonical_key set
+ set_checkbox_from_record: function (record, checked) {
if (checked === undefined) checked = true;
-
- var key_value;
- /* The function accepts both records and their key */
- switch (manifold.get_type(record)) {
- case TYPE_VALUE:
- key_value = record;
- break;
- case TYPE_RECORD:
- /* XXX Test the key before ? */
- key_value = record[this.key];
- break;
- default:
- throw "Not implemented";
- break;
- }
-
-
- var checkbox_id = this.flat_id(this.id('checkbox', key_value));
- // function escape_id(myid) is defined in portal/static/js/common.functions.js
- checkbox_id = escape_id(checkbox_id);
- // using dataTables's $ to search also in nodes that are not currently displayed
- var element = this.table.$(checkbox_id);
- if (debug) messages.debug("set_checkbox checked=" + checked + " id=" + checkbox_id + " matches=" + element.length);
- element.attr('checked', checked);
- },
+ var init_id = this.flat_id(record[this.init_key]);
+ if (debug) messages.debug("set_checkbox_from_record, init_id="+init_id);
+ var element = this.table.$('[init_id="'+init_id+'"]');
+ element.attr('checked',checked);
+ },
+
+ // id relates to canonical_key
+ set_checkbox_from_data: function (id, checked) {
+ if (checked === undefined) checked = true;
+ var id=this.flat_id(id);
+ if (debug) messages.debug("set_checkbox_from_data, id="+id);
+ var element = this.table.$('#'+id);
+ element.attr('checked',checked);
+ },
/*************************** QUERY HANDLER ****************************/
on_new_record: function(record)
{
if (this.received_all_query) {
- // if the 'all' query has been dealt with already we may turn on the checkbox
- if (debug) messages.debug("turning on checkbox for record "+record[this.key]);
- this.set_checkbox(record, true);
- } else {
- // otherwise we need to remember that and do it later on
- if (debug) messages.debug("Remembering record to check " + record[this.key]);
+ // if the 'all' query has been dealt with already we may turn on the checkbox
+ this.set_checkbox_from_record(record, true);
+ } else {
+ // otherwise we need to remember that and do it later on
+ if (debug) messages.debug("Remembering record to check " + record[this.init_key]);
this.buffered_records_to_check.push(record);
- }
+ }
},
on_clear_records: function()
switch(data.request) {
case FIELD_REQUEST_ADD:
case FIELD_REQUEST_ADD_RESET:
- this.set_checkbox(data.value, true);
+ this.set_checkbox_from_data(data.value, true);
break;
case FIELD_REQUEST_REMOVE:
case FIELD_REQUEST_REMOVE_RESET:
- this.set_checkbox(data.value, false);
+ this.set_checkbox_from_data(data.value, false);
break;
default:
break;
switch(data.request) {
case FIELD_REQUEST_ADD:
case FIELD_REQUEST_ADD_RESET:
- this.set_checkbox(data.value, true);
+ this.set_checkboxfrom_data(data.value, true);
break;
case FIELD_REQUEST_REMOVE:
case FIELD_REQUEST_REMOVE_RESET:
- this.set_checkbox(data.value, false);
+ this.set_checkbox_from_data(data.value, false);
break;
default:
break;
// checkboxes on the fly at that time (dom not yet created)
$.each(this.buffered_records_to_check, function(i, record) {
if (debug) messages.debug ("delayed turning on checkbox " + i + " record= " + record);
- self.set_checkbox(record, true);
+ self.set_checkbox_from_record(record, true);
});
this.buffered_records_to_check = [];
var self = e.data;
// XXX this.value = key of object to be added... what about multiple keys ?
- if (debug) messages.debug("querytable click handler checked=" + this.checked + " hrn=" + this.value);
+ if (debug) messages.debug("querytable click handler checked=" + this.checked + " "+this.canonical_key+"=" + this.value);
manifold.raise_event(self.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, this.value);
//return false; // prevent checkbox to be checked, waiting response from manifold plugin api