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.83 2003/05/16 08:34:00 kevin Exp $
  11 ;;;;
  12 ;;;; This file, part of UMLisp, is
  13 ;;;;    Copyright (c) 2000-2002 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 (declaim (optimize (compilation-speed 0) (debug 3)))
  21
  22
  23 (defvar *current-srl* nil)
  24 (defun current-srl ()
  25   *current-srl*)
  26 (defun current-srl! (srl)
  27   (setq *current-srl* srl))
  28
  29 (defmacro query-string (table fields &optional srl where-name where-value
  30                         &key (lrl "KCUILRL") single distinct order like)
  31   (let* ((%%fields (format nil "select ~A~{~:@(~A~)~^,~} from ~:@(~A~)"
  32                            (if distinct "distinct " "") fields table))
  33          (%%order (if order (format nil " order by ~{~:@(~A~) ~(~A~)~^,~}"
  34                                     order)
  35                       ""))
  36          (%%lrl (format nil " and ~:@(~A~)<=" lrl))
  37          (%%where (when where-name
  38                     (format nil " where ~:@(~A~)~A" where-name
  39                           (if like " like " "")))))
  40     `(concatenate
  41       'string
  42       ,%%fields
  43       ,@(when %%where (list %%where))
  44       ,@(when %%where
  45               `((typecase ,where-value
  46                   (fixnum
  47                    (prefixed-fixnum-string ,where-value #\= 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 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   `(mutex-sql-query
  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)
  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           ,@(unless where-name `((declare (ignore ,value))))
 109           (when tuple
 110                 (destructuring-bind ,fields tuple
 111                   ,@body)))
 112         `(let ((,value ,where-value))
 113            ,@(unless where-name `((declare (ignore ,value))))
 114            (let ((,r '()))
 115              (dolist (tuple (umlisp-query ,table ,fields ,srl ,where-name ,value
 116                                           :lrl ,lrl :single ,single :distinct ,distinct
 117                                           :order ,order :like ,like))
 118                (push (destructuring-bind ,fields tuple ,@body) ,r))
 119              (nreverse ,r))
 120            #+ignore
 121            (loop for tuple in
 122                  (umlisp-query ,table ,fields ,srl ,where-name ,value
 123                                :lrl ,lrl :single ,single :distinct ,distinct
 124                                :order ,order :like ,like)
 125                collect (destructuring-bind ,fields tuple ,@body))))))
 126
 127 (defmacro collect-umlisp-query-eval ((table fields srl where-name where-value
 128                                          &key (lrl "KCUILRL") distinct single
 129                                          order like)
 130                                   &body body)
 131   (let ((value (gensym))
 132         (r (gensym))
 133         (eval-fields (cadr fields)))
 134     (if single
 135         `(let* ((,value ,where-value)
 136                 (tuple (car (umlisp-query-eval ,table ,fields ,srl ,where-name ,value
 137                                                :lrl ,lrl :single ,single
 138                                                :distinct ,distinct :order ,order
 139                                                :like ,like))))
 140           (when tuple
 141             (destructuring-bind ,eval-fields tuple
 142               ,@body)))
 143         `(let ((,value ,where-value)
 144                (,r '()))
 145            (dolist (tuple (umlisp-query-eval ,table ,fields ,srl ,where-name ,value
 146                                              :lrl ,lrl :single ,single :distinct ,distinct
 147                                              :order ,order :like ,like))
 148              (push (destructuring-bind ,eval-fields tuple ,@body) ,r))
 149            (nreverse ,r)
 150            #+ignore
 151            (loop for tuple in
 152                  (umlisp-query-eval ,table ,fields ,srl ,where-name ,value
 153                                     :lrl ,lrl :single ,single :distinct ,distinct
 154                                     :order ,order :like ,like)
 155                collect (destructuring-bind ,eval-fields tuple ,@body))))))
 156
 157 ;;;
 158 ;;; Read from SQL database
 159
 160 (defmacro ensure-cui-integer (cui)
 161   `(if (stringp ,cui)
 162     (setq ,cui (parse-cui ,cui))
 163     ,cui))
 164
 165 (defmacro ensure-lui-integer (lui)
 166   `(if (stringp ,lui)
 167     (setq ,lui (parse-lui ,lui))
 168     ,lui))
 169
 170 (defmacro ensure-sui-integer (sui)
 171   `(if (stringp ,sui)
 172     (setq ,sui (parse-sui ,sui))
 173     ,sui))
 174
 175 (defmacro ensure-tui-integer (tui)
 176   `(if (stringp ,tui)
 177     (setq ,tui (parse-tui ,tui))
 178     ,tui))
 179
 180 (defmacro ensure-eui-integer (eui)
 181   `(if (stringp ,eui)
 182     (setq ,eui (parse-eui ,eui))
 183     ,eui))
 184
 185 (defun find-ucon-cui (cui &key (srl *current-srl*))
 186   "Find ucon for a cui"
 187   (ensure-cui-integer cui)
 188   (collect-umlisp-query (mrcon (kpfstr kcuilrl) srl cui cui :single t)
 189     (make-instance 'ucon :cui cui :pfstr kpfstr
 190                    :lrl (ensure-integer kcuilrl))))
 191
 192 (defun find-ucon-cui-sans-pfstr (cui &key (srl *current-srl*))
 193   "Find ucon for a cui"
 194   (ensure-cui-integer cui)
 195   (collect-umlisp-query (mrcon (kcuilrl) srl cui cui :single t)
 196     (make-instance 'ucon :cui cui :lrl (ensure-integer kcuilrl)
 197                    :pfstr nil)))
 198
 199 (defun find-pfstr-cui (cui &key (srl *current-srl*))
 200   "Find preferred string for a cui"
 201   (ensure-cui-integer cui)
 202   (collect-umlisp-query (mrcon (kpfstr) srl cui cui :single t)
 203     kpfstr))
 204
 205 (defun find-ucon-lui (lui &key (srl *current-srl*))
 206   "Find list of ucon for lui"
 207   (ensure-lui-integer lui)
 208   (collect-umlisp-query (mrcon (cui kpfstr kcuilrl) srl lui lui
 209                             :distinct t)
 210     (make-instance 'ucon :cui (ensure-integer cui) :pfstr kpfstr
 211                    :lrl (ensure-integer kcuilrl))))
 212
 213 (defun find-ucon-sui (sui &key (srl *current-srl*))
 214   "Find list of ucon for sui"
 215   (ensure-sui-integer sui)
 216   (collect-umlisp-query (mrcon (cui kpfstr kcuilrl) srl sui sui :distinct t)
 217     (make-instance 'ucon :cui (ensure-integer cui) :pfstr kpfstr
 218                    :lrl (ensure-integer kcuilrl))))
 219
 220 (defun find-ucon-cuisui (cui sui &key (srl *current-srl*))
 221   "Find ucon for cui/sui"
 222   (ensure-cui-integer cui)
 223   (ensure-sui-integer sui)
 224   (when (and cui sui)
 225     (collect-umlisp-query (mrcon (kpfstr kcuilrl) srl kcuisui
 226                               (make-cuisui cui sui))
 227       (make-instance 'ucon :cui cui
 228                      :pfstr kpfstr
 229                      :lrl (ensure-integer kcuilrl)))))
 230
 231 (defun find-ucon-str (str &key (srl *current-srl*))
 232   "Find ucon that are exact match for str"
 233   (collect-umlisp-query (mrcon (cui kpfstr kcuilrl) srl str str :distinct t)
 234     (make-instance 'ucon :cui (ensure-integer cui) :pfstr kpfstr
 235                    :lrl (ensure-integer kcuilrl))))
 236
 237 (defun find-ucon-all (&key (srl *current-srl*))
 238   "Return list of all ucon's"
 239   (with-sql-connection (db)
 240     (clsql:map-query
 241      'list
 242      #'(lambda (cui pfstr cuilrl)
 243          (make-instance 'ucon :cui (ensure-integer cui)
 244                         :pfstr pfstr
 245                         :lrl (ensure-integer cuilrl)))
 246      (query-string mrcon (cui kpfstr kcuilrl) srl nil nil
 247                    :order (cui asc) :distinct t)
 248      :database db)))
 249
 250 (defun find-ucon-all2 (&key (srl *current-srl*))
 251   "Return list of all ucon's"
 252   (collect-umlisp-query (mrcon (cui kpfstr kcuilrl) srl nil nil :order (cui asc)
 253                             :distinct t)
 254     (make-instance 'ucon :cui (ensure-integer cui)
 255                    :pfstr kpfstr
 256                    :lrl (ensure-integer kcuilrl))))
 257
 258 (defun map-ucon-all (fn &key (srl *current-srl*))
 259   "Map a function over all ucon's"
 260   (with-sql-connection (db)
 261     (clsql:map-query
 262      nil
 263      #'(lambda (cui pfstr cuilrl)
 264          (funcall fn
 265                   (make-instance 'ucon :cui (ensure-integer cui)
 266                                  :pfstr pfstr
 267                                  :lrl (ensure-integer cuilrl))))
 268      (query-string mrcon (cui kpfstr kcuilrl) srl nil nil :order (cui asc)
 269                    :distinct t)
 270      :database db)))
 271
 272
 273 (defun find-udef-cui (cui &key (srl *current-srl*))
 274   "Return a list of udefs for cui"
 275   (ensure-cui-integer cui)
 276   (collect-umlisp-query (mrdef (sab def) srl cui cui :lrl "KSRL")
 277     (make-instance 'udef :sab sab :def def)))
 278
 279 (defun find-usty-cui (cui &key (srl *current-srl*))
 280   "Return a list of usty for cui"
 281   (ensure-cui-integer cui)
 282   (collect-umlisp-query (mrsty (tui sty) srl cui cui :lrl "KLRL")
 283     (make-instance 'usty :tui (ensure-integer tui) :sty sty)))
 284
 285 (defun find-usty-word (word &key (srl *current-srl*))
 286   "Return a list of usty that match word"
 287   (collect-umlisp-query (mrsty (tui sty) srl sty word :lrl klrl :like t
 288                             :distinct t)
 289     (make-instance 'usty :tui (ensure-integer tui) :sty sty)))
 290
 291 (defun find-urel-cui (cui &key (srl *current-srl*))
 292   "Return a list of urel for cui"
 293   (ensure-cui-integer cui)
 294   (collect-umlisp-query (mrrel (rel cui2 rela sab sl mg kpfstr2) srl cui1
 295                             cui :lrl "KSRL")
 296     (make-instance 'urel :cui1 cui :rel rel
 297                    :cui2 (ensure-integer cui2) :rela rela :sab sab :sl sl
 298                    :mg mg :pfstr2 kpfstr2)))
 299
 300 (defun find-urel-cui2 (cui2 &key (srl *current-srl*))
 301   "Return a list of urel for cui2"
 302   (ensure-cui-integer cui2)
 303   (collect-umlisp-query (mrrel (rel cui1 rela sab sl mg kpfstr2) srl cui2
 304                             cui2 :lrl "KSRL")
 305     (make-instance 'urel :cui2 cui2 :rel rel
 306                    :cui1 (ensure-integer cui1) :rela rela :sab sab :sl sl
 307                    :mg mg :pfstr2 kpfstr2)))
 308
 309 (defun find-ucon-rel-cui2 (cui2 &key (srl *current-srl*))
 310   (ensure-cui-integer cui2)
 311   (loop for cui in (remove-duplicates
 312                     (mapcar #'cui1 (find-urel-cui2 cui2 :srl srl)))
 313         collect (find-ucon-cui cui :srl srl)))
 314
 315 (defun find-ucoc-cui (cui &key (srl *current-srl*))
 316   "Return a list of ucoc for cui"
 317   (ensure-cui-integer cui)
 318   (collect-umlisp-query (mrcoc (cui2 soc cot cof coa kpfstr2) srl cui1
 319                             cui :lrl klrl :order (cof asc))
 320     (setq cui2 (ensure-integer cui2))
 321     (when (zerop cui2) (setq cui2 nil))
 322     (make-instance 'ucoc :cui1 cui :cui2 (ensure-integer cui2)
 323                    :soc soc :cot cot :cof (ensure-integer cof) :coa coa
 324                    :pfstr2 kpfstr2)))
 325
 326 (defun find-ucoc-cui2 (cui2 &key (srl *current-srl*))
 327   "Return a list of ucoc for cui2"
 328   (ensure-cui-integer cui2)
 329   (collect-umlisp-query (mrcoc (cui1 soc cot cof coa kpfstr2) srl cui2
 330                             cui2 :lrl klrl :order (cof asc))
 331     (when (zerop cui2) (setq cui2 nil))
 332     (make-instance 'ucoc :cui1 (ensure-integer cui1) :cui2 cui2
 333                    :soc soc :cot cot :cof (ensure-integer cof) :coa coa
 334                    :pfstr2 kpfstr2)))
 335
 336 (defun find-ucon-coc-cui2 (cui2 &key (srl *current-srl*))
 337   "List of ucon with co-occurance cui2"
 338   (ensure-cui-integer cui2)
 339   (mapcar
 340    #'(lambda (cui) (find-ucon-cui cui :srl srl))
 341    (remove-duplicates (mapcar #'cui1 (find-ucoc-cui2 cui2 :srl srl)))))
 342
 343 (defun find-ulo-cui (cui &key (srl *current-srl*))
 344   "Return a list of ulo for cui"
 345   (ensure-cui-integer cui)
 346   (collect-umlisp-query (mrlo (isn fr un sui sna soui) srl cui cui
 347                            :lrl "KLRL")
 348     (make-instance 'ulo :isn isn :fr (ensure-integer fr) :un un
 349                    :sui (ensure-integer sui) :sna sna :soui soui)))
 350
 351 (defun find-uatx-cui (cui &key (srl *current-srl*))
 352   "Return a list of uatx for cui"
 353   (ensure-cui-integer cui)
 354   (collect-umlisp-query (mratx (sab rel atx) srl cui cui :lrl ksrl)
 355     (make-instance 'uatx :sab sab :rel rel :atx atx)))
 356
 357
 358 (defun find-uterm-cui (cui &key (srl *current-srl*))
 359   "Return a list of uterm for cui"
 360   (ensure-cui-integer cui)
 361   (collect-umlisp-query (mrcon (lui lat ts kluilrl) srl cui cui
 362                             :lrl kluilrl :distinct t)
 363     (make-instance 'uterm :lui (ensure-integer lui) :cui cui
 364                    :lat lat :ts ts :lrl (ensure-integer kluilrl))))
 365
 366 (defun find-uterm-lui (lui &key (srl *current-srl*))
 367   "Return a list of uterm for lui"
 368   (ensure-lui-integer lui)
 369   (collect-umlisp-query (mrcon (cui lat ts kluilrl) srl lui lui
 370                              :lrl kluilrl :distinct t)
 371     (make-instance 'uterm :cui (ensure-integer cui) :lui lui
 372                    :lat lat :ts ts :lrl (ensure-integer kluilrl))))
 373
 374 (defun find-uterm-cuilui (cui lui &key (srl *current-srl*))
 375   "Return single uterm for cui/lui"
 376   (ensure-cui-integer cui)
 377   (ensure-lui-integer lui)
 378   (collect-umlisp-query (mrcon (lat ts kluilrl) srl kcuilui
 379                              (make-cuilui cui lui)
 380                              :lrl kluilrl :single t)
 381     (make-instance 'uterm :cui cui :lui lui :lat lat :ts ts
 382                    :lrl (ensure-integer kluilrl))))
 383
 384 (defun find-ustr-cuilui (cui lui &key (srl *current-srl*))
 385   "Return a list of ustr for cui/lui"
 386   (ensure-cui-integer cui)
 387   (ensure-lui-integer lui)
 388   (collect-umlisp-query (mrcon (sui stt str lrl) srl kcuilui
 389                             (make-cuilui cui lui) :lrl lrl)
 390     (make-instance 'ustr :sui (ensure-integer sui) :cui cui :lui lui
 391                    :cuisui (make-cuisui cui sui) :stt stt :str str
 392                    :lrl (ensure-integer lrl))))
 393
 394 (defun find-ustr-cuisui (cui sui &key (srl *current-srl*))
 395   "Return the single ustr for cuisui"
 396   (ensure-cui-integer cui)
 397   (ensure-sui-integer sui)
 398   (collect-umlisp-query (mrcon (lui stt str lrl) srl kcuisui
 399                             (make-cuisui cui sui) :lrl lrl :single t)
 400     (make-instance 'ustr :sui sui :cui cui :cuisui (make-cuisui cui sui)
 401                    :lui (ensure-integer lui) :stt stt :str str
 402                    :lrl (ensure-integer lrl))))
 403
 404 (defun find-ustr-sui (sui &key (srl *current-srl*))
 405   "Return the list of ustr for sui"
 406   (ensure-sui-integer sui)
 407   (collect-umlisp-query (mrcon (cui lui stt str lrl) srl sui sui
 408                             :lrl lrl)
 409     (make-instance 'ustr :sui sui :cui cui :stt stt :str str
 410                    :cuisui (make-cuisui (ensure-integer cui) sui)
 411                    :lui (ensure-integer lui) :lrl (ensure-integer lrl))))
 412
 413 (defun find-ustr-sab (sab &key (srl *current-srl*))
 414   "Return the list of ustr for sab"
 415   (collect-umlisp-query (mrso (kcuisui) srl sab sab :lrl srl)
 416     (let ((cuisui (ensure-integer kcuisui)))
 417       (apply #'find-ustr-cuisui
 418              (append
 419               (multiple-value-list (decompose-cuisui cuisui))
 420               (list :srl srl))))))
 421
 422 (defun find-ustr-all (&key (srl *current-srl*))
 423   "Return list of all ustr's"
 424     (with-sql-connection (db)
 425       (clsql:map-query
 426        'list
 427        #'(lambda (cui lui sui stt lrl pfstr)
 428            (make-instance 'ustr :cui (ensure-integer cui)
 429                           :lui (ensure-integer lui) :sui (ensure-integer sui)
 430                           :stt stt :str pfstr
 431                           :cuisui (make-cuisui (ensure-integer cui)
 432                                                (ensure-integer sui))
 433                           :lrl (ensure-integer lrl)))
 434        (query-string mrcon (cui lui sui stt lrl kpfstr) srl nil nil :lrl lrl
 435                      :distinct t
 436                      :order (sui asc))
 437        :database db)))
 438
 439 (defun find-string-sui (sui &key (srl *current-srl*))
 440   "Return the string associated with sui"
 441   (ensure-sui-integer sui)
 442   (collect-umlisp-query (mrcon (str) srl sui sui :lrl lrl :single t)
 443     str))
 444
 445 (defun find-uso-cuisui (cui sui &key (srl *current-srl*))
 446   (ensure-sui-integer sui)
 447   (ensure-cui-integer cui)
 448   (collect-umlisp-query (mrso (sab code srl tty) srl kcuisui
 449                            (make-cuisui cui sui) :lrl srl)
 450       (make-instance 'uso :sab sab :code code :srl srl :tty tty)))
 451
 452 (defun find-ucxt-cuisui (cui sui &key (srl *current-srl*))
 453   (ensure-cui-integer cui)
 454   (ensure-sui-integer sui)
 455   (collect-umlisp-query (mrcxt (sab code cxn cxl rnk cxs cui2 hcd rela xc)
 456                             srl kcuisui (make-cuisui cui sui) :lrl ksrl)
 457     (make-instance 'ucxt :sab sab :code code
 458                    :cxn (ensure-integer cxn) :cxl cxl :cxs cxs :hcd hcd
 459                    :rela rela :xc xc :rnk (ensure-integer rnk)
 460                    :cui2 (ensure-integer cui2))))
 461
 462 (defun find-usat-ui (cui &optional (lui nil) (sui nil) &key (srl *current-srl*))
 463   (ensure-cui-integer cui)
 464   (ensure-lui-integer lui)
 465   (ensure-sui-integer sui)
 466   (let ((ls "select CODE,ATN,SAB,ATV from MRSAT where "))
 467     (cond
 468       (sui (string-append ls "KCUISUI="
 469                           (integer-string (make-cuisui cui sui) 14)))
 470       (lui (string-append ls "KCUILUI="
 471                           (integer-string (make-cuilui cui lui) 14)
 472                           " and sui=0"))
 473       (t (string-append ls "cui=" (prefixed-fixnum-string cui nil 7)
 474                         " and lui=0 and sui=0")))
 475     (when srl
 476       (string-append ls " and KSRL<=" (prefixed-fixnum-string srl nil 3)))
 477     (loop for tuple in (mutex-sql-query ls) collect
 478           (destructuring-bind (code atn sab atv) tuple
 479             (make-instance 'usat :code code :atn atn :sab sab :atv atv)))))
 480
 481 (defun find-usty-tui (tui)
 482   "Find usty for tui"
 483   (ensure-tui-integer tui)
 484   (collect-umlisp-query (mrsty (sty) nil tui tui :single t)
 485     (make-instance 'usty :tui tui :sty sty)))
 486
 487 (defun find-usty-sty (sty)
 488   "Find usty for a sty"
 489   (collect-umlisp-query (mrsty (tui) nil sty sty :single t)
 490     (make-instance 'usty :tui (ensure-integer tui) :sty sty)))
 491
 492 (defun find-usty-all ()
 493   "Return list of usty's for all semantic types"
 494   (collect-umlisp-query (mrsty (tui) nil nil nil :distinct t)
 495     (find-usty-tui tui)))
 496
 497 (defun find-usab-all ()
 498   "Find usab for a key"
 499   (collect-umlisp-query (mrsab (vcui rcui vsab rsab son sf sver mstart mend imeta
 500                                   rmeta slc scc srl tfr cfr cxty ttyl atnl lat
 501                                   cenc curver sabin) nil nil nil)
 502     (make-instance 'usab :vcui (ensure-integer vcui)
 503                    :rcui (ensure-integer rcui) :vsab vsab :rsab rsab :son son
 504                    :sf sf :sver sver :mstart mstart :mend mend :imeta imeta
 505                    :rmeta rmeta :slc slc :scc scc  :srl (ensure-integer srl)
 506                    :tfr (ensure-integer tfr) :cfr (ensure-integer cfr)
 507                    :cxty cxty :ttyl ttyl :atnl atnl :lat lat :cenc cenc
 508                    :curver curver :sabin sabin)))
 509
 510 (defun find-usab-by-key (key-name key)
 511   "Find usab for a key"
 512   (collect-umlisp-query-eval ('mrsab '(vcui rcui vsab rsab son sf sver mstart
 513                                     mend imeta rmeta slc scc srl tfr cfr cxty
 514                                     ttyl atnl lat cenc curver sabin)
 515                                   nil key-name key :single t)
 516     (make-instance 'usab :vcui (ensure-integer vcui)
 517                    :rcui (ensure-integer rcui) :vsab vsab :rsab rsab :son son
 518                    :sf sf :sver sver :mstart mstart :mend mend :imeta imeta
 519                    :rmeta rmeta :slc slc :scc scc :srl (ensure-integer srl)
 520                    :tfr (ensure-integer tfr) :cfr (ensure-integer cfr)
 521                    :cxty cxty :ttyl ttyl :atnl atnl :lat lat :cenc cenc
 522                    :curver curver :sabin sabin)))
 523
 524 (defun find-usab-rsab (rsab)
 525   "Find usab for rsab"
 526   (find-usab-by-key 'rsab rsab))
 527
 528 (defun find-usab-vsab (vsab)
 529   "Find usab for vsab"
 530   (find-usab-by-key 'vsab vsab))
 531
 532 (defun find-cui-max ()
 533   (ensure-integer (caar (mutex-sql-query "select max(CUI) from MRCON"))))
 534
 535 ;;;; Cross table find functions
 536
 537 (defun find-ucon-tui (tui &key (srl *current-srl*))
 538   "Find list of ucon for tui"
 539   (ensure-tui-integer tui)
 540   (collect-umlisp-query (mrsty (cui) srl tui tui :lrl klrl :order (cui asc))
 541     (find-ucon-cui (ensure-integer cui) :srl srl)))
 542
 543 (defun find-ucon-word (word &key (srl *current-srl*) (like nil))
 544   "Return list of ucons that match word. Optionally, use SQL's LIKE syntax"
 545   (collect-umlisp-query-eval ('mrxw_eng '(cui) srl 'wd word :like like :distinct t
 546                                      :lrl 'klrl :order '(cui asc))
 547     (find-ucon-cui cui :srl srl)))
 548
 549 (defun find-ucon-normalized-word (word &key (srl *current-srl*) (like nil))
 550   "Return list of ucons that match word, optionally use SQL's LIKE syntax"
 551   (collect-umlisp-query-eval ('mrxnw_eng '(cui) srl 'nwd word :like like :distinct t
 552                                       :lrl 'klrl :order '(cui asc))
 553     (find-ucon-cui cui :srl srl)))
 554
 555 (defun find-ustr-word (word &key (srl *current-srl*))
 556   "Return list of ustrs that match word"
 557   (collect-umlisp-query (mrxw_eng (cui sui) srl wd word :lrl klrl
 558                                :order (cui asc sui asc))
 559     (find-ustr-cuisui (ensure-integer cui) (ensure-integer sui) :srl srl)))
 560
 561 (defun find-ustr-normalized-word (word &key (srl *current-srl*))
 562   "Return list of ustrs that match word"
 563   (collect-umlisp-query (mrxnw_eng (cui sui) srl nwd word :lrl klrl
 564                                  :order (cui asc sui asc))
 565     (find-ustr-cuisui (ensure-integer cui) (ensure-integer sui) :srl srl)))
 566
 567 (defun find-ucon-noneng-word (word &key (srl *current-srl*) (like nil))
 568   "Return list of ucons that match non-english word"
 569   (collect-umlisp-query-eval ('mrxw_noneng '(cui) srl 'wd word :like like
 570                                         :distinct t :lrl 'klrl :order '(cui asc))
 571     (find-ucon-cui cui :srl srl)))
 572
 573 (defun find-ustr-noneng-word (word &key (srl *current-srl*))
 574   "Return list of ustrs that match non-english word"
 575   (collect-umlisp-query (mrxw_noneng (cui sui) srl wd word :lrl klrl
 576                                   :order (cui asc sui asc))
 577     (find-ustr-cuisui (ensure-integer cui) (ensure-integer sui) :srl srl)))
 578
 579 ;; Special tables
 580
 581 (defun find-usrl-all ()
 582   (collect-umlisp-query (usrl (sab srl) nil nil nil :order (sab asc))
 583     (make-instance 'usrl :sab sab :srl (ensure-integer srl))))
 584
 585 ;;; Multiword lookup and score functions
 586
 587 (defun find-ucon-multiword (str &key (srl *current-srl*))
 588   "Return sorted list of ucon's that match a multiword string"
 589   (let* ((words (delimited-string-to-list str #\space))
 590          (ucons '()))
 591     (dolist (word words)
 592       (setq ucons (append ucons (find-ucon-word word :srl srl))))
 593     (sort-score-ucon-str str (delete-duplicates ucons :test #'eql :key #'cui))))
 594
 595 (defun find-ustr-multiword (str &key (srl *current-srl*))
 596   "Return sorted list of ustr's that match a multiword string"
 597   (let* ((words (delimited-string-to-list str #\space))
 598          (ustrs '()))
 599     (dolist (word words)
 600       (setq ustrs (append ustrs (find-ustr-word word :srl srl))))
 601     (sort-score-ustr-str str (delete-duplicates ustrs :test #'eql :key #'cui))))
 602
 603 (defun sort-score-ucon-str (str ucons)
 604   "Return list of sorted and scored ucons. Score by match of str to ucon-pfstr"
 605   (sort-score-umlsclass-str ucons str #'pfstr))
 606
 607 (defun sort-score-ustr-str (str ustrs)
 608   "Return list of sorted and scored ucons. Score by match of str to ucon-pfstr"
 609   (sort-score-umlsclass-str ustrs str #'str))
 610
 611 (defun sort-score-umlsclass-str (objs str lookup-func)
 612   "Sort a list of objects based on scoring to a string"
 613   (let ((scored '()))
 614     (dolist (obj objs)
 615       (push (list obj (score-multiword-match str (funcall lookup-func obj)))
 616        scored))
 617     (mapcar #'car (sort scored #'> :key #'cadr))))
 618
 619 (defun score-multiword-match (s1 s2)
 620   "Score a match between two strings with s1 being reference string"
 621   (let* ((word-list-1 (delimited-string-to-list s1 #\space))
 622          (word-list-2 (delimited-string-to-list s2 #\space))
 623          (n1 (length word-list-1))
 624          (n2 (length word-list-2))
 625          (unmatched n1)
 626          (score 0)
 627          (nlong 0)
 628          (nshort 0)
 629          short-list long-list)
 630     (declare (fixnum n1 n2 nshort nlong score unmatched))
 631     (if (> n1 n2)
 632         (progn
 633           (setq nlong n1)
 634           (setq nshort n2)
 635           (setq long-list word-list-1)
 636           (setq short-list word-list-2))
 637       (progn
 638         (setq nlong n2)
 639         (setq nshort n1)
 640         (setq long-list word-list-2)
 641         (setq short-list word-list-1)))
 642     (decf score (- nlong nshort)) ;; reduce score for extra words
 643     (dotimes (iword nshort)
 644       (declare (fixnum iword))
 645       (kmrcl:aif (position (nth iword short-list) long-list :test #'string-equal)
 646            (progn
 647              (incf score (- 10 (abs (- kmrcl::it iword))))
 648              (decf unmatched))))
 649     (decf score (* 2 unmatched))
 650     score))
 651
 652
 653 ;;; LEX SQL functions
 654
 655 (defun find-lexterm-eui (eui)
 656   (ensure-eui-integer eui)
 657   (collect-umlisp-query (lrwd (wrd) nil eui eui :single t)
 658     (make-instance 'lexterm :eui eui :wrd wrd)))
 659
 660 (defun find-lexterm-word (wrd)
 661   (collect-umlisp-query (lrwd (eui) nil wrd wrd)
 662     (make-instance 'lexterm :eui (ensure-integer eui)
 663                    :wrd (copy-seq wrd))))
 664
 665 ;; LEX SQL Read functions
 666
 667 (defun find-labr-eui (eui)
 668   (ensure-eui-integer eui)
 669   (collect-umlisp-query (lrabr (bas abr eui2 bas2) nil eui eui)
 670     (make-instance 'labr :eui eui :bas bas :abr abr :bas2 bas2
 671                    :eui2 (ensure-integer eui2))))
 672
 673 (defun find-labr-bas (bas)
 674   (collect-umlisp-query (labr (eui abr eui2 bas2) nil bas bas)
 675     (make-instance 'labr :eui (ensure-integer eui) :abr abr :bas2 bas2
 676                    :bas (copy-seq bas) :eui2 (ensure-integer eui2))))
 677
 678 (defun find-lagr-eui (eui)
 679   (ensure-eui-integer eui)
 680   (collect-umlisp-query (lragr (str sca agr cit bas) nil eui eui)
 681     (make-instance 'lagr :eui eui :str str :sca sca :agr agr
 682                    :cit cit :bas bas)))
 683
 684 (defun find-lcmp-eui (eui)
 685   (ensure-eui-integer eui)
 686   (collect-umlisp-query (lrcmp (bas sca com) nil eui eui)
 687     (make-instance 'lcmp :eui eui :bas bas :sca sca :com com)))
 688
 689 (defun find-lmod-eui (eui)
 690   (ensure-eui-integer eui)
 691   (collect-umlisp-query (lrmod (bas sca psn_mod fea) nil eui eui)
 692     (make-instance 'lmod :eui eui :bas bas :sca sca :psnmod psn_mod :fea fea)))
 693
 694 (defun find-lnom-eui (eui)
 695   (ensure-eui-integer eui)
 696   (collect-umlisp-query (lrnom (bas sca eui2 bas2 sca2) nil eui eui)
 697     (make-instance 'lnom :eui eui :bas bas :sca sca :bas2 bas2 :sca2 sca2
 698                    :eui2 (ensure-integer eui2))))
 699
 700 (defun find-lprn-eui (eui)
 701   (ensure-eui-integer eui)
 702   (collect-umlisp-query (lrprn (bas num gnd cas pos qnt fea) nil eui eui)
 703     (make-instance 'lprn :eui eui :bas bas :num num :gnd gnd
 704                    :cas cas :pos pos :qnt qnt :fea fea)))
 705
 706 (defun find-lprp-eui (eui)
 707   (ensure-eui-integer eui)
 708   (collect-umlisp-query (lrprp (bas str sca fea) nil eui eui)
 709     (make-instance 'lprp :eui eui :bas bas :str str :sca sca :fea fea)))
 710
 711 (defun find-lspl-eui (eui)
 712   (ensure-eui-integer eui)
 713   (collect-umlisp-query (lrspl (spv bas) nil eui eui)
 714     (make-instance 'lspl :eui eui :spv spv :bas bas)))
 715
 716 (defun find-ltrm-eui (eui)
 717   (ensure-eui-integer eui)
 718   (collect-umlisp-query (lrtrm (bas gen) nil eui eui)
 719     (make-instance 'ltrm :eui eui :bas bas :gen gen)))
 720
 721 (defun find-ltyp-eui (eui)
 722   (ensure-eui-integer eui)
 723   (collect-umlisp-query (lrtyp (bas sca typ) nil eui eui)
 724     (make-instance 'ltyp :eui eui :bas bas :sca sca :typ typ)))
 725
 726 (defun find-lwd-wrd (wrd)
 727   (make-instance 'lwd :wrd
 728                  :euilist (collect-umlisp-query (lrwd (eui) nil wrd wrd)
 729                             (ensure-integer eui))))
 730
 731 ;;; Semantic Network SQL access functions
 732
 733 (defun find-sdef-ui (ui)
 734   (collect-umlisp-query (srdef (rt sty_rl stn_rtn def ex un rh abr rin)
 735                             nil ui ui :single t)
 736     (make-instance 'sdef :rt rt :ui ui :styrl sty_rl :stnrtn stn_rtn
 737                    :def def :ex ex :un un :rh rh :abr abr :rin rin)))
 738
 739 (defun find-sstre1-ui (ui)
 740   (collect-umlisp-query (srstre1 (ui2 ui3) nil ui ui)
 741     (make-instance 'sstre1 :ui ui :ui2 (ensure-integer ui2)
 742                    :ui3 (ensure-integer ui3))))
 743
 744 (defun find-sstre1-ui2 (ui2)
 745   (collect-umlisp-query (srstre1 (ui ui3) nil ui2 ui2)
 746     (make-instance 'sstre1 :ui (ensure-integer ui) :ui2 ui2
 747                    :ui3 (ensure-integer ui3))))
 748
 749 (defun find-sstr-rl (rl)
 750   (collect-umlisp-query (srstre (sty_rl sty_rl2 ls) nil rl rl)
 751     (make-instance 'sstr :rl rl :styrl sty_rl :styrl2 sty_rl2 :ls ls)))
 752
 753 (defun find-sstre2-sty (sty)
 754   (collect-umlisp-query (srstre2 (rl sty2) nil sty sty)
 755     (make-instance 'sstre2 :sty (copy-seq sty) :rl rl :sty2 sty2)))
 756
 757 (defun find-sstr-styrl (styrl)
 758   (collect-umlisp-query (srstr (rl sty_rl2 ls) nil styrl styrl)
 759     (make-instance 'sstr :styrl styrl :rl rl :styrl2 sty_rl2 :ls ls)))