copy of WIP annotations

annotations/romain_infos.md

+ANNOTATIONS
+===========
+
+2016-01
+
+## Routines de manipulation de ngrams dans les listes
+
+#### Trajectoire globale des actions choisies
+
+ 1. angular: ngramlist.js (user input) or highlight.js (user menu controller)
+ 2. angular: http.js configuration object
+    { 'action': 'post', 'listId': miamlist_id, ..}
+ 3. AJAX POST/DELETE
+ 4. "API locale" (=> annotations.views)
+ 5. DB insert/delete
+
+Remarque:
+Dans le code annotations d'Elias, il y a une "API locale" qui transmet les actions client vers le serveur.
+  => l'interconnexion est configurée pour angular dans annotations/static/annotations/app.js qui lance son propre main sur la fenêtre en prenant les paramètres depuis l'url et en s'isolant de django
+  => les routes amont sont définies pour django dans annotations.urls et reprises pour angular dans http.js
+
+
+#### Par ex: l'étape AJAX pour suppression
+
+`curl -XDELETE http://localhost:8000/annotations/lists/7129/ngrams/4497`
+
+via annotations.views.NgramEdit.as_view())
+
+
+#### ajout d'un ngram
+
+
+```
+curl -XPOST http://localhost:8000/annotations/lists/1866/ngrams/create \
+     -H "Content-Type: application/json" \
+     -d '{"text":"yooooooooo"}' > response_to_ngrams_create.html
+```
+
+## Points d'interaction côté client (GUI)
+
+Add Ngram via dialog box :
+ - controller:
+   ngramlist.annotationsAppNgramList.controller('NgramInputController')
+ - effect:
+   1. NgramHttpService.post()
+
+Add Ngram via select new + menu
+ - controller: 
+   highlight.annotationsAppHighlight.controller('TextSelectionMenuController')
+     1. toggleMenu (sets action = X) 
+     2. onMenuClick
+ - effect:
+   1. NgramHttpService[action]

annotations/static/annotations/activelists.js

@@ -24,11 +24,14 @@
         });
       });
 
+      
+      // FIXME: est-ce qu'on ne pourrait pas directement utiliser lists
+      // au lieu  de recopier dans allListsSelect ?
       $rootScope.$watchCollection('lists', function (newValue, oldValue) {
         if (newValue === undefined) return;
         // reformat lists to allListsSelect
         var allListsSelect = [];
-        console.log($rootScope.lists)
+        // console.log($rootScope.lists)
         angular.forEach($rootScope.lists, function(value, key) {
           this.push({
             'id': key,
@@ -45,7 +48,7 @@
 
         $timeout(function() {
           $('.selectpicker').selectpicker();
-          $('.selectpicker').selectpicker('val', ['MAINLIST']);
+          $('.selectpicker').selectpicker('val', ['MAPLIST']);
         });
       });
 

annotations/static/annotations/app.css

@@ -6,14 +6,23 @@
 */
 
 
+.MAPLIST {
+  color: black;
+  /* green */
+  background-color: rgba(60, 118, 61, .7);
+  cursor: pointer;
+}
+
 .MAINLIST {
   color: black;
-  background-color: rgba(60, 118, 61, 0.5);
+  /* background-color: rgba(60, 118, 61, 0.5); */
+  background-color: orange;
   cursor: pointer;
 }
 
 .STOPLIST {
   color: black;
+  /* grey */
   background-color: rgba(169, 68, 66, 0.2);
   cursor: pointer;
 }

annotations/static/annotations/document.js

@@ -8,6 +8,8 @@
 
       // dataLoading = signal pour afficher wait
       $scope.dataLoading = true ;
+      
+      console.log("annotations.document.DocController.DocumentHttpService.get():before")
 
       $rootScope.documentResource = DocumentHttpService.get(
         {'docId': $rootScope.docId},
@@ -21,6 +23,7 @@
           $rootScope.docId = data.id;
           $rootScope.full_text = data.full_text;
           $rootScope.abstract_text = data.abstract_text;
+          console.log("annotations.document.DocController.getannotations")
           // GET the annotationss
           NgramListHttpService.get(
             {

annotations/static/annotations/http.js

@@ -8,7 +8,28 @@
     $httpProvider.defaults.xsrfCookieName = 'csrftoken';
   }]);
   /*
-  * Read Document
+  * DocumentHttpService: Read Document
+  * ===================
+  * 
+  * route: annotations/documents/@d_id
+  * ------
+  * 
+  * exemple:
+  * --------
+  * {
+  *   "id": 556,
+  *   "publication_date": "01/01/66",
+  *   "title": "Megalithic astronomy: Indications in standing stones",
+  *   "abstract_text": "An account is given of a number of surveys of
+  *                   stone circles, alignments, etc., found in Britain.
+  *                   The geometry of the rings is discussed in so far
+  *                   as it affects the determination of the azimuths
+  *                   to outliers and other circles.",
+  *   "full_text": null,
+  *   "journal": "Vistas in Astronomy",
+  *   "authors": "A. Thom"
+  * }
+  * 
   */
   http.factory('DocumentHttpService', function($resource) {
     return $resource(
@@ -26,7 +47,28 @@
   });
 
   /*
-  * Read all Ngrams
+  * NgramListHttpService: Read all Ngrams
+  * =====================
+  * 
+  * route: annotations/corpora/@c_id/documents/@d_id
+  * ------
+  * 
+  * json return format:
+  * -------------------
+  *   corpus_id : {
+  *                lists:   {(list_id:name)+}
+  *                doc_id : [ngrams_objects]+, 
+  *               }
+  * 
+  * exemple:
+  * --------
+  * "554": {
+  *  "lists": { "558": "StopList",  "564": "MiamList",  "565": "MapList" }
+  *  "556": [{ "uuid": 2368, "occurrences": 1.0, "text": "idea", "list_id": 564 },
+  *          { "uuid": 5031, "occurrences": 1.0, "text": "indications", "list_id": 564},
+  *          { "uuid": 5015, "occurrences": 3.0, "text": "star", "list_id": 565 },
+  *           ... ],
+  *   }
   */
   http.factory('NgramListHttpService', function ($resource) {
     return $resource(
@@ -45,7 +87,21 @@
   });
 
   /*
-  * Create, modify or delete 1 Ngram
+  * NgramHttpService: Create, modify or delete 1 Ngram
+  * =================
+  * 
+  * £TODO REACTIVATE IN urls.py
+  * 
+  * if new ngram: 
+  *   -> ngram_id will be "create"
+  *   -> route: annotations/lists/@node_id/ngrams/create
+  *   -> will land on views.NgramCreate
+  * 
+  * else:
+  *   -> ngram_id is a real ngram id
+  *   -> route: annotations/lists/@node_id/ngrams/@ngram_id
+  *   -> will land on views.NgramCreate
+  * 
   */
   http.factory('NgramHttpService', function ($resource) {
     return $resource(

annotations/static/annotations/ngramlist.js

@@ -24,7 +24,13 @@
               'docId': $rootScope.docId
             },
             function(data) {
+              // $rootScope.annotations
+              // ----------------------
+              // is the union of all lists, one being later "active"
+              // (then used for left-side flatlist AND inline annots)
               $rootScope.annotations = data[$rootScope.corpusId.toString()][$rootScope.docId.toString()];
+              // TODO £NEW : lookup obj[list_id][term_text] = {terminfo}
+              // $rootScope.lookup = 
               $rootScope.refreshDisplay();
             },
             function(data) {
@@ -87,7 +93,28 @@
 
       var value = angular.element(inputEltId).val().trim();
       if (value === "") return;
-
+      
+      // £TEST locally check if already in annotations NodeNgrams ------
+      
+      // $rootScope.annotations = array of ngram objects like:
+      // {"list_id":805,"occurrences":2,"uuid":9386,"text":"petit échantillon"}
+      
+      console.log('looking for "' + value + '" in list:' + listId)
+      var already_in_list = false ;
+      angular.forEach($rootScope.annotations, function(annot,i) {
+        // console.log(i + ' => ' + annot.text + ',' + annot.list_id) ;
+        if (value == annot.text && listId == annot.list_id) {
+          console.log('the term "' + value + '" was already present in list')
+          // no creation
+          already_in_list = true ;
+        }
+      }
+      );
+      if (already_in_list) { return ; }
+      // ---------------------------------------------------------------
+      
+      // will check if there's a preexisting ngramId for this value
+      // TODO: if maplist => also add to miam
       NgramHttpService.post(
         {
           'listId': listId,
@@ -97,6 +124,7 @@
           'text': value
         },
         function(data) {
+          console.warn("refresh attempt");
           // on success
           if (data) {
             angular.element(inputEltId).val("");
@@ -108,6 +136,11 @@
               },
               function(data) {
                 $rootScope.annotations = data[$rootScope.corpusId.toString()][$rootScope.docId.toString()];
+              
+                // TODO £NEW : lookup obj[list_id][term_text] = {terminfo}
+                // $rootScope.lookup = 
+                
+                
                 $rootScope.refreshDisplay();
               },
               function(data) {

annotations/templates/annotations/main.html

@@ -55,10 +55,14 @@
                 </div>
               </div>
             </div>
-            <div>
+            <div class="list-selector">
               <h5>Select lists</h5>
               <select class="selectpicker" multiple ng-change="activeListsChange()" ng-model="lists" ng-controller="ActiveListsController">
-                  <option ng-repeat="item in allListsSelect" id="list---{[{item.id}]}" ng-disabled="{[{ item.label == 'MAINLIST' }]}">{[{item.label}]}</option>
+                  
+                  <option ng-repeat="item in allListsSelect" id="list---{[{item.id}]}">{[{item.label}]}</option>
+                  
+                  <!-- to disallow unchecking MapList add this into <option> element:  ng-disabled="{[{ item.label == 'MapList' }]}" -->
+
               </select>
             </div>
           </div>

annotations/urls.py

@@ -10,6 +10,10 @@ urlpatterns = [
     #      publication_date
     #      abstract_text,full_text
     url(r'^documents/(?P<doc_id>[0-9]+)$', views.Document.as_view()), # document view
+    
+    # GET: 
+    #    was : lists ∩ document   (ngram_ids intersection if connected to list node_id and doc node_id)
+    #    fixed 2016-01: just lists (because document doesn't get updated by POST create cf. ngram.lists.DocNgram filter commented)
     url(r'^corpora/(?P<corpus_id>[0-9]+)/documents/(?P<doc_id>[0-9]+)$', views.NgramList.as_view()), # the list associated with an ngram
 
     # 2016-03-24: refactoring, deactivated NgramEdit and NgramCreate

annotations/views.py

@@ -34,33 +34,51 @@ def main(request, project_id, corpus_id, document_id):
     }, context_instance=RequestContext(request))
 
 class NgramList(APIView):
-    """Read and Write Annotations"""
+    """Read the lists of ngrams (terms) that will become annotations"""
     renderer_classes = (JSONRenderer,)
 
     def get(self, request, corpus_id, doc_id):
         """Get All for a doc id"""
         corpus_id = int(corpus_id)
         doc_id = int(doc_id)
+
+        # our results: ngrams for the corpus_id (ignoring doc_id for the moment)
+        doc_ngram_list = []
         lists = {}
-        for list_type in ['MAINLIST']:
+
+        for list_type in ['MAINLIST', 'MAPLIST', 'STOPLIST']:
             corpus_nod = cache.Node[corpus_id]
             list_nod = corpus_nod.children(typename=list_type).first()
             list_id = list_nod.id
             lists["%s" % list_id] = list_type
 
-        # ngrams for the corpus_id (ignoring doc_id for the moment):
-        doc_ngram_list = [(obj.id, obj.terms, w) for (w,obj) in list_nod.ngrams.all()]
+            # add to results
+            doc_ngram_list += [(obj.id, obj.terms, w, list_id) for (w,obj) in list_nod.ngrams.all()]
+
+        print("annotations.views.NgramList.doc_ngram_list: ", doc_ngram_list)
         data = { '%s' % corpus_id : {
-            '%s' % doc_id : [
-                {
-                    'uuid': ngram_id,
-                    'text': ngram_text,
-                    'occurrences': ngram_occurrences,
-                    'list_id': list_id,
-                }
-                for ngram_id, ngram_text, ngram_occurrences in doc_ngram_list],
+            '%s' % doc_id :
+                [
+                    {'uuid': ngram_id,
+                     'text': ngram_text,
+                     'occurrences': ngram_occurrences,
+                     'list_id': list_id,}
+                for (ngram_id,ngram_text,ngram_occurrences,list_id) in doc_ngram_list
+                ],
             'lists': lists
         }}
+
+        # format alternatif de transmission des "annotations", classé par listes puis ngram_id
+        # { 'corpus_id' : {
+        #    list_id_stop: {term_stop1: {term_data}, term_stop2: {term_data}..},
+        #    list_id_miam: {term_miam1: {term_data}, term_miam2: {term_data}..},
+        #    list_id_map:  {term_map1:  {term_data}, term_map2:  {term_data}..},
+        #   }
+        #   'lists' : {"list_id" : "list_type" ... }
+        # }
+
+        # NB 3rd possibility: unicity of ngram_text could also allow us to use it
+        #    as key and could enhance lookup later (frequent checks if term exists)
         return Response(data)