r9521: rrf updates
[umlisp.git] / parse-rrf.lisp
1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: umlisp -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
4 ;;;;
5 ;;;; Name:     parse-2002.lisp
6 ;;;; Purpose:  Parsing and SQL insertion routines for UMLisp which may
7 ;;;;           change from year to year
8 ;;;; Author:   Kevin M. Rosenberg
9 ;;;; Created:  Apr 2000
10 ;;;;
11 ;;;; $Id$
12 ;;;;
13 ;;;; This file, part of UMLisp, is
14 ;;;;    Copyright (c) 2000-2004 by Kevin M. Rosenberg, M.D.
15 ;;;;
16 ;;;; UMLisp users are granted the rights to distribute and use this software
17 ;;;; as governed by the terms of the GNU General Public License.
18 ;;;; *************************************************************************
19
20 (in-package #:umlisp)
21
22 ;;; Pre-read data for custom fields into hash tables
23 (defvar *preparse-hash-init?* nil)
24
25 (eval-when (:compile-toplevel :load-toplevel :execute)
26 (let ((pfstr-hash nil)      ;; Preferred concept strings by CUI
27       (cui-lrl-hash nil)    ;; LRL by CUI
28       (lui-lrl-hash nil)    ;; LRL by LUI
29       (sui-lrl-hash nil)    ;; LRL by SUI
30       (cuisui-lrl-hash nil) ;; LRL by CUISUI
31       (sab-srl-hash nil))   ;; SRL by SAB
32   
33   (defun make-preparse-hash-table ()
34     (if sui-lrl-hash
35         (progn
36           (clrhash pfstr-hash)
37           (clrhash cui-lrl-hash)
38           (clrhash lui-lrl-hash)
39           (clrhash sui-lrl-hash)
40           (clrhash cuisui-lrl-hash)
41           (clrhash sab-srl-hash))
42       (setf
43           pfstr-hash (make-hash-table :size 800000)
44           cui-lrl-hash (make-hash-table :size 800000)
45           lui-lrl-hash (make-hash-table :size 1500000)
46           sui-lrl-hash (make-hash-table :size 1500000)
47           cuisui-lrl-hash (make-hash-table :size 1800000)
48           sab-srl-hash (make-hash-table :size 100 :test 'equal))))
49     
50   (defun ensure-preparse (&optional (force-read nil))
51     (when (or force-read (not *preparse-hash-init?*))
52       (make-preparse-hash-table)
53       (setq *preparse-hash-init?* t))
54     (with-umls-file (line "MRCONSO.RRF")
55       (let ((cui (parse-ui (nth 0 line)))
56             (lui (parse-ui (nth 3 line)))
57             (sui (parse-ui (nth 5 line)))
58             (sab (nth 11 line))
59             (srl (parse-integer (nth 15 line))))
60         (unless (gethash cui pfstr-hash)  ;; if haven't stored pfstr for cui
61           (if (and (string-equal (nth 1 line) "ENG") ; LAT
62                    (string-equal (nth 2 line) "P") ; ts
63                    (string-equal (nth 4 line) "PF")) ; stt
64               (setf (gethash cui pfstr-hash) (nth 14 line))))
65         (set-lrl-hash cui srl cui-lrl-hash)
66         (set-lrl-hash lui srl lui-lrl-hash)
67         (set-lrl-hash sui srl sui-lrl-hash)
68         (set-lrl-hash (make-cuisui cui sui) srl cuisui-lrl-hash)
69         (multiple-value-bind (val found) (gethash sab sab-srl-hash)
70           (declare (ignore val))
71           (unless found
72             (setf (gethash sab sab-srl-hash) srl))))))
73   
74   (defun pfstr-hash (cui) (gethash cui pfstr-hash))
75   (defun cui-lrl (cui)    (gethash cui cui-lrl-hash))
76   (defun lui-lrl (lui)    (gethash lui lui-lrl-hash))
77   (defun sui-lrl (sui)    (gethash sui sui-lrl-hash))
78   (defun sab-srl (sab)    (aif (gethash sab sab-srl-hash) it 0))
79   (defun cuisui-lrl (cuisui) (gethash cuisui cuisui-lrl-hash))
80   
81 )) ;; closure
82
83 (defun set-lrl-hash (key lrl hash)
84   "Set the least restrictive level in hash table"
85   (multiple-value-bind (hash-lrl found) (gethash key hash)
86     (if (or (not found) (< lrl hash-lrl))
87         (setf (gethash key hash) lrl))))
88
89 ;; UMLS file and column structures
90 ;;; SQL datatypes symbols
91 ;;; sql-u - Unique identifier
92 ;;; sql-s - Small integer (16-bit)
93 ;;; sql-i - Integer (32-bit)
94 ;;; sql-l - Big integer (64-bit)
95 ;;; sql-f - Floating point
96 ;;; sql-c - Character data
97
98 (defparameter +col-datatypes+
99     '(("AV" sql-f) ("BTS" sql-i) ("CLS" sql-i) ("COF" sql-i) ("CUI1" sql-u)
100       ("AUI" sql-u) ("AUI1" sql-u) ("AUI2" sql-u) ("PCUI" sql-u)
101       ("PLUI" sql-u)
102       ("CUI2" sql-u) ("CUI" sql-u) ("CXN" sql-s) ("FR" sql-i) ("LRL" sql-s)
103       ("LUI" sql-u) ("MAX" sql-s) ("MIN" sql-s) ("RANK" sql-s) ("REF" sql-c)
104       ("RNK" sql-s) ("RWS" sql-i) ("SRL" sql-s) ("SUI" sql-u) ("TUI" sql-u)
105       ;;; Custom columns
106       ("KCUISUI" sql-l) ("KCUILUI" sql-l) ("KCUILRL" sql-i) ("KLUILRL" sql-i)
107       ("KSRL" sql-i) ("KLRL" sql-i)
108       ;;; LEX columns
109       ("EUI" sql-u) ("EUI2" sql-u)
110       ;;; Semantic net columns
111       ("UI" sql-u) ("UI2" sql-u) ("UI3" sql-u)
112       ;; New fields for 2002AD
113       ("RCUI" sql-u) ("VCUI" sql-u) ("CFR" sql-i) ("TFR" sql-i)
114       ("MAPSETCUI" sql-u)
115       ) 
116     "SQL data types for each non-string column")
117
118 (defparameter +custom-tables+
119     nil
120   #+ignore
121   '(("KCON" "SELECT CUI,STR FROM MRCONSO WHERE STT='PF' AND TS='P' AND ISPREF='Y' AND LAT='ENG'"))
122   "Custom tables to create")
123
124 (defparameter +custom-cols+
125     '(("MRCONSO.RRF" "KPFSTR" "TEXT"
126                      (slot-value (find-ucol "STR" "MRCONSO.RRF") 'max)
127                      (lambda (x) (pfstr-hash (parse-ui (nth 0 x)))))
128       ("MRCONSO.RRF" "KCUISUI" "BIGINT" 0
129        (lambda (x) (write-to-string (make-cuisui (parse-ui (nth 0 x)) (parse-ui (nth 5 x))))))
130       ("MRCONSO.RRF" "KCUILUI" "BIGINT" 0
131        (lambda (x) (write-to-string (make-cuilui (parse-ui (nth 0 x)) (parse-ui (nth 3 x))))))
132       ("MRCONSO.RRF" "KCUILRL" "SMALLINT" 0
133        (lambda (x) (write-to-string (lui-lrl (parse-ui (nth 0 x))))))
134       ("MRCONSO.RRF" "KLUILRL" "SMALLINT" 0
135        (lambda (x) (write-to-string (lui-lrl (parse-ui (nth 3 x))))))
136       ("MRCONSO.RRF" "KSUILRL" "SMALLINT" 0
137        (lambda (x) (write-to-string (sui-lrl (parse-ui (nth 5 x))))))
138       ;; Deprecated, last in 2004AA -- skip index
139       #+ignore
140       ("MRLO.RRF" "KLRL" "SMALLINT" 0
141        (lambda (x) (write-to-string 
142                     (if (zerop (length (nth 4 x)))
143                         (cui-lrl (parse-ui (nth 0 x)))
144                       (cuisui-lrl (make-cuisui (parse-ui (nth 0 x)) (parse-ui (nth 4 x))))))))
145       ("MRSTY.RRF" "KLRL" "SMALLINT" 0
146        (lambda (x) (write-to-string (cui-lrl (parse-ui (nth 0 x))))))
147       ("MRCOC.RRF" "KLRL" "SMALLINT" 0
148        (lambda (x) (write-to-string 
149                     (max (cui-lrl (parse-ui (nth 0 x)))
150                          (kmrcl:aif (cui-lrl (parse-ui (nth 1 x))) kmrcl::it 0)))))
151       ("MRSAT.RRF" "KSRL" "SMALLINT" 0
152        (lambda (x) (write-to-string (sab-srl (nth 9 x)))))
153       ("MRREL.RRF" "KSRL" "SMALLINT" 0
154        (lambda (x) (write-to-string (sab-srl (nth 10 x)))))
155       ("MRRANK.RRF" "KSRL" "SMALLINT" 0
156        (lambda (x) (write-to-string (sab-srl (nth 1 x)))))
157       ("MRDEF.RRF" "KSRL" "SMALLINT" 0
158        (lambda (x) (write-to-string (sab-srl (nth 4 x)))))
159       ("MRCXT.RRF" "KSRL" "SMALLINT" 0
160        (lambda (x) (write-to-string (sab-srl (nth 2 x)))))
161       ("MRXW_ENG.RRF" "KLRL" "SMALLINT" 0
162        (lambda (x) (write-to-string (cuisui-lrl (make-cuisui 
163                                                  (parse-ui (nth 2 x))
164                                                  (parse-ui (nth 4 x)))))))
165       ("MRXW_NONENG.RRF" "KLRL" "SMALLINT" 0
166        (lambda (x) (write-to-string (cuisui-lrl (make-cuisui 
167                                                  (parse-ui (nth 2 x))
168                                                  (parse-ui (nth 4 x)))))))
169       ("MRXNW_ENG.RRF" "KLRL" "SMALLINT" 0
170        (lambda (x) (write-to-string (cuisui-lrl (make-cuisui 
171                                                  (parse-ui (nth 2 x))
172                                                  (parse-ui (nth 4 x)))))))
173       ("MRXNS_ENG.RRF" "KLRL" "SMALLINT" 0
174        (lambda (x) (write-to-string (cuisui-lrl (make-cuisui 
175                                                  (parse-ui (nth 2 x))
176                                                  (parse-ui (nth 4 x)))))))
177       ("MRREL.RRF" "KPFSTR2" "TEXT" 1024
178        (lambda (x) (pfstr-hash (parse-ui (nth 4 x)))))
179       ("MRCOC.RRF" "KPFSTR2" "TEXT" 1024
180        (lambda (x) (pfstr-hash (parse-ui (nth 2 x)))))
181       ("MRCXT.RRF" "KCUISUI" "BIGINT" 0 
182        (lambda (x) (write-to-string (make-cuisui (parse-ui (nth 0 x)) (parse-ui (nth 1 x))))))
183       ("MRSAT.RRF" "KCUILUI" "BIGINT" 0
184        (lambda (x) (write-to-string (make-cuilui (parse-ui (nth 0 x)) (parse-ui (nth 1 x))))))
185       ("MRSAT.RRF" "KCUISUI" "BIGINT" 0
186        (lambda (x) (write-to-string (make-cuisui (parse-ui (nth 0 x)) (parse-ui (nth 2 x))))))
187       ("MRXW_ENG.RRF" "KCUISUI" "BIGINT" 0
188        (lambda (x) (write-to-string (make-cuisui (parse-ui (nth 2 x)) (parse-ui (nth 4 x))))))
189       ("MRXNW_ENG.RRF" "KCUISUI" "BIGINT" 0
190        (lambda (x) (write-to-string (make-cuisui (parse-ui (nth 2 x)) (parse-ui (nth 4 x))))))
191       ("MRXNS_ENG.RRF" "KCUISUI" "BIGINT" 0
192        (lambda (x) (write-to-string (make-cuisui (parse-ui (nth 2 x)) (parse-ui (nth 4 x))))))
193       ("MRXW_NONENG.RRF" "LAT" "VARCHAR" 3 (lambda (x) (nth 0 x)))
194       ("MRXW_NONENG.RRF" "WD"  "VARCHAR" 200  (lambda (x) (nth 1 x)))
195       ("MRXW_NONENG.RRF" "CUI" "INTEGER" 0 (lambda (x) (write-to-string (parse-ui (nth 2 x)))))
196       ("MRXW_NONENG.RRF" "LUI" "INTEGER" 0 (lambda (x) (write-to-string (parse-ui (nth 3 x)))))
197       ("MRXW_NONENG.RRF" "SUI" "INTEGER" 0 (lambda (x) (write-to-string (parse-ui (nth 4 x)))))
198       ("MRXW_NONENG.RRF" "KCUISUI" "BIGINT" 0 
199        (lambda (x) (write-to-string (make-cuisui (parse-ui (nth 2 x)) (parse-ui (nth 4 x)))))))
200   "Custom columns to create.(filename, col, sqltype, value-func).")
201
202 (defparameter +index-cols+
203     '(("CUI1" "MRCOC") ("CUI" "MRCONSO") ("LUI" "MRCONSO") 
204       ("SRL" "MRCONSO") ("AUI" "MRCONSO")
205       ("SUI" "MRCONSO") ("CUI" "MRCXT") ("CUI" "MRDEF") ("CUI" "MRLO")
206       ("CUI1" "MRREL") ("CUI" "MRSAT") ("LUI" "MRSAT") ("SUI" "MRSAT")
207       ("CUI" "MRSTY")
208       ("TUI" "MRSTY") ("CUI" "MRXNS_ENG") 
209       #+ignore ("NSTR" "MRXNS_ENG" 10)
210       ("CUI" "MRXNW_ENG") ("NWD" "MRXNW_ENG") ("WD" "MRXW_ENG")
211       ("KCUISUI" "MRCONSO") ("KCUILUI" "MRCONSO") ("KCUILRL" "MRCONSO")
212       ("KLUILRL" "MRCONSO") ("KCUISUI" "MRCXT") 
213       ("KCUISUI" "MRSAT")  ("KCUILUI" "MRSAT")
214       ("KCUISUI" "MRXW_ENG") ("KCUISUI" "MRXNW_ENG") 
215       ("KCUISUI" "MRXNS_ENG") ("KCUISUI" "MRXW_NONENG")
216       ("KSRL" "MRCXT") ("KSRL" "MRDEF") ("KSRL" "MRRANK") 
217       ("KSRL" "MRREL") ("KSRL" "MRSAT") ("KLRL" "MRCOC") 
218       #+ignore ("KLRL" "MRLO")  ;; deprecated
219       ("KLRL" "MRSTY") ("KLRL" "MRXW_ENG") ("KLRL" "MRXNW_ENG")
220       ("KLRL" "MRXNS_ENG") ("KLRL" "MRXW_NONENG")
221       ;; LEX indices
222       ("EUI" "LRABR") ("EUI2" "LRABR") ("EUI" "LRAGR") ("EUI" "LRCMP") ("EUI" "LRMOD")
223       ("EUI" "LRNOM") ("EUI2" "LRNOM") ("EUI" "LRPRN") ("EUI" "LRPRP") ("EUI" "LRSPL")
224       ("EUI" "LRTRM") ("EUI" "LRTYP") ("EUI" "LRWD") ("WRD" "LRWD")
225       ("BAS" "LRABR") 
226       ;; Semantic NET indices
227       ("UI" "SRSTRE1") ("UI2" "SRSTRE1") ("UI3" "SRSTRE1") 
228       ("STY_RL" "SRDEF") ("RT" "SRDEF") ("STY_RL" "SRSTR") ("STY_RL2" "SRSTR")
229       ("RL" "SRSTR")
230       ("SRL" "MRSAB") ("RSAB" "MRSAB") ("VSAB" "MRSAB") ("RCUI" "MRSAB")
231       ("VCUI" "MRSAB") ("LAT" "MRSAB"))
232   "Columns in files to index")
233
234
235 (defparameter +custom-index-cols+
236   nil
237   #+ignore
238   '(("CUI" "KCON") ("LRL" "KCON"))
239   "Indexes to custom tables")
240
241 ;; File & Column functions
242
243 (defun gen-ucols ()
244   (add-ucols (gen-ucols-meta))
245   (add-ucols (gen-ucols-custom))
246   (add-ucols (gen-ucols-generic "LRFLD"))
247   (add-ucols (gen-ucols-generic "SRFLD")))
248
249 (defun gen-ucols-meta ()
250 "Initialize all umls columns"  
251   (let ((cols '()))
252     (with-umls-file (line "MRCOLS.RRF")
253       (destructuring-bind (col des ref min av max fil dty) line
254         (push (make-ucol col des ref (parse-integer min) (read-from-string av)
255                          (parse-integer max) fil dty)
256               cols)))
257     (nreverse cols)))
258
259 (defun gen-ucols-custom ()
260 "Initialize umls columns for custom columns"  
261   (loop for customcol in +custom-cols+
262         collect
263         (make-ucol (nth 1 customcol) "" 0 0 0 (eval (nth 3 customcol))
264                    (nth 0 customcol) nil :sqltype (canonicalize-column-type (nth 2 customcol))
265                    :custom-value-fun (nth 4 customcol))))
266
267 (defun gen-ucols-generic (col-filename)
268 "Initialize for generic (LEX/NET) columns"  
269   (let ((cols '()))
270     (with-umls-file (line col-filename)
271       (destructuring-bind (nam des ref fil) line
272         (setq nam (escape-column-name nam))
273         (dolist (file (delimited-string-to-list fil #\,))
274           (push
275            (make-ucol nam des ref nil nil nil file nil)
276            cols))))
277     (nreverse cols)))
278
279
280 (defun gen-ufiles ()
281   (add-ufiles (gen-ufiles-generic "MRFILES.RRF" "META"))
282   (add-ufiles (gen-ufiles-generic "LRFIL" "LEX"))
283   (add-ufiles (gen-ufiles-generic "SRFIL" "NET"))
284   ;; needs to come last
285   (add-ufiles (gen-ufiles-custom)))
286
287                         
288 (defun gen-ufiles-generic (files-filename dir)
289 "Initialize all LEX file structures"  
290   (let ((files '()))
291     (with-umls-file (line files-filename)
292       (destructuring-bind (fil des fmt cls rws bts) line
293         (push (make-ufile
294                dir fil des 
295                (parse-integer cls)
296                (parse-integer rws) (parse-integer bts)
297                (concatenate 'list (umls-field-string-to-list fmt)
298                             (custom-colnames-for-filename fil)))
299               files)))
300     (nreverse files)))
301
302 (defun gen-ufiles-custom ()
303   (make-ufile "META" "MRXW_NONENG.RRF" "Custom NonEnglish Index" 
304               5 0 0 (fields (find-ufile "MRXW_ENG.RRF"))))
305
306
307