Merge pull request #320 from Edirom/refactor/getAnnotationInfo

Update getAnnotationInfos.xql
Edirom · Jul 18, 2023 · 97a4a2b · 97a4a2b
2 parents 2fee0a4 + 5fa8b6b
commit 97a4a2b
Showing 1 changed file with 65 additions and 82 deletions.
diff --git a/add/data/xql/getAnnotationInfos.xql b/add/data/xql/getAnnotationInfos.xql
@@ -1,102 +1,85 @@
 xquery version "3.1";
 (:
-  Edirom Online
-  Copyright (C) 2011 The Edirom Project
-  http://www.edirom.de
-
-  Edirom Online is free software: you can redistribute it and/or modify
-  it under the terms of the GNU General Public License as published by
-  the Free Software Foundation, either version 3 of the License, or
-  (at your option) any later version.
-
-  Edirom Online is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-
-  You should have received a copy of the GNU General Public License
-  along with Edirom Online.  If not, see <http://www.gnu.org/licenses/>.
-
-  ID: $Id: getAnnotationInfos.xql 1261 2012-02-28 15:50:45Z daniel $
+For LICENSE-Details please refer to the LICENSE file in the root directory of this repository. 
 :)
 
-
-import module namespace eutil="http://www.edirom.de/xquery/util" at "../xqm/util.xqm";
-import module namespace annotation = "http://www.edirom.de/xquery/annotation" at "../xqm/annotation.xqm";
-
-declare namespace request="http://exist-db.org/xquery/request";
-declare namespace mei="http://www.music-encoding.org/ns/mei";
-declare namespace xlink="http://www.w3.org/1999/xlink";
-declare namespace xmldb="http://exist-db.org/xquery/xmldb";
+declare namespace mei = "http://www.music-encoding.org/ns/mei";
 declare namespace output = "http://www.w3.org/2010/xslt-xquery-serialization";
+declare namespace request = "http://exist-db.org/xquery/request";
 
-declare option output:method "text";
-declare option output:media-type "text/plain";
+import module namespace annotation = "http://www.edirom.de/xquery/annotation" at "../xqm/annotation.xqm";
+import module namespace eutil = "http://www.edirom.de/xquery/util" at "../xqm/util.xqm";
 
+declare option output:method "json";
+declare option output:media-type "application/json";
 
-declare variable $lang := request:get-parameter('lang', '');
+declare variable $uri := request:get-parameter('uri', '');
+declare variable $edition := request:get-parameter('edition', '');
+declare variable $edition_path := eutil:getPreference('edition_path', $edition);
 
+(:~
+ : Returns distinct list of catagories
+ :)
 declare function local:getDistinctCategories($annots as element()*) as xs:string* {
-
-    let $oldCats := distinct-values($annots/mei:ptr[@type="categories"]/replace(@target, '#', ''))
-    let $newCats := distinct-values(for $annot in $annots return tokenize(replace(normalize-space($annot/@class),'#',''),' '))[contains(., 'annotation.category')]
-
-    return distinct-values(($oldCats, $newCats)[string-length() gt 0])
+
+  let $oldCats := distinct-values($annots/mei:ptr[@type = "categories"]/replace(@target, '#', ''))
+  let $newCats := distinct-values(for $annot in $annots
+  return
+    tokenize(replace(normalize-space($annot/@class), '#', ''), ' '))[contains(., 'annotation.category')]
+
+  return
+    distinct-values(($oldCats, $newCats)[string-length() gt 0])
 };
 
+(:~
+ : Returns distinct list of annotation priorities
+ :)
 declare function local:getDistinctPriorities($annots as element()*) as xs:string* {
-
-    distinct-values(
-        for $annot in $annots
-        let $oldLink := $annot/mei:ptr[@type="priority"]/replace(@target, '#', '')
-        let $classes := tokenize(replace(normalize-space($annot/@class),'#',''),' ')
-        let $newLink := $classes[starts-with(.,'ediromAnnotPrio')]
-        return
-            distinct-values(($oldLink, $newLink))[string-length(.) gt 0]
-    )
+  
+  distinct-values(
+  for $annot in $annots
+  let $oldLink := $annot/mei:ptr[@type = "priority"]/replace(@target, '#', '')
+  let $classes := tokenize(replace(normalize-space($annot/@class), '#', ''), ' ')
+  let $newLink := $classes[starts-with(., 'ediromAnnotPrio')]
+  return
+    distinct-values(($oldLink, $newLink))[string-length(.) gt 0]
+  )
 };
 
-let $uri := request:get-parameter('uri', '')
-let $edition := request:get-parameter('edition', '')
 let $mei := doc($uri)/root()
-let $edition_path := eutil:getPreference('edition_path', $edition)
 let $annots := collection($edition_path)//mei:annot[matches(@plist, $uri)] | $mei//mei:annot
-
-let $categories := 
-    for $category in local:getDistinctCategories($annots)
-    let $categoryElement := (collection($edition_path)/id($category)[mei:label or mei:name])[1]
-    let $name := annotation:category_getName($categoryElement, eutil:getLanguage($edition))
-    order by $name
-    return map {
-        'id': $category,
-        'name': $name
-    }
-
-let $prios := 
-    for $priority in local:getDistinctPriorities($annots)
-    let $name := annotation:getPriorityLabel((collection($edition_path)//id($priority)[mei:label or mei:name])[1])
-    order by $name
-    return map {
-        'id': $priority,
-        'name': $name
-    }
-
-let $map := 
-    map { 
-        'categories': array { $categories },
-        'priorities': array { $prios },
-        'count': count($annots)
-    }
-
-let $options :=
-    map {
-        'method': 'json',
-        'media-type': 'text/plain'
-    }
-
-return serialize($map, $options)
-
-(:
+let $categories :=
+for $category in local:getDistinctCategories($annots)
+let $categoryElement := (collection($edition_path)/id($category)[mei:label or mei:name])[1]
+let $name := annotation:category_getName($categoryElement, eutil:getLanguage($edition))
+  order by $name
+return
+  map {
+    'id': $category,
+    'name': $name
+  }
+
+let $prios :=
+for $priority in local:getDistinctPriorities($annots)
+let $name := annotation:getPriorityLabel((collection($edition_path)//id($priority)[mei:label or mei:name])[1])
+  order by $name
+return
+  map {
+    'id': $priority,
+    'name': $name
+  }
+
+let $map :=
+map {
+  'categories': array {$categories},
+  'priorities': array {$prios},
+  'count': count($annots)
+}
+
+return
+  $map
+
+  (:
 
 return concat('{categories: [',
         string-join(