From 265fd105b18cfa17791352c04a8da976b2c4826f Mon Sep 17 00:00:00 2001
From: Thierry Parmentelat <thierry.parmentelat@inria.fr>
Date: Fri, 29 Nov 2013 11:21:23 +0100
Subject: [PATCH] =?utf8?q?querytable=20plugin=E2=80=99s=20internal=20key?=
=?utf8?q?=20passed=20by=20caller=20:=20QueryTable=20(=E2=80=A6=20id=5Fkey?=
=?utf8?q?=3D=E2=80=98hrn=E2=80=99=20)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit
---
plugins/querytable/__init__.py | 40 ++++++++++++++++++----
plugins/querytable/static/js/querytable.js | 23 +++++++------
portal/sliceview.py | 5 +++
3 files changed, 51 insertions(+), 17 deletions(-)
diff --git a/plugins/querytable/__init__.py b/plugins/querytable/__init__.py
index 96456f56..b7b92f44 100644
--- a/plugins/querytable/__init__.py
+++ b/plugins/querytable/__init__.py
@@ -2,13 +2,40 @@ from unfold.plugin import Plugin
class QueryTable (Plugin):
- # set checkboxes if a final column with checkboxes is desired
- # pass columns as the initial set of columns
- # if None then this is taken from the query's fields
- # also please refrain from passing an 'aoColumns' as datatables_options
- # as we use 'aoColumnDefs' instead
+ """A plugin for displaying a query as a list
+
+More accurately, we consider a subject entity (say, a slice)
+that can be linked to any number of related entities (say, resources, or users)
+The 'query' argument will correspond to the subject, while
+'query_all' will fetch the complete list of
+possible candidates for the relationship.
+
+Current implementation makes the following assumptions
+* query will only retrieve for the related items a list of fields
+ that corresponds to the initial set of fields displayed in the table
+* query_all on the contrary is expected to return the complete set of
+ available attributes that may be of interest, so that using a QueryEditor
+ one can easily extend this table without having to query the backend
+* checkboxes is a boolean flag, set to true if a rightmost column
+ with checkboxes is desired
+* optionally pass columns as the initial set of columns
+ if None then this is taken from the query's fields
+* id_key is the name of a column used internally in the plugin
+ for checkboxes management. Caller should specify a column that is present
+ in the fields returned by 'query' and that has unique values.
+ If not specified, metadata will be used to find out a primary key.
+ However in the case of nodes & slice for example, the default key
+ as returned by the metadata would be 'urn', but it is not necessarily
+ a good idea to show urn's initially - if at all.
+ This is why a slice view would use 'hrn' here instead.
+* datatables_options are passed to dataTables as-is;
+ however please refrain from passing an 'aoColumns'
+ as we use 'aoColumnDefs' instead.
+"""
+
def __init__ (self, query=None, query_all=None,
checkboxes=False, columns=None,
+ id_key=None,
datatables_options={}, **settings):
Plugin.__init__ (self, **settings)
self.query = query
@@ -30,6 +57,7 @@ class QueryTable (Plugin):
else:
self.columns = []
self.hidden_columns = []
+ self.id_key=id_key
self.datatables_options=datatables_options
# if checkboxes were required, we tell datatables about this column's type
# so that sorting can take place on a selected-first basis (or -last of course)
@@ -78,4 +106,4 @@ class QueryTable (Plugin):
return ['plugin_uuid', 'domid',
'query_uuid', 'query_all_uuid',
'checkboxes', 'datatables_options',
- 'hidden_columns']
+ 'hidden_columns', 'id_key',]
diff --git a/plugins/querytable/static/js/querytable.js b/plugins/querytable/static/js/querytable.js
index 12232c8e..9d7bced0 100644
--- a/plugins/querytable/static/js/querytable.js
+++ b/plugins/querytable/static/js/querytable.js
@@ -41,17 +41,18 @@
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;
-
- // xxx temporary hack
- // as of nov. 28 2013 we have here this.key='urn', but in any place where
- // the code tries to access record[this.key] the records only have
- // keys=type,hrn,network_hrn,hostname
- // so for now we force using hrn instead
- // as soon as record have their primary key set this line can be removed
- // see also same hack in googlemap
- this.key= (this.key == 'urn') ? 'hrn' : this.key;
+ // xxx beware that this.key needs to contain a key that all records will have
+ // in general query_all will return well populated records, but query
+ // returns records with only the fields displayed on startup.
+ this.key = (this.options.id_key);
+ if (! this.key) {
+ // if not specified by caller, decide from metadata
+ var keys = manifold.metadata.get_key(this.method);
+ this.key = (keys && keys.length == 1) ? keys[0] : null;
+ }
+ if (! this.key) messages.warning("querytable.init could not kind valid key");
+
+ messages.debug("querytable: key="+this.key);
/* Setup query and record handlers */
this.listen_query(options.query_uuid);
diff --git a/portal/sliceview.py b/portal/sliceview.py
index 6c9b46c7..8c6f9fe3 100644
--- a/portal/sliceview.py
+++ b/portal/sliceview.py
@@ -64,6 +64,9 @@ class SliceView (LoginRequiredAutoLogoutView):
'user.user_hrn',
#'application.measurement_point.counter'
)
+ # for internal use in the querytable plugin;
+ # needs to be a unique column present for each returned record
+ main_query_key = 'hrn'
query_resource_all = Query.get('resource').select(resource_fields)
if do_query_users:
@@ -180,6 +183,8 @@ class SliceView (LoginRequiredAutoLogoutView):
# this is the query at the core of the slice list
query = sq_resource,
query_all = query_resource_all,
+ # safer to use 'hrn' as the internal unique key for this plugin
+ id_key = main_query_key,
checkboxes = True,
datatables_options = {
'iDisplayLength': 25,
--
2.47.0