plugins/query_editor/static/js/query_editor.js

   1 /**
   2  * Description: QueryEditor plugin
   3  * Copyright (c) 2012-2013 UPMC Sorbonne Universite
   4  * License: GPLv3
   5  */
   6
   7 // XXX TODO This plugin will be interested in changes in metadata
   8 // What if we remove a filter, is it removed in the right min/max field ???
   9 //  -> no on_filter_removed is not yet implemented
  10 // XXX if a plugin has not declared a handler, it might become inconsistent,
  11 // and the interface should either reset or disable it
  12 (function($){
  13
  14     var QueryEditor = Plugin.extend({
  15
  16         event_filter_added: function(op, suffix) {
  17             suffix = (typeof suffix === 'undefined') ? '' : manifold.separator + suffix;
  18             var self = this;
  19             return function(e, ui) {
  20                 var array = self.array_from_id(e.target.id);
  21                 var key   = self.field_from_id(array); // No need to remove suffix...
  22
  23                 // using autocomplete ui
  24                 if(typeof(ui) != "undefined"){
  25                     var value = ui.item.value;
  26                 }else{
  27                     var value = e.target.value;
  28                 }
  29
  30                 if (value) {
  31                     // XXX This should be handled by manifold
  32                     //manifold.raise_event(object.options.query_uuid, FILTER_UPDATED, [key, op, value]);
  33                     manifold.raise_event(self.options.query_uuid, FILTER_ADDED, [key, op, value]);
  34                 } else {
  35                     // XXX This should be handled by manifold
  36                     manifold.raise_event(self.options.query_uuid, FILTER_REMOVED, [key, op]);
  37                 }
  38             }
  39         },
  40
  41         init: function(options, element) {
  42             this._super(options, element);
  43             this.listen_query(options.query_uuid);
  44
  45             this.elts('queryeditor-auto-filter').change(this.event_filter_added('='));
  46             this.elts('queryeditor-filter').change(this.event_filter_added('='));
  47             this.elts('queryeditor-filter-min').change(this.event_filter_added('>'));
  48             this.elts('queryeditor-filter-max').change(this.event_filter_added('<'));
  49
  50             var self = this;
  51             this.elts('queryeditor-check').click(function() {
  52                 manifold.raise_event(self.options.query_uuid, this.checked?FIELD_ADDED:FIELD_REMOVED, this.value);
  53             });
  54
  55             /* The following code adds an expandable column for the table
  56             // XXX Why isn't it done statically ?
  57             var nCloneTh = document.createElement( 'th' );
  58             var nCloneTd = document.createElement( 'td' );
  59             nCloneTd.innerHTML = "<span class='glyphicon glyphicon-chevron-right' style='cursor:pointer'></span>";
  60             //nCloneTd.innerHTML = '<img src="/components/com_tophat/images/details_open.png">';
  61             nCloneTh.innerHTML = '<b>Info</b>';
  62             nCloneTd.className = "center";
  63             nCloneTh.className = "center";
  64             this.elmt('table thead tr').each(function() {
  65                 this.insertBefore(nCloneTh, this.childNodes[0]);
  66             });
  67             this.elmt('table tbody tr').each(function() {
  68                 this.insertBefore(nCloneTd.cloneNode( true ), this.childNodes[0]);
  69             });
  70             */
  71
  72             // We are currently using a DataTable display, but another browsing component could be better
  73             //jQuery('#'+this.options.plugin_uuid+'-table').dataTable...
  74             var  metaTable = this.elmt('table').dataTable({
  75 // Thierry : I'm turning off all the dataTables options for now, so that
  76 // the table displays more properly again, might need more tuning though
  77 //                bFilter     : false,
  78 //                bPaginate   : false,
  79 //                bInfo       : false,
  80 //                sScrollX    : '100%',         // Horizontal scrolling
  81 //                sScrollY    : '200px',
  82 //                //bJQueryUI   : true,           // Use jQuery UI
  83 //                bProcessing : true,           // Loading
  84 //                aaSorting   : [[ 1, "asc" ]], // sort by column fields on load
  85 //                aoColumnDefs: [
  86 //                    { 'bSortable': false, 'aTargets': [ 0 ]},
  87 //                    { 'sWidth': '8px', 'aTargets': [ 0 ] },
  88 //                    { 'sWidth': '8px', 'aTargets': [ 4 ] } // XXX NB OF COLS
  89 //                ]
  90             });
  91
  92             // Actions on the newly added fields
  93             this.elmt('table tbody td span').on('click', function() {
  94                 var nTr = this.parentNode.parentNode;
  95                 // use jQuery UI instead of images to keep a common UI
  96                 // class="glyphicon glyphicon-chevron-down treeclick tree-minus"
  97                 // East oriented Triangle class="glyphicon-chevron-right"
  98                 // South oriented Triangle class="glyphicon-chevron-down"
  99
 100                 if (this.hasClass("glyphicon-chevron-right")) {
 101                     this.removeClass("glyphicon-chevron-right").addClass("glyphicon-chevron-down");
 102                     // XXX ??????
 103                     metaTable.fnOpen(nTr, this.fnFormatDetails(metaTable, nTr, self.options.plugin_uuid+'_div'), 'details' );
 104                 } else {
 105                     this.removeClass("glyphicon-chevron-down").addClass("glyphicon-chevron-right");
 106                     metaTable.fnClose(nTr);
 107                 }
 108             });
 109
 110             this.elmt('table_wrapper').css({
 111                 'padding-top'   : '0em',
 112                 'padding-bottom': '0em'
 113             });
 114
 115             // autocomplete list of tags
 116             this.availableTags = {};
 117
 118         }, // init
 119
 120         /* UI management */
 121
 122         check_field: function(field)
 123         {
 124             this.elmt('check', field).attr('checked', true);
 125         },
 126
 127         uncheck_field: function(field)
 128         {
 129             this.elmt('check', field).attr('checked', false);
 130         },
 131
 132         update_filter_value: function(filter, removed)
 133         {
 134             removed = !(typeof removed === 'undefined'); // default = False
 135
 136             var key   = filter[0];
 137             var op    = filter[1];
 138             var value = filter[2];
 139
 140             var id = this.id_from_field(key);
 141
 142             if (op == '=') {
 143                 var element = this.elmt(id);
 144             } else {
 145                 var suffix;
 146                 if (op == '<') {
 147                     this.elmt(id, 'max').val(value);
 148                 } else if (op == '>') {
 149                     this.elmt(id, 'min').val(value);
 150                 } else {
 151                     return;
 152                 }
 153                 var element = this.elmt(id, suffix);
 154             }
 155
 156             element.val(removed?null:value);
 157
 158         },
 159
 160         /* Events */
 161
 162         on_filter_added: function(filter)
 163         {
 164             this.update_filter_value(filter);
 165         },
 166
 167         on_filter_removed: function(filter)
 168         {
 169             this.update_filter_value(filter, true);
 170         },
 171
 172         on_field_added: function(field)
 173         {
 174             this.check_field(field);
 175         },
 176
 177         on_field_removed: function(field)
 178         {
 179             this.uncheck_field(field);
 180         },
 181
 182         /* RECORD HANDLERS */
 183         on_query_done: function()
 184         {
 185             //console.log("Query_Editor: query_done!");
 186             //console.log(this.availableTags);
 187         },
 188         on_new_record: function(record)
 189         {
 190             //console.log("Query_Editor: new_record!");
 191             //console.log(record);
 192             availableTags = this.availableTags;
 193             jQuery.each(record,function(key,value){
 194                 value = unfold.get_value(value);
 195                 if(!availableTags.hasOwnProperty(key)){availableTags[key]=new Array();}
 196                 //availableTags[key].push(value);
 197                 var currentArray = availableTags[key];
 198                 if(value!=null){
 199                     if(jQuery.inArray(value,currentArray)==-1){availableTags[key].push(value);}
 200                 }
 201            });
 202            this.availableTags = availableTags;
 203            this.update_autocomplete(availableTags);
 204         },
 205
 206         /* Former code not used at the moment */
 207
 208         print_field_description: function(field_header, div_id)
 209         {
 210             //var selected = all_headers[field_header];
 211             var selected = getMetadata_field('resource',field_header);
 212
 213             field_header = div_id+"_"+field_header;
 214
 215             var output = "<div id='desc"+field_header+"'>";
 216
 217             output += "<div id='divinfo"+field_header+"'>";
 218             output += '<p><span class="column-title">'+selected['title']+'</span></p></span>';
 219             output += '<p><span class="column-detail">'+selected['description']+'</span></p></span>';
 220
 221             var period_select = "<select id='selectperiod"+field_header+"'><option value='Now'> Now </option><option value='latest'> Latest  </option><option value=w> Week </option><option value=m> Month </option><option value=y> Year </option></select>";
 222
 223             if (selected['value_type'] == 'string') {
 224
 225                 var values_select = "<p><select id='selectvalues"+field_header+"' MULTIPLE size=3>";
 226
 227                 output += '<p>Values: ';
 228
 229                 var values_list = selected['allowed_values'].split(",");
 230
 231                 for (var value_index = 0; value_index < values_list.length ; value_index++) {
 232                     var value_desc = values_list[value_index].split("-");
 233                     if (value_index > 0)
 234                         output += ', ';
 235                     output += '<span class="bold">'+value_desc[0]+'</span>';
 236                     values_select += "<option value ='"+value_desc[0]+"'>&nbsp;"+value_desc[0];
 237                     if (value_desc[1]!='')
 238                         output += ' ('+value_desc[1]+')';
 239
 240                     values_select += "&nbsp;</option>";
 241                 }
 242                 values_select += "</select>";
 243             }
 244             else
 245                 output+='<p>Unit: '+selected['unit'];
 246
 247             output+= '</p>';
 248
 249             output += '<p>Source: <a class="source-url" target="source_window" href="'+selected['platform_url']+'">'+selected['platform']+'</a>';
 250
 251             //if (selected['via'] != '')
 252                 //output += ' via <a class="source-url" target="source_window" href="http://'+selected['via_url']+'">'+selected['via']+'</a>';
 253
 254             output += '</p>';
 255             output += "</div>";
 256
 257     /*
 258             output += "<div id='divgroup"+field_header+"'>";
 259             output += "<p>Group resources with the same value <input type=checkbox></input>";
 260             output += "<p>Select aggregator : <select><option>Count</option><option selected=true>Average</option><option>Maximum</option><option>Minimum</option></select>";
 261             output += "</div>";
 262             output += "<div id='divtime"+field_header+"'>";
 263             output += "<p>Select timestamp : ";
 264             output += period_select;
 265             output += "</div>";
 266     */
 267             output += "</div>";
 268
 269             return output;
 270         },
 271
 272         update_autocomplete: function(availableTags)
 273         {
 274             var self = this;
 275             var domid = this.options.plugin_uuid;
 276
 277             jQuery.each(availableTags, function(key, value){
 278                 value.sort();
 279                 jQuery("#"+domid+"__field__"+key).autocomplete({
 280                             source: value,
 281                             selectFirst: true,
 282                             minLength: 0, // allows to browse items with no value typed in
 283                             select: self.event_filter_added('=')
 284                 });
 285             });
 286         }, // update_autocomplete
 287
 288 /*
 289         update_autocomplete: function(e, rows, current_query)
 290         {
 291             var d = data;
 292             d.current_query = current_query;
 293             var availableTags={};
 294             jQuery.each (rows, function(index, obj) {
 295                 jQuery.each(obj,function(key,value){
 296                     value = unfold.get_value(value);
 297                     if(!availableTags.hasOwnProperty(key)){availableTags[key]=new Array();}
 298                     //availableTags[key].push(value);
 299                     var currentArray=availableTags[key];
 300                     if(value!=null){
 301                         if(jQuery.inArray(value,currentArray)==-1){availableTags[key].push(value);}
 302                     }
 303                 });
 304             });
 305             jQuery.each(availableTags, function(key, value){
 306                 value.sort();
 307                 jQuery("#"+options.plugin_uuid+"-filter-"+key).autocomplete({
 308                             source: value,
 309                             selectFirst: true,
 310                             minLength: 0, // allows to browse items with no value typed in
 311                             select: function(event, ui) {
 312                                 var key=getKeySplitId(this.id,"-");
 313                                 var op='=';
 314                                 var val=ui.item.value;
 315
 316                                 query=d.current_query;
 317                                 query.update_filter(key,op,val);
 318                                 // Publish the query changed, the other plugins with subscribe will get the changes
 319                                 jQuery.publish('/query/' + query.uuid + '/changed', query);
 320                                 //add_ActiveFilter(this.id,'=',ui.item.value,d);
 321                             }
 322                 });
 323             });
 324         }, // update_autocomplete
 325 */
 326         fnFormatDetails: function( metaTable, nTr, div_id )
 327         {
 328             var aData = metaTable.fnGetData( nTr );
 329             var sOut = '<blockquote>';
 330             //sOut += prepare_tab_description(aData[1].substr(21, aData[1].length-21-7), div_id);
 331             sOut += this.print_field_description(aData[1].substring(3, aData[1].length-4), div_id);
 332             sOut += '</blockquote>';
 333
 334             return sOut;
 335         }
 336     });
 337
 338     $.plugin('QueryEditor', QueryEditor);
 339
 340 })(jQuery);