plugins: added query_editor
[myslice.git] / manifold / js / manifold.js
index 5c43e71..89c83d1 100644 (file)
@@ -32,15 +32,99 @@ var CLEAR_RECORDS  = 8;
 var IN_PROGRESS    = 101;
 var DONE           = 102;
 
+/* Update requests from plugins */
 var SET_ADD        = 201;
 var SET_REMOVED    = 202;
 
+/* Query status */
+var STATUS_NONE               = 500; // Query has not been started yet
+var STATUS_GET_IN_PROGRESS    = 501; // Query has been sent, no result has been received
+var STATUS_GET_RECEIVED       = 502; // Success
+var STATUS_GET_ERROR          = 503; // Error
+var STATUS_UPDATE_PENDING     = 504;
+var STATUS_UPDATE_IN_PROGRESS = 505;
+var STATUS_UPDATE_RECEIVED    = 506;
+var STATUS_UPDATE_ERROR       = 507;
+// outdated ?
+
+// A structure for storing queries
+
+
+
+function QueryExt(query, parent_query, main_query) {
+
+    /* Constructor */
+    if (typeof query == "undefined")
+        throw "Must pass a query in QueryExt constructor";
+    this.query        = query
+    this.parent_query = (typeof parent_query == "undefined") ? false : parent_query
+    this.main_query   = (typeof main_query   == "undefined") ? false : main_query
+    
+    this.status       = null;
+    this.results      = null;
+    this.update_query = null; // null unless we are a main_query (aka parent_query == null); only main_query_fields can be updated...
+}
+
+function QueryStore() {
+
+    this.main_queries     = {};
+    this.analyzed_queries = {};
+
+    /* Insertion */
+
+    this.insert = function(query)
+    {
+        if (query.analyzed_query == null) {
+            query.analyze_subqueries();
+        }
+
+        query_ext = new QueryExt(query, null, null)
+        manifold.query_store.main_queries[query.query_uuid] = query_ext;
+
+        // We also need to insert all queries and subqueries from the analyzed_query
+        query.iter_subqueries(function(sq, data, parent_query) {
+            if (parent_query)
+                parent_query_ext = manifold.query_store.find_analyzed_query_ext(parent_query.query_uuid);
+            else
+                parent_query_ext = null;
+            sq_ext = new QueryExt(sq, parent_query_ext, query_ext)
+            manifold.query_store.analyzed_queries[sq.query_uuid] = sq_ext;
+        });
+    }
+
+    /* Searching */
+
+    this.find_query_ext = function(query_uuid)
+    {
+        return this.main_queries[query_uuid];
+    }
+
+    this.find_query = function(query_uuid)
+    {
+        return this.find_query_ext(query_uuid).query;
+    }
+
+    this.find_analyzed_query_ext = function(query_uuid)
+    {
+        return this.analyzed_queries[query_uuid];
+    }
+
+    this.find_analyzed_query = function(query_uuid)
+    {
+        return this.find_analyzed_query_ext(query_uuid).query;
+    }
+}
+
 /*!
  * This namespace holds functions for globally managing query objects
  * \Class Manifold
  */
 var manifold = {
 
+    /************************************************************************** 
+     * Helper functions
+     **************************************************************************/ 
+
     spin_presets: {},
 
     spin: function(locator, active /*= true */) {
@@ -54,6 +138,14 @@ var manifold = {
         } catch (err) { messages.debug("Cannot turn spins on/off " + err); }
     },
 
+    /************************************************************************** 
+     * Query management
+     **************************************************************************/ 
+
+    query_store: new QueryStore(),
+
+    // XXX Remaining functions are deprecated since they are replaced by the query store
+
     /*!
      * Associative array storing the set of queries active on the page
      * \memberof Manifold
@@ -68,6 +160,10 @@ var manifold = {
      * \param ManifoldQuery query Query to be added
      */
     insert_query : function (query) { 
+        // NEW API
+        manifold.query_store.insert(query);
+
+        // FORMER API
         if (query.analyzed_query == null) {
             query.analyze_subqueries();
         }
@@ -84,6 +180,10 @@ var manifold = {
         return manifold.all_queries[query_uuid];
     },
 
+    /************************************************************************** 
+     * Query execution
+     **************************************************************************/ 
+
     // trigger a query asynchroneously
     proxy_url : '/manifold/proxy/json/',
 
@@ -160,34 +260,6 @@ var manifold = {
         return true;
     },
 
-    raise_event_handler: function(type, query_uuid, event_type, value)
-    {
-        if (type == 'query') {
-            var channels = [ manifold.get_query_channel(query_uuid), manifold.get_query_channel('*') ];
-        } else if (type == 'record') {
-            var channels = [ manifold.get_record_channel(query_uuid), manifold.get_record_channel('*') ];
-
-        } else {
-            throw 'Incorrect type for manifold.raise_event()';
-        }
-        $.each(channels, function(i, channel) {
-            if (value === undefined)
-                $('.plugin').trigger(channel, [event_type]);
-            else
-                $('.plugin').trigger(channel, [event_type, value]);
-        });
-    },
-
-    raise_query_event: function(query_uuid, event_type, value)
-    {
-        manifold.raise_event_handler('query', query_uuid, event_type, value);
-    },
-
-    raise_record_event: function(query_uuid, event_type, value)
-    {
-        manifold.raise_event_handler('record', query_uuid, event_type, value);
-    },
-
     /*!
      * Publish result
      * \fn publish_result(query, results)
@@ -287,11 +359,62 @@ var manifold = {
         }
     },
 
-    raise_event: function(uuid, event_type, value)
+    /************************************************************************** 
+     * Plugin API helpers
+     **************************************************************************/ 
+
+    raise_event_handler: function(type, query_uuid, event_type, value)
+    {
+        if (type == 'query') {
+            var channels = [ manifold.get_query_channel(query_uuid), manifold.get_query_channel('*') ];
+        } else if (type == 'record') {
+            var channels = [ manifold.get_record_channel(query_uuid), manifold.get_record_channel('*') ];
+
+        } else {
+            throw 'Incorrect type for manifold.raise_event()';
+        }
+        $.each(channels, function(i, channel) {
+            if (value === undefined)
+                $('.plugin').trigger(channel, [event_type]);
+            else
+                $('.plugin').trigger(channel, [event_type, value]);
+        });
+    },
+
+    raise_query_event: function(query_uuid, event_type, value)
+    {
+        manifold.raise_event_handler('query', query_uuid, event_type, value);
+    },
+
+    raise_record_event: function(query_uuid, event_type, value)
+    {
+        manifold.raise_event_handler('record', query_uuid, event_type, value);
+    },
+
+
+    raise_event: function(query_uuid, event_type, value)
     {
         switch(event_type) {
             case SET_ADD:
                 // Query uuid has been updated with the key of a new element
+                query_ext    = manifold.query_store.find_analyzed_query(query_uuid);
+
+                // update is only possible is the query is not pending, etc
+                // CHECK status !
+
+                // XXX we can only update subqueries of the main query. Check !
+                // assert query_ext.parent_query == query_ext.main_query
+                update_query = query_ext.parent_query.update_query;
+
+                // NOTE: update might modify the fields in Get
+                // NOTE : we have to modify all child queries
+                // NOTE : parts of a query might not be started (eg slice.measurements, how to handle ?)
+
+                // if everything is done right, update_query should not be null. It is updated when we received results from the get query
+                // object = the same as get
+                // filter = key : update a single object for now
+                // fields = the same as get
+
                 break;
             case SET_REMOVED:
                 // Query uuid has been updated with the key of a removed element