fixed hazelnut checkbox management
[myslice.git] / plugins / hazelnut / hazelnut.js
index 5152bc4..d1a470f 100644 (file)
@@ -1,8 +1,5 @@
 /**
- * MySlice Hazelnut plugin
- * URL: http://trac.myslice.info
  * Description: display a query result in a datatables-powered <table>
- * Author: The MySlice Team
  * Copyright (c) 2012 UPMC Sorbonne Universite - INRIA
  * License: GPLv3
  */
@@ -12,6 +9,10 @@
  * Expression) that maps it to the dollar sign so it can't be overwritten by
  * another library in the scope of its execution.
  */
+
+// TEMP
+var ELEMENT_KEY = 'resource_hrn';
+
 (function($){
 
     var debug=false;
 
     var methods = {
 
+        /**
+         * @brief Plugin initialization
+         * @param options : an associative array of setting values
+         * @return : a jQuery collection of objects on which the plugin is
+         *     applied, which allows to maintain chainability of calls
+         */
         init : function ( options ) {
+
             /* Default settings */
             var options = $.extend( {
                 'checkboxes': false
             }, options);
 
             return this.each(function() {
+
                 var $this = $(this);
-                /* Events */
-                $(this).on('show.Datatables', methods.show);
 
                 /* An object that will hold private variables and methods */
-               var hazelnut = new Hazelnut (options);
-                $(this).data('Hazelnut', hazelnut);
-
-                var query_channel   = '/query/' + options.query_uuid + '/changed';
-                var update_channel  = '/update-set/' + options.query_uuid;
-                var results_channel = '/results/' + options.query_uuid + '/changed';
+                var hazelnut = new Hazelnut (options);
+                $this.data('Hazelnut', hazelnut);
 
-                $.subscribe(query_channel,  function(e, query) { hazelnut.set_query(query); });
-                $.subscribe(update_channel, function(e, resources, instance) { hazelnut.set_resources(resources, instance); });
-                $.subscribe(results_channel, $this, function(e, rows) { hazelnut.update_plugin(e,rows); });
-               if (debug) console.log("hazelnut '" + this.id + "' subscribed to " + query_channel + " " + update_channel + " " + results_channel);
+                /* Events */
+                $this.on('show.Datatables', methods.show);
+
+                // This is the new plugin API meant to replace the weird publish_subscribe mechanism
+                $this.set_query_handler(options.query_uuid, hazelnut.query_handler);
+                $this.set_record_handler(options.query_uuid, hazelnut.record_handler); 
+                $this.set_record_handler(options.query_all_uuid, hazelnut.record_handler_all); 
+
+//                /* Subscriptions */
+//                var query_channel   = '/query/' + options.query_uuid + '/changed';
+//                var update_channel  = '/update-set/' + options.query_uuid;
+//                var results_channel = '/results/' + options.query_uuid + '/changed';
+//
+//                // xxx not tested yet
+//                $.subscribe(query_channel,  function(e, query) { hazelnut.set_query(query); });
+//                // xxx not tested yet
+//                $.subscribe(update_channel, function(e, resources, instance) { hazelnut.set_resources(resources, instance); });
+//                // expected to work
+//                $.subscribe(results_channel, $this, function(e, rows) { hazelnut.update_plugin(e,rows); });
+//                if (debug)
+//                    messages.debug("hazelnut '" + this.id + "' subscribed to e.g." + results_channel);
 
             }); // this.each
         }, // init
 
+        /**
+         * @brief Plugin destruction
+         * @return : a jQuery collection of objects on which the plugin is
+         *     applied, which allows to maintain chainability of calls
+         */
         destroy : function( ) {
+
             return this.each(function() {
                 var $this = $(this);
                 var hazelnut = $this.data('Hazelnut');
         }, // destroy
 
         show : function( ) {
-           var $this=$(this);
-           // xxx wtf. why [1] ? would expect 0...
+            var $this=$(this);
+            // xxx wtf. why [1] ? would expect 0...
+            if (debug)
+                messages.debug("Hitting suspicious line in hazelnut.show");
             var oTable = $($('.dataTable', $this)[1]).dataTable();
             oTable.fnAdjustColumnSizing()
-    
+        
             /* Refresh dataTabeles if click on the menu to display it : fix dataTables 1.9.x Bug */        
             $(this).each(function(i,elt) {
                 if (jQuery(elt).hasClass('dataTables')) {
 
     }; // var methods;
 
-
     /***************************************************************************
      * Hazelnut object
      ***************************************************************************/
-    function Hazelnut(options) {
+
+    function Hazelnut(options) 
+    {
         /* member variables */
         this.options = options;
-        /* constructor */
-        this.table = null;
-       // xxx thierry : init this here - it was not, I expect this relied on set_query somehow..
+
+        // xxx thierry : initialize this here - it was not, I expect this relied on set_query somehow..
         //this.current_query = null;
-       this.current_query=manifold.find_query(this.options.query_uuid);
-       if (debug) console.log("Hazelnut constructor: have set current_query -> " + this.current_query);
-       this.query_update = null;
+        this.current_query=manifold.find_query(this.options.query_uuid);
+        //  if (debug) messages.debug("Hazelnut constructor: have set current_query -> " + this.current_query.__repr());
+        this.query_update = null;
         this.current_resources = Array();
 
+        // query status
+        this.received_all = false;
+        this.received_set = false;
+        this.in_set_buffer = Array();
+
         var object = this;
 
         /* Transforms the table into DataTable, and keep a pointer to it */
-        this.table = $('#hazelnut-' + options.plugin_uuid).dataTable({
+        actual_options = {
             // Customize the position of Datatables elements (length,filter,button,...)
-            // inspired from : 
-            // http://datatables.net/release-datatables/examples/advanced_init/dom_toolbar.html
-            // http://www.datatables.net/forums/discussion/3914/adding-buttons-to-header-or-footer/p1
-            //"sDom": 'lf<"#datatableSelectAll-'+ options.plugin_uuid+'">rtip',
-            sDom: '<"H"Tfr>t<"F"ip>',
-            bJQueryUI: true,
-            sPaginationType: 'full_numbers',
+            // we use a fluid row on top and another on the bottom, making sure we take 12 grid elt's each time
+            sDom: "<'row-fluid'<'span5'l><'span1'r><'span6'f>>t<'row-fluid'<'span5'i><'span7'p>>",
+            sPaginationType: 'bootstrap',
             // Handle the null values & the error : Datatables warning Requested unknown parameter
             // http://datatables.net/forums/discussion/5331/datatables-warning-...-requested-unknown-parameter/p2
             aoColumnDefs: [{sDefaultContent: '',aTargets: [ '_all' ]}],
-            bRetrieve: true,
-            sScrollX: '100%',       /* Horizontal scrolling */
+            // WARNING: this one causes tables in a 'tabs' that are not exposed at the time this is run to show up empty
+            // sScrollX: '100%',       /* Horizontal scrolling */
             bProcessing: true,      /* Loading */
-            fnRowCallback: function( nRow, aData, iDisplayIndex, iDisplayIndexFull ) {
-                $(nRow).attr('id', get_value(aData[3]));
-                return nRow;
-            },
             fnDrawCallback: function() { hazelnut_draw_callback.call(object, options); }
-        });
+        };
+        // the intention here is that options.datatables_options as coming from the python object take precedence
+        //  XXX DISABLED by jordan: was causing errors in datatables.js     $.extend(actual_options, options.datatables_options );
+        this.table = $('#hazelnut-' + options.plugin_uuid).dataTable(actual_options);
 
         /* Setup the SelectAll button in the dataTable header */
+        /* xxx not sure this is still working */
         var oSelectAll = $('#datatableSelectAll-'+ options.plugin_uuid);
         oSelectAll.html("<span class='ui-icon ui-icon-check' style='float:right;display:inline-block;'></span>Select All");
         oSelectAll.button();
         oSelectAll.unbind('click');
         oSelectAll.click(selectAll);
 
-        /* Spinner (could be done when the query is received = a query is in progress, also for update) */
-//        $('#' + options.plugin_uuid).spin()
-
         /* Add a filtering function to the current table 
          * Note: we use closure to get access to the 'options'
          */
 
         /* methods */
 
-        this.set_query = function(query) {
-           if (debug) console.log("entering set_query");
-            var options = this.options;
-            /* Compare current and advertised query to get added and removed fields */
-            previous_query = this.current_query;
-            /* Save the query as the current query */
-            this.current_query = query;
-           if (debug) console.log("set_query, current_query is now -> " + this.current_query);
-            /* We check all necessary fields : in column editor I presume XXX */
-            // XXX ID naming has no plugin_uuid
-            if (typeof(query.fields) != 'undefined') {        
-                $.each (query.fields, function(index, value) { 
-                    if (!$('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked'))
-                        $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked', true);
-                });
-            }
-            /*Process updates in filters / current_query must be updated before this call for filtering ! */
-            this.table.fnDraw();
-
-            /*
-             * Process updates in fields
-             */
-            if (typeof(query.fields) != 'undefined') {     
-                /* DataTable Settings */
-                var oSettings = this.table.dataTable().fnSettings();
-                var cols = oSettings.aoColumns;
-                var colnames = cols.map(function(x) {return x.sTitle});
-                colnames = $.grep(colnames, function(value) {return value != "+/-";});
-
-                if (previous_query == null) {
-                    var added_fields = query.fields;
-                    var removed_fields = colnames;            
-                    removed_fields = $.grep(colnames, function(x) { return $.inArray(x, added_fields) == -1});
-                } else {
-                    var tmp = previous_query.diff_fields(query);
-                    var added_fields = tmp.added;
-                    var removed_fields = tmp.removed;
-                }
-
-                /* Hide/unhide columns to match added/removed fields */
-                var object = this;
-                $.each(added_fields, function (index, field) {            
-                    var index = object.getColIndex(field,cols);
-                    if(index != -1)
-                        object.table.fnSetColumnVis(index, true);
-                });
-                $.each(removed_fields, function (index, field) {
-                    var index = object.getColIndex(field,cols);
-                    if(index != -1)
-                        object.table.fnSetColumnVis(index, false);
-                });            
-            }
-        }
-
-        this.set_resources = function(resources, instance) {
-           if (debug) console.log("entering set_resources");
-            var options = this.options;
-            var previous_resources = this.current_resources;
-            this.current_resources = resources;
-    
-            /* We uncheck all checkboxes ... */
-            $('hazelnut-checkbox-' + options.plugin_uuid).attr('checked', false);
-            /* ... and check the ones specified in the resource list */
-            $.each(this.current_resources, function(index, urn) {
-                $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + urn).attr('checked', true)
-            });
-            
-        }
+// DEPRECATED //        this.set_query = function(query) {
+// DEPRECATED //            messages.info('hazelnut.set_query');
+// DEPRECATED //            var options = this.options;
+// DEPRECATED //            /* Compare current and advertised query to get added and removed fields */
+// DEPRECATED //            previous_query = this.current_query;
+// DEPRECATED //            /* Save the query as the current query */
+// DEPRECATED //            this.current_query = query;
+// DEPRECATED //            if (debug)
+// DEPRECATED //                messages.debug("hazelnut.set_query, current_query is now -> " + this.current_query);
+// DEPRECATED //
+// DEPRECATED //            /* We check all necessary fields : in column editor I presume XXX */
+// DEPRECATED //            // XXX ID naming has no plugin_uuid
+// DEPRECATED //            if (typeof(query.fields) != 'undefined') {        
+// DEPRECATED //                $.each (query.fields, function(index, value) { 
+// DEPRECATED //                    if (!$('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked'))
+// DEPRECATED //                        $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + value).attr('checked', true);
+// DEPRECATED //                });
+// DEPRECATED //            }
+// DEPRECATED //
+// DEPRECATED //            /* Process updates in filters / current_query must be updated before this call for filtering ! */
+// DEPRECATED //            this.table.fnDraw();
+// DEPRECATED //
+// DEPRECATED //            /*
+// DEPRECATED //             * Process updates in fields
+// DEPRECATED //             */
+// DEPRECATED //            if (typeof(query.fields) != 'undefined') {     
+// DEPRECATED //                /* DataTable Settings */
+// DEPRECATED //                var oSettings = this.table.dataTable().fnSettings();
+// DEPRECATED //                var cols = oSettings.aoColumns;
+// DEPRECATED //                var colnames = cols.map(function(x) {return x.sTitle});
+// DEPRECATED //                colnames = $.grep(colnames, function(value) {return value != "+/-";});
+// DEPRECATED //
+// DEPRECATED //                if (previous_query == null) {
+// DEPRECATED //                    var added_fields = query.fields;
+// DEPRECATED //                    var removed_fields = colnames;            
+// DEPRECATED //                    removed_fields = $.grep(colnames, function(x) { return $.inArray(x, added_fields) == -1});
+// DEPRECATED //                } else {
+// DEPRECATED //                    var tmp = previous_query.diff_fields(query);
+// DEPRECATED //                    var added_fields = tmp.added;
+// DEPRECATED //                    var removed_fields = tmp.removed;
+// DEPRECATED //                }
+// DEPRECATED //
+// DEPRECATED //                /* Hide/unhide columns to match added/removed fields */
+// DEPRECATED //                var object = this;
+// DEPRECATED //                $.each(added_fields, function (index, field) {            
+// DEPRECATED //                    var index = object.getColIndex(field,cols);
+// DEPRECATED //                    if(index != -1)
+// DEPRECATED //                        object.table.fnSetColumnVis(index, true);
+// DEPRECATED //                });
+// DEPRECATED //                $.each(removed_fields, function (index, field) {
+// DEPRECATED //                    var index = object.getColIndex(field,cols);
+// DEPRECATED //                    if(index != -1)
+// DEPRECATED //                        object.table.fnSetColumnVis(index, false);
+// DEPRECATED //                });            
+// DEPRECATED //            }
+// DEPRECATED //        }
+
+// DEPRECATED //        this.set_resources = function(resources, instance) {
+// DEPRECATED //            if (debug)
+// DEPRECATED //                messages.debug("entering hazelnut.set_resources");
+// DEPRECATED //            var options = this.options;
+// DEPRECATED //            var previous_resources = this.current_resources;
+// DEPRECATED //            this.current_resources = resources;
+// DEPRECATED //    
+// DEPRECATED //            /* We uncheck all checkboxes ... */
+// DEPRECATED //            $('hazelnut-checkbox-' + options.plugin_uuid).attr('checked', false);
+// DEPRECATED //            /* ... and check the ones specified in the resource list */
+// DEPRECATED //            $.each(this.current_resources, function(index, urn) {
+// DEPRECATED //                $('#hazelnut-checkbox-' + options.plugin_uuid + "-" + urn).attr('checked', true)
+// DEPRECATED //            });
+// DEPRECATED //            
+// DEPRECATED //        }
 
         /**
          * @brief Determine index of key in the table columns 
             return (tabIndex.length > 0) ? tabIndex[0] : -1;
         }
     
-        /**
-         * @brief
-         * XXX will be removed/replaced
-         */
-        this.selected_changed = function(e, change) {
-           if (debug) console.log("entering selected_changed");
-            var actions = change.split("/");
-            if (actions.length > 1) {
-                var oNodes = this.table.fnGetNodes();
-                var myNode = $.grep(oNodes, function(value) {
-                    if (value.id == actions[1]) { return value; }
-                });                
-                if( myNode.length>0 ) {
-                    if ((actions[2]=="add" && actions[0]=="cancel") || actions[0]=="del")
-                        checked='';
-                    else
-                        checked="checked='checked' ";
-                    var newValue = this.checkbox(actions[1], 'node', checked, false);
-                    var columnPos = this.table.fnSettings().aoColumns.length - 1;
-                    this.table.fnUpdate(newValue, myNode[0], columnPos);
-                    this.table.fnDraw();
-                }
-            }
-        }
+// DEPRECATED //        /**
+// DEPRECATED //         * @brief
+// DEPRECATED //         * XXX will be removed/replaced
+// DEPRECATED //         */
+// DEPRECATED //        this.selected_changed = function(e, change) {
+// DEPRECATED //        if (debug) messages.debug("entering hazelnut.selected_changed");
+// DEPRECATED //            var actions = change.split("/");
+// DEPRECATED //            if (actions.length > 1) {
+// DEPRECATED //                var oNodes = this.table.fnGetNodes();
+// DEPRECATED //                var myNode = $.grep(oNodes, function(value) {
+// DEPRECATED //                    if (value.id == actions[1]) { return value; }
+// DEPRECATED //                });                
+// DEPRECATED //                if( myNode.length>0 ) {
+// DEPRECATED //                    if ((actions[2]=="add" && actions[0]=="cancel") || actions[0]=="del")
+// DEPRECATED //                        checked='';
+// DEPRECATED //                    else
+// DEPRECATED //                        checked="checked='checked' ";
+// DEPRECATED //                    var newValue = this.checkbox(actions[1], 'node', checked, false);
+// DEPRECATED //                    var columnPos = this.table.fnSettings().aoColumns.length - 1;
+// DEPRECATED //                    this.table.fnUpdate(newValue, myNode[0], columnPos);
+// DEPRECATED //                    this.table.fnDraw();
+// DEPRECATED //                }
+// DEPRECATED //            }
+// DEPRECATED //        }
     
         this.update_plugin = function(e, rows) {
-           if (debug) console.log("entering update_plugin");
-           // e.data is what we passed in second argument to subscribe
-           // so here it is the jquery object attached to the plugin <div>
-           var $plugindiv=e.data;
-           // clear the spinning wheel: look up an ancestor that has the need-spin class
-           // do this before we might return
-           $plugindiv.closest('.need-spin').spin(false);
+            // e.data is what we passed in second argument to subscribe
+            // so here it is the jquery object attached to the plugin <div>
+            var $plugindiv=e.data;
+            if (debug)
+                messages.debug("entering hazelnut.update_plugin on id '" + $plugindiv.attr('id') + "'");
+            // clear the spinning wheel: look up an ancestor that has the need-spin class
+            // do this before we might return
+            $plugindiv.closest('.need-spin').spin(false);
 
             var options = this.options;
             var hazelnut = this;
     
+            /* if we get no result, or an error, try to make that clear, and exit */
             if (rows.length==0) {
-                this.table.html(errorDisplay("No Result"));   
-                return;
-            } else {
-                if (typeof(rows[0].error) != 'undefined') {
-                    this.table.html(errorDisplay(rows[0].error));
+                if (debug) 
+                    messages.debug("Empty result on hazelnut " + this.options.domid);
+                var placeholder=$(this.table).find("td.dataTables_empty");
+                console.log("placeholder "+placeholder);
+                if (placeholder.length==1) 
+                    placeholder.html(unfold.warning("Empty result"));
+                else
+                    this.table.html(unfold.warning("Empty result"));
                     return;
-                }
+            } else if (typeof(rows[0].error) != 'undefined') {
+                // we now should have another means to report errors that this inline/embedded hack
+                if (debug) 
+                    messages.error ("undefined result on " + this.options.domid + " - should not happen anymore");
+                this.table.html(unfold.error(rows[0].error));
+                return;
             }
-            newlines = new Array();
+
+            /* 
+             * fill the dataTables object
+             * we cannot set html content directly here, need to use fnAddData
+             */
+            var lines = new Array();
     
             this.current_resources = Array();
     
-            $.each(rows, function(index, obj) {
-                newline = new Array();
-    
+            $.each(rows, function(index, row) {
+                // this models a line in dataTables, each element in the line describes a cell
+                line = new Array();
+     
                 // go through table headers to get column names we want
                 // in order (we have temporarily hack some adjustments in names)
-                var cols = hazelnut.table.fnSettings().aoColumns;
+                var cols = object.table.fnSettings().aoColumns;
                 var colnames = cols.map(function(x) {return x.sTitle})
-                var nb_col = colnames.length;
-                if (options.checkboxes)
-                    nb_col -= 1;
+                var nb_col = cols.length;
+                /* if we've requested checkboxes, then forget about the checkbox column for now */
+                if (options.checkboxes) nb_col -= 1;
+
+                /* fill in stuff depending on the column name */
                 for (var j = 0; j < nb_col; j++) {
                     if (typeof colnames[j] == 'undefined') {
-                        newline.push('...');
+                        line.push('...');
                     } else if (colnames[j] == 'hostname') {
-                        if (obj['type'] == 'resource,link')
+                        if (row['type'] == 'resource,link')
                             //TODO: we need to add source/destination for links
-                            newline.push('');
+                            line.push('');
                         else
-                            newline.push(obj['hostname']);
+                            line.push(row['hostname']);
                     } else {
-                        if (obj[colnames[j]])
-                            newline.push(obj[colnames[j]]);
+                        if (row[colnames[j]])
+                            line.push(row[colnames[j]]);
                         else
-                            newline.push('');
+                            line.push('');
                     }
                 }
     
+                /* catch up with the last column if checkboxes were requested */
                 if (options.checkboxes) {
                     var checked = '';
-                    if (typeof(obj['sliver']) != 'undefined') { /* It is equal to null when <sliver/> is present */
+                    // xxx problem is, we don't get this 'sliver' thing set apparently
+                    if (typeof(row['sliver']) != 'undefined') { /* It is equal to null when <sliver/> is present */
                         checked = 'checked ';
-                        hazelnut.current_resources.push(obj['urn']);
+                        hazelnut.current_resources.push(row[ELEMENT_KEY]);
                     }
                     // Use a key instead of hostname (hard coded...)
-                    newline.push(hazelnut.checkbox(options.plugin_uuid, obj['urn'], obj['type'], checked, false));
+                    line.push(hazelnut.checkbox(options.plugin_uuid, row[ELEMENT_KEY], row['type'], checked, false));
                 }
     
-                newlines.push(newline);
-    
+                lines.push(line);
     
             });
     
-//         console.log ("end of each, newlines=" + newlines.length);
-            this.table.fnAddData(newlines);
+            this.table.fnClearTable();
+            if (debug)
+                messages.debug("hazelnut.update_plugin: total of " + lines.length + " rows");
+            this.table.fnAddData(lines);
+        
+        };
+
+        this.checkbox = function (plugin_uuid, header, field, selected_str, disabled_str)
+        {
+            var result="";
+            if (header === null)
+                header = '';
+            // Prefix id with plugin_uuid
+            result += "<input";
+            result += " class='hazelnut-checkbox-" + plugin_uuid + "'";
+            result += " id='hazelnut-checkbox-" + plugin_uuid + "-" + unfold.get_value(header).replace(/\\/g, '')  + "'";
+            result += " name='" + unfold.get_value(field) + "'";
+            result += " type='checkbox'";
+            result += selected_str;
+            result += disabled_str;
+            result += " autocomplete='off'";
+            result += " value='" + unfold.get_value(header) + "'";
+            result += "></input>";
+            return result;
+        };
+
+        ////////////////////////////////////////////////////////////////////////
+        // New plugin API (in tests)
+
+        // TODO : signal empty/non empty table
+
+        this.new_record = function(record)
+        {
+            // this models a line in dataTables, each element in the line describes a cell
+            line = new Array();
+     
+            // go through table headers to get column names we want
+            // in order (we have temporarily hack some adjustments in names)
+            var cols = object.table.fnSettings().aoColumns;
+            var colnames = cols.map(function(x) {return x.sTitle})
+            var nb_col = cols.length;
+            /* if we've requested checkboxes, then forget about the checkbox column for now */
+            if (options.checkboxes) nb_col -= 1;
+
+            /* fill in stuff depending on the column name */
+            for (var j = 0; j < nb_col; j++) {
+                if (typeof colnames[j] == 'undefined') {
+                    line.push('...');
+                } else if (colnames[j] == 'hostname') {
+                    if (record['type'] == 'resource,link')
+                        //TODO: we need to add source/destination for links
+                        line.push('');
+                    else
+                        line.push(record['hostname']);
+                } else {
+                    if (record[colnames[j]])
+                        line.push(record[colnames[j]]);
+                    else
+                        line.push('');
+                }
+            }
     
-//         console.log (" exiting update_plugin = ");
+            /* catch up with the last column if checkboxes were requested */
+            if (options.checkboxes) {
+                var checked = '';
+                // xxx problem is, we don't get this 'sliver' thing set apparently
+                if (typeof(record['sliver']) != 'undefined') { /* It is equal to null when <sliver/> is present */
+                    checked = 'checked ';
+                    hazelnut.current_resources.push(record[ELEMENT_KEY]);
+                }
+                // Use a key instead of hostname (hard coded...)
+                line.push(object.checkbox(options.plugin_uuid, record[ELEMENT_KEY], record['type'], checked, false));
+            }
+    
+            // XXX Is adding an array of lines more efficient ?
+            this.table.fnAddData(line);
+
         };
 
-        this.checkbox = function (plugin_uuid, header, field, selected_str, disabled_str) {
-           var result="";
-            /* Prefix id with plugin_uuid */
-           result += "<input class='hazelnut-checkbox-" + plugin_uuid + "' id='hazelnut-checkbox-" + plugin_uuid + "-" + get_value(header) + "'";
-           result += " name='" + get_value(field) + "' type='checkbox' " + selected_str + disabled_str + " autocomplete='off' value='" + get_value(header) + "'";
-           result +="></input>";
-           return result;
+        this.set_checkbox = function(record)
+        {
+            // XXX urn should be replaced by the key
+            // XXX we should enforce that both queries have the same key !!
+            checkbox_id = "#hazelnut-checkbox-" + object.options.plugin_uuid + "-" + unfold.escape_id(record[ELEMENT_KEY].replace(/\\/g, ''))
+            $(checkbox_id, object.table.fnGetNodes()).attr('checked', true);
+        }
+
+        this.record_handler = function(e, event_type, record)
+        {
+            // elements in set
+            switch(event_type) {
+                case NEW_RECORD:
+                    /* NOTE in fact we are doing a join here */
+                    if (object.received_all)
+                        // update checkbox for record
+                        object.set_checkbox(record);
+                    else
+                        // store for later update of checkboxes
+                        object.in_set_buffer.push(record);
+                    break;
+                case CLEAR_RECORDS:
+                    // nothing to do here
+                    break;
+                case IN_PROGRESS:
+                    manifold.spin($(this));
+                    break;
+                case DONE:
+                    if (object.received_all)
+                        manifold.spin($(this), false);
+                    object.received_set = true;
+                    break;
+            }
         };
+
+        this.record_handler_all = function(e, event_type, record)
+        {
+            // all elements
+            switch(event_type) {
+                case NEW_RECORD:
+                    // Add the record to the table
+                    object.new_record(record);
+                    break;
+                case CLEAR_RECORDS:
+                    object.table.fnClearTable();
+                    break;
+                case IN_PROGRESS:
+                    manifold.spin($(this));
+                    break;
+                case DONE:
+                    if (object.received_set) {
+                        /* XXX needed ? XXX We uncheck all checkboxes ... */
+                        $("[id^='datatables-checkbox-" + object.options.plugin_uuid +"']").attr('checked', false);
+
+                        /* ... and check the ones specified in the resource list */
+                        $.each(object.in_set_buffer, function(i, record) {
+                            object.set_checkbox(record);
+                        });
+
+                        manifold.spin($(this), false);
+                    }
+                    object.received_all = true;
+                    break;
+            }
+        };
+
+        this.query_handler = function(e, event_type, query)
+        {
+            // This replaces the complex set_query function
+            // The plugin does not need to remember the query anymore
+            switch(event_type) {
+                // Filters
+                case FILTER_ADDED:
+                case FILTER_REMOVED:
+                case CLEAR_FILTERS:
+                    // XXX Here we might need to maintain the list of filters !
+                    /* Process updates in filters / current_query must be updated before this call for filtering ! */
+                    object.table.fnDraw();
+                    break;
+
+                // Fields
+                /* Hide/unhide columns to match added/removed fields */
+                case FIELD_ADDED:
+                    var object = this;
+                    $.each(added_fields, function (index, field) {            
+                        var index = object.getColIndex(field,cols);
+                        if(index != -1)
+                            object.table.fnSetColumnVis(index, true);
+                    });
+                    break;
+                case FIELD_REMOVED:
+                    var object = this;
+                    $.each(removed_fields, function (index, field) {
+                        var index = object.getColIndex(field,cols);
+                        if(index != -1)
+                            object.table.fnSetColumnVis(index, false);
+                    });            
+                    break;
+                case CLEAR_FIELDS:
+                    alert('Hazelnut::clear_fields() not implemented');
+                    break;
+            } // switch
+
+
+        }
     } // constructor
 
     /***************************************************************************
      * Private methods
+     * xxx I'm not sure why this should not be methods in the Hazelnut class above
      ***************************************************************************/
 
     /** 
      */
     function hazelnut_filter (oSettings, aData, iDataIndex) {
         var cur_query = this.current_query;
+        if (!cur_query) return true;
         var ret = true;
 
         /* We have an array of filters : a filter is an array (key op val) 
             if (typeof(col) == 'undefined')
                 return;
 
-            col_value=get_value(aData[col]);
+            col_value=unfold.get_value(aData[col]);
             /* Test whether current filter is compatible with the column */
             if (op == '=' || op == '==') {
                 if ( col_value != value || col_value==null || col_value=="" || col_value=="n/a")
     }
 
     function check_click (e) {
+
         var object = e.data.instance;
-        var value = this.value;
+
+        /* The key of the object to be added */
+        // XXX What about multiple keys ?
+        var value = this.value; 
+
+        // NEW PLUGIN API
+        manifold.raise_event(object.options.query_uuid, this.checked?SET_ADD:SET_REMOVED, value);
+        
+        // OLD PLUGIN API BELOW
 
         if (this.checked) {
             object.current_resources.push(value);
         if(filterData.length<=100){
             $.each(filterData, function(index, obj) {
                 var last=$(obj).last();
-                var key_value=get_value(last[0]);
+                var key_value=unfold.get_value(last[0]);
                 if(typeof($(last[0]).attr('checked'))=="undefined"){
                     $.publish('selected', 'add/'+key_value);
                 }