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