r5365: *** empty log message ***
[umlisp.git] / sql-classes.lisp
1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: umlisp -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
4 ;;;;
5 ;;;; Name:          sql-classes.lisp
6 ;;;; Purpose:       Routines for reading UMLS objects from SQL database
7 ;;;; Author:        Kevin M. Rosenberg
8 ;;;; Date Started:  Apr 2000
9 ;;;;
10 ;;;; $Id: sql-classes.lisp,v 1.90 2003/07/21 11:22:51 kevin Exp $
11 ;;;;
12 ;;;; This file, part of UMLisp, is
13 ;;;;    Copyright (c) 2000-2003 by Kevin M. Rosenberg, M.D.
14 ;;;;
15 ;;;; UMLisp users are granted the rights to distribute and use this software
16 ;;;; as governed by the terms of the GNU General Public License.
17 ;;;; *************************************************************************
18
19 (in-package #:umlisp)
20
21
22 (defvar *current-srl* nil)
23 (defun current-srl ()
24   *current-srl*)
25 (defun current-srl! (srl)
26   (setq *current-srl* srl))
27
28 (defmacro query-string (table fields &optional srl where-name where-value
29                         &key (lrl "KCUILRL") single distinct order like)
30   (let* ((%%fields (format nil "select ~A~{~:@(~A~)~^,~} from ~:@(~A~)"
31                            (if distinct "distinct " "") fields table))
32          (%%order (if order (format nil " order by ~{~:@(~A~) ~(~A~)~^,~}"
33                                     order)
34                       ""))
35          (%%lrl (format nil " and ~:@(~A~)<=" lrl))
36          (%%where (when where-name
37                     (format nil " where ~:@(~A~)~A" where-name
38                           (if like " like " "")))))
39     `(concatenate
40       'string
41       ,%%fields
42       ,@(when %%where (list %%where))
43       ,@(when %%where
44               `((typecase ,where-value
45                   (fixnum
46                    (prefixed-fixnum-string ,where-value #\= 10))
47                   (number
48                    (concatenate 'string "=" (write-to-string ,where-value)))
49                   (null
50                    " is null")
51                   (t
52                    (format nil ,(if like "'%~A%'" "='~A'") ,where-value)))))
53       (if ,srl (concatenate 'string ,%%lrl (write-to-string ,srl)) "")
54       ,@(when %%order (list %%order))
55       ,@(when single (list " limit 1")))))
56
57 (defun query-string-eval (table fields &optional srl where-name where-value
58                           &key (lrl "KCUILRL") single distinct order like)
59   (concatenate
60    'string
61    (format nil "select ~A~{~:@(~A~)~^,~} from ~:@(~A~)" 
62            (if distinct "distinct " "") fields table)
63    (if where-name (format nil " where ~:@(~A~)" where-name) "")
64    (if where-name
65        (format nil
66                (typecase where-value
67                  (number "=~D")
68                  (null " is null")
69                  (t
70                   (if like " like '%~A%""='~A'")))
71                where-value)
72        "")
73    (if srl (format nil " and ~:@(~A~)<=~D" lrl srl) "")
74    (if order (format nil " order by ~{~:@(~A~) ~(~A~)~^,~}" order) "")
75    (if single " limit 1" "")))
76
77
78 (defmacro umlisp-query (table fields srl where-name where-value
79                      &key (lrl "KCUILRL") single distinct order like
80                         (query-cmd 'mutex-sql-query))
81   "Query the UMLisp database. Return a list of umlisp objects whose name
82 is OBJNAME from TABLE where WHERE-NAME field = WHERE-VALUE with FIELDS"
83   `(,query-cmd
84     (query-string ,table ,fields ,srl ,where-name ,where-value 
85      :lrl ,lrl :single ,single :distinct ,distinct :order ,order :like ,like)))
86
87 (defmacro umlisp-query-eval (table fields srl where-name where-value
88                      &key (lrl "KCUILRL") single distinct order like)
89   "Query the UMLisp database. Return a list of umlisp objects whose name
90 is OBJNAME from TABLE where WHERE-NAME field = WHERE-VALUE with FIELDS"
91   `(mutex-sql-query
92     (query-string-eval ,table ,fields ,srl ,where-name ,where-value 
93      :lrl ,lrl :single ,single :distinct ,distinct :order ,order :like ,like)))
94
95 ;; only WHERE-VALUE and SRL are evaluated
96 (defmacro collect-umlisp-query ((table fields srl where-name where-value
97                                     &key (lrl "KCUILRL") distinct single
98                                     order like (query-cmd 'mutex-sql-query))
99                                 &body body)
100   (let ((value (gensym))
101         (r (gensym))) 
102     (if single
103         `(let* ((,value ,where-value)
104                 (tuple (car (umlisp-query ,table ,fields ,srl ,where-name ,value
105                                           :lrl ,lrl :single ,single
106                                           :distinct ,distinct :order ,order
107                                           :like ,like
108                                           :query-cmd ,query-cmd))))
109           ,@(unless where-name `((declare (ignore ,value))))
110           (when tuple
111                 (destructuring-bind ,fields tuple
112                   ,@body)))
113         `(let ((,value ,where-value))
114            ,@(unless where-name `((declare (ignore ,value))))
115            (let ((,r '()))
116              (dolist (tuple (umlisp-query ,table ,fields ,srl ,where-name ,value
117                                           :lrl ,lrl :single ,single :distinct ,distinct
118                                           :order ,order :like ,like))
119                (push (destructuring-bind ,fields tuple ,@body) ,r))
120              (nreverse ,r))
121            #+ignore
122            (loop for tuple in
123                  (umlisp-query ,table ,fields ,srl ,where-name ,value
124                                :lrl ,lrl :single ,single :distinct ,distinct
125                                :order ,order :like ,like)
126                collect (destructuring-bind ,fields tuple ,@body))))))
127
128 (defmacro collect-umlisp-query-eval ((table fields srl where-name where-value
129                                          &key (lrl "KCUILRL") distinct single
130                                          order like)
131                                   &body body)
132   (let ((value (gensym))
133         (r (gensym))
134         (eval-fields (cadr fields)))
135     (if single
136         `(let* ((,value ,where-value)
137                 (tuple (car (umlisp-query-eval ,table ,fields ,srl ,where-name ,value
138                                                :lrl ,lrl :single ,single
139                                                :distinct ,distinct :order ,order
140                                                :like ,like))))
141           (when tuple
142             (destructuring-bind ,eval-fields tuple
143               ,@body)))
144         `(let ((,value ,where-value)
145                (,r '()))
146            (dolist (tuple (umlisp-query-eval ,table ,fields ,srl ,where-name ,value
147                                              :lrl ,lrl :single ,single :distinct ,distinct
148                                              :order ,order :like ,like))
149              (push (destructuring-bind ,eval-fields tuple ,@body) ,r))
150            (nreverse ,r)
151            #+ignore
152            (loop for tuple in
153                  (umlisp-query-eval ,table ,fields ,srl ,where-name ,value
154                                     :lrl ,lrl :single ,single :distinct ,distinct
155                                     :order ,order :like ,like)
156                collect (destructuring-bind ,eval-fields tuple ,@body))))))
157
158 ;;;
159 ;;; Read from SQL database
160
161 (defmacro ensure-cui-integer (cui)
162   `(if (stringp ,cui)
163     (setq ,cui (parse-cui ,cui))
164     ,cui))
165
166 (defmacro ensure-lui-integer (lui)
167   `(if (stringp ,lui)
168     (setq ,lui (parse-lui ,lui))
169     ,lui))
170
171 (defmacro ensure-sui-integer (sui)
172   `(if (stringp ,sui)
173     (setq ,sui (parse-sui ,sui))
174     ,sui))
175
176 (defmacro ensure-tui-integer (tui)
177   `(if (stringp ,tui)
178     (setq ,tui (parse-tui ,tui))
179     ,tui))
180
181 (defmacro ensure-eui-integer (eui)
182   `(if (stringp ,eui)
183     (setq ,eui (parse-eui ,eui))
184     ,eui))
185
186 (defun find-ucon-cui (cui &key (srl *current-srl*))
187   "Find ucon for a cui"
188   (ensure-cui-integer cui)
189   (collect-umlisp-query (mrcon (kpfstr kcuilrl) srl cui cui :single t)
190     (make-instance 'ucon :cui cui :pfstr kpfstr
191                    :lrl (ensure-integer kcuilrl))))
192
193 (defun find-ucon-cui-sans-pfstr (cui &key (srl *current-srl*))
194   "Find ucon for a cui"
195   (ensure-cui-integer cui)
196   (collect-umlisp-query (mrcon (kcuilrl) srl cui cui :single t)
197     (make-instance 'ucon :cui cui :lrl (ensure-integer kcuilrl)
198                    :pfstr nil)))
199
200 (defun find-pfstr-cui (cui &key (srl *current-srl*))
201   "Find preferred string for a cui"
202   (ensure-cui-integer cui)
203   (collect-umlisp-query (mrcon (kpfstr) srl cui cui :single t)
204     kpfstr))
205
206 (defun find-ucon-lui (lui &key (srl *current-srl*))
207   "Find list of ucon for lui"
208   (ensure-lui-integer lui)
209   (collect-umlisp-query (mrcon (cui kpfstr kcuilrl) srl lui lui
210                             :distinct t)
211     (make-instance 'ucon :cui (ensure-integer cui) :pfstr kpfstr
212                    :lrl (ensure-integer kcuilrl))))
213
214 (defun find-ucon-sui (sui &key (srl *current-srl*))
215   "Find list of ucon for sui"
216   (ensure-sui-integer sui)
217   (collect-umlisp-query (mrcon (cui kpfstr kcuilrl) srl sui sui :distinct t)
218     (make-instance 'ucon :cui (ensure-integer cui) :pfstr kpfstr
219                    :lrl (ensure-integer kcuilrl))))
220
221 (defun find-ucon-cuisui (cui sui &key (srl *current-srl*))
222   "Find ucon for cui/sui"
223   (ensure-cui-integer cui)
224   (ensure-sui-integer sui)
225   (when (and cui sui)
226     (collect-umlisp-query (mrcon (kpfstr kcuilrl) srl kcuisui
227                               (make-cuisui cui sui))
228       (make-instance 'ucon :cui cui
229                      :pfstr kpfstr
230                      :lrl (ensure-integer kcuilrl)))))
231
232 (defun find-ucon-str (str &key (srl *current-srl*))
233   "Find ucon that are exact match for str"
234   (collect-umlisp-query (mrcon (cui kpfstr kcuilrl) srl str str :distinct t)
235     (make-instance 'ucon :cui (ensure-integer cui) :pfstr kpfstr
236                    :lrl (ensure-integer kcuilrl))))
237
238 (defun find-ucon-all (&key (srl *current-srl*))
239   "Return list of all ucon's"
240   (with-sql-connection (db)
241     (clsql:map-query 
242      'list
243      #'(lambda (cui pfstr cuilrl)
244          (make-instance 'ucon :cui (ensure-integer cui)
245                         :pfstr pfstr
246                         :lrl (ensure-integer cuilrl)))
247      (query-string mrcon (cui kpfstr kcuilrl) srl nil nil
248                    :order (cui asc) :distinct t)
249      :database db)))
250
251 (defun find-ucon-all2 (&key (srl *current-srl*))
252   "Return list of all ucon's"
253   (collect-umlisp-query (mrcon (cui kpfstr kcuilrl) srl nil nil :order (cui asc)
254                             :distinct t)
255     (make-instance 'ucon :cui (ensure-integer cui)
256                    :pfstr kpfstr
257                    :lrl (ensure-integer kcuilrl))))
258
259 (defun map-ucon-all (fn &key (srl *current-srl*))
260   "Map a function over all ucon's"
261   (with-sql-connection (db)
262     (clsql:map-query 
263      nil
264      #'(lambda (cui pfstr cuilrl)
265          (funcall fn
266                   (make-instance 'ucon :cui (ensure-integer cui)
267                                  :pfstr pfstr
268                                  :lrl (ensure-integer cuilrl))))
269      (query-string mrcon (cui kpfstr kcuilrl) srl nil nil :order (cui asc)
270                    :distinct t)
271      :database db)))
272
273
274 (defun find-udef-cui (cui &key (srl *current-srl*))
275   "Return a list of udefs for cui"
276   (ensure-cui-integer cui)
277   (collect-umlisp-query (mrdef (sab def) srl cui cui :lrl "KSRL")
278     (make-instance 'udef :sab sab :def def)))
279
280 (defun find-usty-cui (cui &key (srl *current-srl*))
281   "Return a list of usty for cui"
282   (ensure-cui-integer cui)
283   (collect-umlisp-query (mrsty (tui sty) srl cui cui :lrl "KLRL")
284     (make-instance 'usty :tui (ensure-integer tui) :sty sty)))
285
286 (defun find-usty-word (word &key (srl *current-srl*))
287   "Return a list of usty that match word"
288   (collect-umlisp-query (mrsty (tui sty) srl sty word :lrl klrl :like t
289                             :distinct t)
290     (make-instance 'usty :tui (ensure-integer tui) :sty sty)))
291
292 (defun find-urel-cui (cui &key (srl *current-srl*))
293   "Return a list of urel for cui"
294   (ensure-cui-integer cui)
295   (collect-umlisp-query (mrrel (rel cui2 rela sab sl mg kpfstr2) srl cui1
296                             cui :lrl "KSRL")
297     (make-instance 'urel :cui1 cui :rel rel
298                    :cui2 (ensure-integer cui2) :rela rela :sab sab :sl sl
299                    :mg mg :pfstr2 kpfstr2)))
300
301 (defun find-urel-cui2 (cui2 &key (srl *current-srl*))
302   "Return a list of urel for cui2"
303   (ensure-cui-integer cui2)
304   (collect-umlisp-query (mrrel (rel cui1 rela sab sl mg kpfstr2) srl cui2
305                             cui2 :lrl "KSRL")
306     (make-instance 'urel :cui2 cui2 :rel rel
307                    :cui1 (ensure-integer cui1) :rela rela :sab sab :sl sl
308                    :mg mg :pfstr2 kpfstr2)))
309
310 (defun find-ucon-rel-cui2 (cui2 &key (srl *current-srl*))
311   (ensure-cui-integer cui2)
312   (loop for cui in (remove-duplicates
313                     (mapcar #'cui1 (find-urel-cui2 cui2 :srl srl)))
314         collect (find-ucon-cui cui :srl srl)))
315
316 (defun find-ucoc-cui (cui &key (srl *current-srl*))
317   "Return a list of ucoc for cui"
318   (ensure-cui-integer cui)
319   (collect-umlisp-query (mrcoc (cui2 soc cot cof coa kpfstr2) srl cui1
320                             cui :lrl klrl :order (cof asc))
321     (setq cui2 (ensure-integer cui2))
322     (when (zerop cui2) (setq cui2 nil))
323     (make-instance 'ucoc :cui1 cui :cui2 (ensure-integer cui2)
324                    :soc soc :cot cot :cof (ensure-integer cof) :coa coa
325                    :pfstr2 kpfstr2)))
326
327 (defun find-ucoc-cui2 (cui2 &key (srl *current-srl*))
328   "Return a list of ucoc for cui2"
329   (ensure-cui-integer cui2)
330   (collect-umlisp-query (mrcoc (cui1 soc cot cof coa kpfstr2) srl cui2
331                             cui2 :lrl klrl :order (cof asc))
332     (when (zerop cui2) (setq cui2 nil))
333     (make-instance 'ucoc :cui1 (ensure-integer cui1) :cui2 cui2
334                    :soc soc :cot cot :cof (ensure-integer cof) :coa coa
335                    :pfstr2 kpfstr2)))
336
337 (defun find-ucon-coc-cui2 (cui2 &key (srl *current-srl*))
338   "List of ucon with co-occurance cui2"
339   (ensure-cui-integer cui2)
340   (mapcar 
341    #'(lambda (cui) (find-ucon-cui cui :srl srl))
342    (remove-duplicates (mapcar #'cui1 (find-ucoc-cui2 cui2 :srl srl)))))
343
344 (defun find-ulo-cui (cui &key (srl *current-srl*))
345   "Return a list of ulo for cui"
346   (ensure-cui-integer cui)
347   (collect-umlisp-query (mrlo (isn fr un sui sna soui) srl cui cui
348                            :lrl "KLRL")
349     (make-instance 'ulo :isn isn :fr (ensure-integer fr) :un un
350                    :sui (ensure-integer sui) :sna sna :soui soui)))
351
352 (defun find-uatx-cui (cui &key (srl *current-srl*))
353   "Return a list of uatx for cui"
354   (ensure-cui-integer cui)
355   (collect-umlisp-query (mratx (sab rel atx) srl cui cui :lrl ksrl)
356     (make-instance 'uatx :sab sab :rel rel :atx atx)))
357
358
359 (defun find-uterm-cui (cui &key (srl *current-srl*))
360   "Return a list of uterm for cui"
361   (ensure-cui-integer cui)
362   (collect-umlisp-query (mrcon (lui lat ts kluilrl) srl cui cui
363                             :lrl kluilrl :distinct t)
364     (make-instance 'uterm :lui (ensure-integer lui) :cui cui
365                    :lat lat :ts ts :lrl (ensure-integer kluilrl))))
366
367 (defun find-uterm-lui (lui &key (srl *current-srl*))
368   "Return a list of uterm for lui"
369   (ensure-lui-integer lui)
370   (collect-umlisp-query (mrcon (cui lat ts kluilrl) srl lui lui 
371                              :lrl kluilrl :distinct t)
372     (make-instance 'uterm :cui (ensure-integer cui) :lui lui
373                    :lat lat :ts ts :lrl (ensure-integer kluilrl))))
374
375 (defun find-uterm-cuilui (cui lui &key (srl *current-srl*))
376   "Return single uterm for cui/lui"
377   (ensure-cui-integer cui)
378   (ensure-lui-integer lui)
379   (collect-umlisp-query (mrcon (lat ts kluilrl) srl kcuilui
380                              (make-cuilui cui lui)
381                              :lrl kluilrl :single t)
382     (make-instance 'uterm :cui cui :lui lui :lat lat :ts ts
383                    :lrl (ensure-integer kluilrl))))
384
385 (defun find-ustr-cuilui (cui lui &key (srl *current-srl*))
386   "Return a list of ustr for cui/lui"
387   (ensure-cui-integer cui)
388   (ensure-lui-integer lui)
389   (collect-umlisp-query (mrcon (sui stt str lrl) srl kcuilui
390                             (make-cuilui cui lui) :lrl lrl)
391     (make-instance 'ustr :sui (ensure-integer sui) :cui cui :lui lui
392                    :cuisui (make-cuisui cui sui) :stt stt :str str
393                    :lrl (ensure-integer lrl))))
394
395 (defun find-ustr-cuisui (cui sui &key (srl *current-srl*))
396   "Return the single ustr for cuisui"
397   (ensure-cui-integer cui)
398   (ensure-sui-integer sui)
399   (collect-umlisp-query (mrcon (lui stt str lrl) srl kcuisui
400                             (make-cuisui cui sui) :lrl lrl :single t)
401     (make-instance 'ustr :sui sui :cui cui :cuisui (make-cuisui cui sui)
402                    :lui (ensure-integer lui) :stt stt :str str
403                    :lrl (ensure-integer lrl))))
404
405 (defun find-ustr-sui (sui &key (srl *current-srl*))
406   "Return the list of ustr for sui"
407   (ensure-sui-integer sui)
408   (collect-umlisp-query (mrcon (cui lui stt str lrl) srl sui sui
409                             :lrl lrl)
410     (make-instance 'ustr :sui sui :cui cui :stt stt :str str
411                    :cuisui (make-cuisui (ensure-integer cui) sui)
412                    :lui (ensure-integer lui) :lrl (ensure-integer lrl))))
413       
414 (defun find-ustr-sab (sab &key (srl *current-srl*))
415   "Return the list of ustr for sab"
416   (collect-umlisp-query (mrso (kcuisui) srl sab sab :lrl srl)
417     (let ((cuisui (ensure-integer kcuisui)))
418       (apply #'find-ustr-cuisui 
419              (append
420               (multiple-value-list (decompose-cuisui cuisui))
421               (list :srl srl))))))
422
423 (defun find-ustr-all (&key (srl *current-srl*))
424   "Return list of all ustr's"
425     (with-sql-connection (db)
426       (clsql:map-query 
427        'list
428        #'(lambda (cui lui sui stt lrl pfstr)
429            (make-instance 'ustr :cui (ensure-integer cui)
430                           :lui (ensure-integer lui) :sui (ensure-integer sui)
431                           :stt stt :str pfstr
432                           :cuisui (make-cuisui (ensure-integer cui)
433                                                (ensure-integer sui))
434                           :lrl (ensure-integer lrl)))
435        (query-string mrcon (cui lui sui stt lrl kpfstr) srl nil nil :lrl lrl
436                      :distinct t
437                      :order (sui asc))
438        :database db)))
439
440 (defun find-string-sui (sui &key (srl *current-srl*))
441   "Return the string associated with sui"
442   (ensure-sui-integer sui)
443   (collect-umlisp-query (mrcon (str) srl sui sui :lrl lrl :single t)
444     str))
445
446 (defun find-uso-cuisui (cui sui &key (srl *current-srl*))
447   (ensure-sui-integer sui)
448   (ensure-cui-integer cui)
449   (collect-umlisp-query (mrso (sab code srl tty) srl kcuisui
450                            (make-cuisui cui sui) :lrl srl)
451       (make-instance 'uso :sab sab :code code :srl srl :tty tty)))
452
453 (defun find-ucxt-cuisui (cui sui &key (srl *current-srl*))
454   (ensure-cui-integer cui)
455   (ensure-sui-integer sui)
456   (collect-umlisp-query (mrcxt (sab code cxn cxl rnk cxs cui2 hcd rela xc)
457                             srl kcuisui (make-cuisui cui sui) :lrl ksrl)
458     (make-instance 'ucxt :sab sab :code code
459                    :cxn (ensure-integer cxn) :cxl cxl :cxs cxs :hcd hcd
460                    :rela rela :xc xc :rnk (ensure-integer rnk)
461                    :cui2 (ensure-integer cui2))))
462
463 (defun find-usat-ui (cui &optional (lui nil) (sui nil) &key (srl *current-srl*))
464   (ensure-cui-integer cui)
465   (ensure-lui-integer lui)
466   (ensure-sui-integer sui)
467   (let ((ls "select CODE,ATN,SAB,ATV from MRSAT where "))
468     (cond
469       (sui (string-append ls "KCUISUI="
470                           (integer-string (make-cuisui cui sui) 14)))
471       (lui (string-append ls "KCUILUI="
472                           (integer-string (make-cuilui cui lui) 14)
473                           " and sui=0"))
474       (t (string-append ls "cui=" (prefixed-fixnum-string cui nil 7)
475                         " and lui=0 and sui=0")))
476     (when srl
477       (string-append ls " and KSRL<=" (prefixed-fixnum-string srl nil 3)))
478     (loop for tuple in (mutex-sql-query ls) collect 
479           (destructuring-bind (code atn sab atv) tuple
480             (make-instance 'usat :code code :atn atn :sab sab :atv atv)))))
481
482 (defun find-usty-tui (tui)
483   "Find usty for tui"
484   (ensure-tui-integer tui)
485   (collect-umlisp-query (mrsty (sty) nil tui tui :single t)
486     (make-instance 'usty :tui tui :sty sty)))
487
488 (defun find-usty-sty (sty)
489   "Find usty for a sty"
490   (collect-umlisp-query (mrsty (tui) nil sty sty :single t)
491     (make-instance 'usty :tui (ensure-integer tui) :sty sty)))
492
493 (defun find-usty-all ()
494   "Return list of usty's for all semantic types"
495   (collect-umlisp-query (mrsty (tui) nil nil nil :distinct t)
496     (find-usty-tui tui)))
497
498 (defun find-usab-all ()
499   "Find usab for a key"
500   (collect-umlisp-query (mrsab (vcui rcui vsab rsab son sf sver mstart mend imeta
501                                   rmeta slc scc srl tfr cfr cxty ttyl atnl lat
502                                   cenc curver sabin) nil nil nil)
503     (make-instance 'usab :vcui (ensure-integer vcui) 
504                    :rcui (ensure-integer rcui) :vsab vsab :rsab rsab :son son
505                    :sf sf :sver sver :mstart mstart :mend mend :imeta imeta
506                    :rmeta rmeta :slc slc :scc scc  :srl (ensure-integer srl)
507                    :tfr (ensure-integer tfr) :cfr (ensure-integer cfr)
508                    :cxty cxty :ttyl ttyl :atnl atnl :lat lat :cenc cenc
509                    :curver curver :sabin sabin)))
510
511 (defun find-usab-by-key (key-name key)
512   "Find usab for a key"
513   (collect-umlisp-query-eval ('mrsab '(vcui rcui vsab rsab son sf sver mstart
514                                     mend imeta rmeta slc scc srl tfr cfr cxty
515                                     ttyl atnl lat cenc curver sabin)
516                                   nil key-name key :single t)
517     (make-instance 'usab :vcui (ensure-integer vcui) 
518                    :rcui (ensure-integer rcui) :vsab vsab :rsab rsab :son son
519                    :sf sf :sver sver :mstart mstart :mend mend :imeta imeta
520                    :rmeta rmeta :slc slc :scc scc :srl (ensure-integer srl)
521                    :tfr (ensure-integer tfr) :cfr (ensure-integer cfr)
522                    :cxty cxty :ttyl ttyl :atnl atnl :lat lat :cenc cenc
523                    :curver curver :sabin sabin)))
524
525 (defun find-usab-rsab (rsab)
526   "Find usab for rsab"
527   (find-usab-by-key 'rsab rsab))
528
529 (defun find-usab-vsab (vsab)
530   "Find usab for vsab"
531   (find-usab-by-key 'vsab vsab))
532
533 (defun find-cui-max ()
534   (ensure-integer (caar (mutex-sql-query "select max(CUI) from MRCON"))))
535
536 ;;;; Cross table find functions
537
538 (defun find-ucon-tui (tui &key (srl *current-srl*))
539   "Find list of ucon for tui"
540   (ensure-tui-integer tui)
541   (collect-umlisp-query (mrsty (cui) srl tui tui :lrl klrl :order (cui asc))
542     (find-ucon-cui (ensure-integer cui) :srl srl)))
543   
544 (defun find-ucon-word (word &key (srl *current-srl*) (like nil))
545   "Return list of ucons that match word. Optionally, use SQL's LIKE syntax"
546   (collect-umlisp-query-eval ('mrxw_eng '(cui) srl 'wd word :like like :distinct t
547                                      :lrl 'klrl :order '(cui asc))
548     (find-ucon-cui cui :srl srl)))
549
550 (defun find-ucon-normalized-word (word &key (srl *current-srl*) (like nil))
551   "Return list of ucons that match word, optionally use SQL's LIKE syntax"
552   (collect-umlisp-query-eval ('mrxnw_eng '(cui) srl 'nwd word :like like :distinct t
553                                       :lrl 'klrl :order '(cui asc))
554     (find-ucon-cui cui :srl srl)))
555
556 (defun find-ustr-word (word &key (srl *current-srl*))
557   "Return list of ustrs that match word"
558   (collect-umlisp-query (mrxw_eng (cui sui) srl wd word :lrl klrl
559                                :order (cui asc sui asc))
560     (find-ustr-cuisui (ensure-integer cui) (ensure-integer sui) :srl srl)))
561
562 (defun find-ustr-normalized-word (word &key (srl *current-srl*))
563   "Return list of ustrs that match word"
564   (collect-umlisp-query (mrxnw_eng (cui sui) srl nwd word :lrl klrl
565                                  :order (cui asc sui asc))
566     (find-ustr-cuisui (ensure-integer cui) (ensure-integer sui) :srl srl)))
567
568 (defun find-uterm-word (word &key (srl *current-srl*))
569   "Return list of uterms that match word"
570   (collect-umlisp-query (mrxw_eng (cui lui) srl wd word :lrl klrl
571                                :order (cui asc lui asc))
572     (find-uterm-cuilui (ensure-integer cui) (ensure-integer lui) :srl srl)))
573
574 (defun find-uterm-normalized-word (word &key (srl *current-srl*))
575   "Return list of uterms that match word"
576   (collect-umlisp-query (mrxnw_eng (cui lui) srl nwd word :lrl klrl
577                                  :order (cui asc lui asc))
578     (find-uterm-cuilui (ensure-integer cui) (ensure-integer lui) :srl srl)))
579
580 (defun find-ucon-noneng-word (word &key (srl *current-srl*) (like nil))
581   "Return list of ucons that match non-english word"
582   (collect-umlisp-query-eval ('mrxw_noneng '(cui) srl 'wd word :like like
583                                         :distinct t :lrl 'klrl :order '(cui asc))
584     (find-ucon-cui cui :srl srl)))
585
586 (defun find-ustr-noneng-word (word &key (srl *current-srl*))
587   "Return list of ustrs that match non-english word"
588   (collect-umlisp-query (mrxw_noneng (cui sui) srl wd word :lrl klrl
589                                   :order (cui asc sui asc))
590     (find-ustr-cuisui (ensure-integer cui) (ensure-integer sui) :srl srl)))
591
592 ;; Special tables
593
594 (defun find-usrl-all ()
595   (collect-umlisp-query (usrl (sab srl) nil nil nil :order (sab asc))
596     (make-instance 'usrl :sab sab :srl (ensure-integer srl))))
597
598 ;;; Multiword lookup and score functions
599
600 (defun find-uobj-multiword (str obj-lookup-fun sort-fun key srl
601                             only-exact-if-match)
602   (let ((uobjs '()))
603     (dolist (word (delimited-string-to-list str #\space))
604       (setq uobjs (append uobjs (funcall obj-lookup-fun word :srl srl))))
605     (let ((sorted 
606            (funcall sort-fun str
607                     (delete-duplicates uobjs :test #'= :key key))))
608       (if (and (plusp (length sorted))
609                only-exact-if-match
610                (multiword-match str (pfstr (first sorted))))
611           (first sorted)
612         sorted))))
613     
614 (defun find-ucon-multiword (str &key (srl *current-srl*)
615                                      (only-exact-if-match t))
616   (find-uobj-multiword str #'find-ucon-word #'sort-score-pfstr-str
617                        #'cui srl only-exact-if-match))
618
619 (defun find-uterm-multiword (str &key (srl *current-srl*)
620                                       (only-exact-if-match t))
621   (find-uobj-multiword str #'find-uterm-word #'sort-score-pfstr-str
622                        #'lui srl only-exact-if-match))
623
624 (defun find-ustr-multiword (str &key (srl *current-srl*)
625                                      (only-exact-if-match t))
626   (find-uobj-multiword str #'find-ustr-word #'sort-score-ustr-str
627                        #'sui srl only-exact-if-match))
628         
629 (defun sort-score-pfstr-str (str uobjs)
630   "Return list of sorted and scored ucons. Score by match of str to ucon-pfstr"
631   (sort-score-umlsclass-str uobjs str #'pfstr))
632
633 (defun sort-score-ustr-str (str ustrs)
634   "Return list of sorted and scored ucons. Score by match of str to ucon-pfstr"
635   (sort-score-umlsclass-str ustrs str #'str))
636
637 (defun sort-score-umlsclass-str (objs str lookup-func)
638   "Sort a list of objects based on scoring to a string"
639   (let ((scored '()))
640     (dolist (obj objs)
641       (push (list obj (score-multiword-match str (funcall lookup-func obj))) 
642        scored))
643     (mapcar #'car (sort scored #'> :key #'cadr))))
644
645
646 ;;; LEX SQL functions
647
648 (defun find-lexterm-eui (eui)
649   (ensure-eui-integer eui)
650   (collect-umlisp-query (lrwd (wrd) nil eui eui :single t)
651     (make-instance 'lexterm :eui eui :wrd wrd)))
652
653 (defun find-lexterm-word (wrd)
654   (collect-umlisp-query (lrwd (eui) nil wrd wrd)
655     (make-instance 'lexterm :eui (ensure-integer eui)
656                    :wrd (copy-seq wrd))))
657
658 ;; LEX SQL Read functions
659
660 (defun find-labr-eui (eui)
661   (ensure-eui-integer eui)
662   (collect-umlisp-query (lrabr (bas abr eui2 bas2) nil eui eui) 
663     (make-instance 'labr :eui eui :bas bas :abr abr :bas2 bas2
664                    :eui2 (ensure-integer eui2))))
665
666 (defun find-labr-bas (bas)
667   (collect-umlisp-query (labr (eui abr eui2 bas2) nil bas bas)
668     (make-instance 'labr :eui (ensure-integer eui) :abr abr :bas2 bas2
669                    :bas (copy-seq bas) :eui2 (ensure-integer eui2))))
670
671 (defun find-lagr-eui (eui)
672   (ensure-eui-integer eui)
673   (collect-umlisp-query (lragr (str sca agr cit bas) nil eui eui)
674     (make-instance 'lagr :eui eui :str str :sca sca :agr agr
675                    :cit cit :bas bas)))
676
677 (defun find-lcmp-eui (eui)
678   (ensure-eui-integer eui)
679   (collect-umlisp-query (lrcmp (bas sca com) nil eui eui)
680     (make-instance 'lcmp :eui eui :bas bas :sca sca :com com)))
681
682 (defun find-lmod-eui (eui)
683   (ensure-eui-integer eui)
684   (collect-umlisp-query (lrmod (bas sca psn_mod fea) nil eui eui)
685     (make-instance 'lmod :eui eui :bas bas :sca sca :psnmod psn_mod :fea fea)))
686
687 (defun find-lnom-eui (eui)
688   (ensure-eui-integer eui)
689   (collect-umlisp-query (lrnom (bas sca eui2 bas2 sca2) nil eui eui)
690     (make-instance 'lnom :eui eui :bas bas :sca sca :bas2 bas2 :sca2 sca2
691                    :eui2 (ensure-integer eui2))))
692
693 (defun find-lprn-eui (eui)
694   (ensure-eui-integer eui)
695   (collect-umlisp-query (lrprn (bas num gnd cas pos qnt fea) nil eui eui)
696     (make-instance 'lprn :eui eui :bas bas :num num :gnd gnd
697                    :cas cas :pos pos :qnt qnt :fea fea)))
698
699 (defun find-lprp-eui (eui)
700   (ensure-eui-integer eui)
701   (collect-umlisp-query (lrprp (bas str sca fea) nil eui eui)
702     (make-instance 'lprp :eui eui :bas bas :str str :sca sca :fea fea)))
703
704 (defun find-lspl-eui (eui)
705   (ensure-eui-integer eui)
706   (collect-umlisp-query (lrspl (spv bas) nil eui eui)
707     (make-instance 'lspl :eui eui :spv spv :bas bas)))
708
709 (defun find-ltrm-eui (eui)
710   (ensure-eui-integer eui)
711   (collect-umlisp-query (lrtrm (bas gen) nil eui eui) 
712     (make-instance 'ltrm :eui eui :bas bas :gen gen)))
713
714 (defun find-ltyp-eui (eui)
715   (ensure-eui-integer eui)
716   (collect-umlisp-query (lrtyp (bas sca typ) nil eui eui)
717     (make-instance 'ltyp :eui eui :bas bas :sca sca :typ typ)))
718
719 (defun find-lwd-wrd (wrd)
720   (make-instance 'lwd :wrd
721                  :euilist (collect-umlisp-query (lrwd (eui) nil wrd wrd)
722                             (ensure-integer eui))))
723
724 ;;; Semantic Network SQL access functions
725
726 (defun find-sdef-ui (ui)
727   (collect-umlisp-query (srdef (rt sty_rl stn_rtn def ex un rh abr rin)
728                             nil ui ui :single t)
729     (make-instance 'sdef :rt rt :ui ui :styrl sty_rl :stnrtn stn_rtn
730                    :def def :ex ex :un un :rh rh :abr abr :rin rin)))
731
732 (defun find-sstre1-ui (ui)
733   (collect-umlisp-query (srstre1 (ui2 ui3) nil ui ui)
734     (make-instance 'sstre1 :ui ui :ui2 (ensure-integer ui2)
735                    :ui3 (ensure-integer ui3))))
736
737 (defun find-sstre1-ui2 (ui2)
738   (collect-umlisp-query (srstre1 (ui ui3) nil ui2 ui2)
739     (make-instance 'sstre1 :ui (ensure-integer ui) :ui2 ui2
740                    :ui3 (ensure-integer ui3))))
741
742 (defun find-sstr-rl (rl)
743   (collect-umlisp-query (srstre (sty_rl sty_rl2 ls) nil rl rl)
744     (make-instance 'sstr :rl rl :styrl sty_rl :styrl2 sty_rl2 :ls ls)))
745
746 (defun find-sstre2-sty (sty)
747   (collect-umlisp-query (srstre2 (rl sty2) nil sty sty)
748     (make-instance 'sstre2 :sty (copy-seq sty) :rl rl :sty2 sty2)))
749
750 (defun find-sstr-styrl (styrl)
751   (collect-umlisp-query (srstr (rl sty_rl2 ls) nil styrl styrl)
752     (make-instance 'sstr :styrl styrl :rl rl :styrl2 sty_rl2 :ls ls)))
753
754
755 ;;; **************************
756 ;;; Local Classes
757 ;;; **************************
758
759
760 (defun make-ustats ()
761   (with-sql-connection (conn)
762     (sql-execute "drop table if exists USTATS" conn)
763     (sql-execute "create table USTATS (NAME varchar(160), COUNT bigint, SRL integer)" conn)
764     
765     (dotimes (srl 4)
766       (insert-ustats-count conn "Concept Count" "MRCON" "distinct CUI" "KCUILRL" srl)
767       (insert-ustats-count conn "Term Count" "MRCON" "distinct KCUILUI" "KCUILRL" srl)
768       (insert-ustats-count conn "Distinct Term Count" "MRCON" "distinct LUI" "KLUILRL" srl)
769       (insert-ustats-count conn "String Count" "MRCON" "*" "LRL" srl)
770       (insert-ustats-count conn "Distinct String Count" "MRCON" "distinct SUI" "LRL" srl)
771       (insert-ustats-count conn "Associated Expression Count" "MRATX" "*" "KSRL" srl)
772       (insert-ustats-count conn "Context Count" "MRCXT" "*" "KSRL" srl)
773       (insert-ustats-count conn "Co-occuring Concept Count" "MRCOC" "*" "KLRL" srl)
774       (insert-ustats-count conn "Definition Count" "MRDEF" "*" "KSRL" srl)
775       (insert-ustats-count conn "Locator Count" "MRLO" "*" "KLRL" srl)
776       (insert-ustats-count conn "Rank Count" "MRRANK" "*" "KSRL" srl)
777       (insert-ustats-count conn "Relationship Count" "MRREL" "*" "KSRL" srl)
778       (insert-ustats-count conn "Semantic Type Count" "MRSTY" "*" "KLRL" srl)
779       (insert-ustats-count conn "Simple Attribute Count" "MRSAT" "*" "KSRL" srl)
780       (insert-ustats-count conn "Source Count" "MRSO" "*" "SRL" srl)
781       (insert-ustats-count conn "Word Index Count" "MRXW_ENG" "*" "KLRL" srl)
782       (insert-ustats-count conn "Normalized Word Index Count" "MRXNW_ENG" "*" "KLRL" srl)
783       (insert-ustats-count conn "Normalized String Index Count" "MRXNS_ENG" "*" "KLRL" srl)
784       (insert-ustats-count conn "Bonus Attribute Name Count" "BONUS_ATN" "*" nil srl)
785       (insert-ustats-count conn "Bonus Relationship Count" "BONUS_REL" "*" nil srl)
786       (insert-ustats-count conn "Bonus Source Abbreviation Count" "BONUS_SAB" "*" nil srl)
787       (insert-ustats-count conn "Bonus Term Type Count" "BONUS_TTY" "*" nil srl))
788     (sql-execute "create index USTATS_SRL on USTATS (SRL)" conn))
789   (find-ustats-all))
790
791 (defun insert-ustats-count (conn name table count-variable srl-control srl)
792   (insert-ustats conn name (find-count-table conn table srl count-variable srl-control) srl))
793
794 (defun find-count-table (conn table srl count-variable srl-control)
795   (cond
796    ((stringp srl-control)
797     (ensure-integer 
798      (caar (sql-query (format nil "select count(~a) from ~a where ~a <= ~d" 
799                               count-variable table srl-control srl)
800                       conn))))
801    ((null srl-control)
802     (ensure-integer
803      (caar (sql-query (format nil "select count(~a) from ~a" 
804                               count-variable table )
805                       conn))))
806    (t
807     (error "Unknown srl-control")
808     0)))
809
810 (defun insert-ustats (conn name count srl)
811   (sql-execute (format nil "insert into USTATS (name,count,srl) values ('~a',~d,~d)" 
812                        name count (if srl srl 3)) 
813                conn))
814
815 (defun find-ustats-all (&key (srl *current-srl*))
816   (collect-umlisp-query (ustats (name count srl) nil srl srl
817                                    :order (name asc))
818    (make-instance 'ustats :name name :hits (ensure-integer count)
819                   :srl (ensure-integer srl))))
820
821 (defun find-ustats-srl (srl)
822   (collect-umlisp-query (ustats (name count) nil srl srl :order (name asc))
823                            (make-instance 'ustats :name name :hits (ensure-integer count))))
824
825
826
827 (defun find-bsab-sab (sab)
828  (collect-umlisp-query (bonus_sab (name count) nil sab sab :single t)
829      (make-instance 'bsab :sab sab :name name :hits (ensure-integer count))))
830
831 (defun find-bsab-all ()
832  (collect-umlisp-query (bonus_sab (sab name count) nil nil nil :order (sab asc))
833      (make-instance 'bsab :sab sab :name name :hits (ensure-integer count))))
834
835 (defun find-btty-tty (tty)
836  (collect-umlisp-query (bonus_tty (name count) nil tty tty :single t)
837      (make-instance 'btty :tty tty :name name :hits (ensure-integer count))))
838
839 (defun find-btty-all ()
840  (collect-umlisp-query (bonus_tty (tty name count) nil nil nil :order (tty asc))
841   (make-instance 'btty :tty tty :name name :hits (ensure-integer count))))
842
843 (defun find-brel-rel (rel)
844   (collect-umlisp-query (bonus_rel (sab sl rel rela count) nil rel rel)
845     (make-instance 'brel :sab sab :sl sl :rel rel :rela rela
846                     :hits (ensure-integer count))))