1 | C0CRNF ; CCDCCR/GPL - Reference Name Format (RNF) utilities; 12/6/08
|
---|
2 | ;;0.1;CCDCCR;nopatch;noreleasedate
|
---|
3 | ;Copyright 2008 WorldVistA. Licensed under the terms of the GNU
|
---|
4 | ;General Public License See attached copy of the License.
|
---|
5 | ;
|
---|
6 | ;This program is free software; you can redistribute it and/or modify
|
---|
7 | ;it under the terms of the GNU General Public License as published by
|
---|
8 | ;the Free Software Foundation; either version 2 of the License, or
|
---|
9 | ;(at your option) any later version.
|
---|
10 | ;
|
---|
11 | ;This program is distributed in the hope that it will be useful,
|
---|
12 | ;but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
13 | ;MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
14 | ;GNU General Public License for more details.
|
---|
15 | ;
|
---|
16 | ;You should have received a copy of the GNU General Public License along
|
---|
17 | ;with this program; if not, write to the Free Software Foundation, Inc.,
|
---|
18 | ;51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
---|
19 | ;
|
---|
20 | W "This is the Reference Name Format (RNF) Utility Library ",!
|
---|
21 | W !
|
---|
22 | Q
|
---|
23 | ;
|
---|
24 | FIELDS(C0CFRTN,C0CF) ; RETURNS AN ARRAY OF THE FIELDS IN FILE C0CF,
|
---|
25 | ; C0CFRTN IS PASSED BY NAME, C0CF IS PASSED BY VALUE
|
---|
26 | ;
|
---|
27 | N C0CFI,C0CFJ ;INNER LOOP, OUTER LOOP
|
---|
28 | N C0CFN ; FIELD NAME
|
---|
29 | S C0CFI=0 S C0CFJ=C0CF
|
---|
30 | K @C0CFRTN ; CLEAR THE RETURN ARRAY
|
---|
31 | F Q:C0CFJ'[C0CF D ; FOR THE C0CF FILE AND ALL SUBFILES INCLUSIVE
|
---|
32 | . ;W "1: "_C0CFJ," ",C0CFI,!
|
---|
33 | . F S C0CFI=$O(^DD(C0CFJ,C0CFI)) Q:+C0CFI=0 D ; EVERY FIELD
|
---|
34 | . . ;W "2: "_C0CFJ," ",C0CFI,!
|
---|
35 | . . S C0CFN=$P(^DD(C0CFJ,C0CFI,0),"^",1) ;PULL FIELD NAME FROM ^DD
|
---|
36 | . . ;W "N: ",C0CFN,!
|
---|
37 | . . ;I C0CFN="STR" W C0CFN," ",C0CFJ,!
|
---|
38 | . . I $D(@C0CFRTN@(C0CFN)) D ; IS THIS A DUPLICATE?
|
---|
39 | . . . W "DUPLICATE FOUND! ",C0CFJ," ",C0CFI," ",C0CFN,!,@C0CFRTN@(C0CFN),!
|
---|
40 | . . . S @C0CFRTN@(C0CFN_"_"_C0CFJ)=C0CFJ_"^"_C0CFI
|
---|
41 | . . E S @C0CFRTN@(C0CFN)=C0CFJ_"^"_C0CFI
|
---|
42 | . S C0CFJ=$O(^DD(C0CFJ)) ; NEXT SUBFILE
|
---|
43 | Q
|
---|
44 | ;
|
---|
45 | GETN(GRTN,GFILE,GIEN,GNN) ; GET FIELDS FOR ACCESS BY NAME
|
---|
46 | ; GRTN IS PASSED BY NAME
|
---|
47 | ;
|
---|
48 | N C0CTMP,C0CI,C0CJ,C0CREF,C0CNAME
|
---|
49 | I $D(GNN) I GNN="ALL" S C0CNN=0 ; NOT NON-NULL (ALL FIELDS TO BE RETURNED)
|
---|
50 | E S C0CNN=1 ; NON-NULL IS TRUE (ONLY POPULATED FIELDS RETURNED)
|
---|
51 | S C0CREF=GIEN_"," ; OPEN ROOT REFERENCE INTO FILE
|
---|
52 | D CLEAN^DILF ; MAKE SURE WE ARE CLEANED UP
|
---|
53 | D GETS^DIQ(GFILE,C0CREF,"**","","C0CTMP")
|
---|
54 | D FIELDS(GRTN,GFILE) ;GET ALL THE FIELD NAMES FOR THE FILE
|
---|
55 | S @GRTN@(0)=GFILE_"^RNF1^"_GIEN_"^"_DT_"^"_$J ; STRUCTURE SIGNATURE
|
---|
56 | S (C0CI,C0CJ)=""
|
---|
57 | F S C0CJ=$O(C0CTMP(C0CJ)) Q:C0CJ="" D ; FOR ALL SUBFILES
|
---|
58 | . S C0CREF=$O(C0CTMP(C0CJ,"")) ; RECORD REFERENCE
|
---|
59 | . F S C0CI=$O(C0CTMP(C0CJ,C0CREF,C0CI)) Q:C0CI="" D ; ARRAY OF FIELDS
|
---|
60 | . . ;W C0CJ," ",C0CI,!
|
---|
61 | . . S C0CNAME=$P(^DD(C0CJ,C0CI,0),"^",1) ;PULL THE FIELD NAME
|
---|
62 | . . S C0CVALUE=C0CTMP(C0CJ,C0CREF,C0CI) ;
|
---|
63 | . . I C0CVALUE["C0CTMP" S C0CVALUE=C0CTMP(C0CJ,C0CREF,C0CI,1) ;1ST LINE OF WP
|
---|
64 | . . S $P(@GRTN@(C0CNAME),"^",3)=C0CVALUE ;RETURN VALUE IN P3
|
---|
65 | I C0CNN D ; IF ONLY NON-NULL VALUES ARE TO BE RETURNED
|
---|
66 | . S C0CI=""
|
---|
67 | . F S C0CI=$O(@GRTN@(C0CI)) Q:C0CI="" D ; GO THROUGH THE WHOLE ARRAY
|
---|
68 | . . I $P(@GRTN@(C0CI),"^",3)="" K @GRTN@(C0CI) ; KILL THE NULL ENTRIES
|
---|
69 | Q
|
---|
70 | ;
|
---|
71 | GETN2(GRTN,GFILE,GREF,GNDX,GNN) ; NEW GET ;GPL ; RETURN A FIELD VALUE MAP
|
---|
72 | ; GETN IS AN EXTRINSIC WHICH RETURNS THE NEXT IEN AFTER THE CURRENT GIEN
|
---|
73 | ; GRTN, PASSED BY NAME, RETURNS A FIELD MAP AND A VALUE MAP
|
---|
74 | ; .. FIELD MAP @GRTN@("F","FIELDNAME^FILE^FIELD#")=""
|
---|
75 | ; ... ANY FIELD USED BY ANY RECORD PROCESSED IS IN THE FIELD MAP
|
---|
76 | ; .. VALUE MAP @GRTN@("V","IEN","FIELDNAME")=VALUE
|
---|
77 | ; .. GRTN IS NOT INITIALIZED, SO MULTIPLE CALLS ARE CUMULATIVE
|
---|
78 | ; .. IF GNN="ALL" THEN ALL FIELDS FOR THE FILE ARE IN THE FIELD MAP
|
---|
79 | ; .. EVEN IF GNN="ALL" ONLY POPULATED FIELDS ARE RETURNED IN THE VALUE MAP
|
---|
80 | ; .. NUL FIELDS CAN BE DETERMINED BY CHECKING FIELD MAP - THIS SAVES SPACE
|
---|
81 | ; IF GREF IS "" THE FIRST RECORD IS OBTAINED
|
---|
82 | ; IF GNDX IS NULL, GREF IS AN IEN FOR THE FILE
|
---|
83 | ; GNDX IS THE INDEX TO USE TO OBTAIN THE IEN
|
---|
84 | ; GREF IS THE VALUE FOR THE INDEX
|
---|
85 | ; GANN= NOT NULL - IF GANN IS "ALL" THEN EVEN NULL FIELDS WILL BE RETURNED
|
---|
86 | ; OTHERWISE, ONLY POPULATED FIELDS ARE RETURNED IN GRTN
|
---|
87 | ;
|
---|
88 | ;
|
---|
89 | N GIEN,GF
|
---|
90 |
|
---|
91 | S GF=$$FILEREF(GFILE) ;CLOSED FILE REFERENCE FOR FILE NUMBER GFILE
|
---|
92 | I ('$D(GNDX))!(GNDX="") S GIEN=GREF ; IF NO INDEX USED, GREF IS THE IEN
|
---|
93 | E D ; WE ARE USING AN INDEX
|
---|
94 | . ;N ZG
|
---|
95 | . S ZG=$Q(@GF@(GNDX,GREF)) ;ACCESS INDEX
|
---|
96 | . I $QS(ZG,3)=GREF D ; IS GREF IN INDEX?
|
---|
97 | . . S GIEN=$QS(ZG,4) ; PULL OUT THE IEN
|
---|
98 | . E S GIEN="" ; NOT FOUND IN INDEX
|
---|
99 | W "IEN: ",GIEN,!
|
---|
100 | N C0CTMP,C0CI,C0CJ,C0CREF,C0CNAME
|
---|
101 | I $D(GNN) I GNN="ALL" S C0CNN=0 ; NOT NON-NULL (ALL FIELDS TO BE RETURNED)
|
---|
102 | E S C0CNN=1 ; NON-NULL IS TRUE (ONLY POPULATED FIELDS RETURNED)
|
---|
103 | S C0CREF=GIEN_"," ; OPEN ROOT REFERENCE INTO FILE
|
---|
104 | D CLEAN^DILF ; MAKE SURE WE ARE CLEANED UP
|
---|
105 | D GETS^DIQ(GFILE,C0CREF,"**","","C0CTMP")
|
---|
106 | D FIELDS(GRTN,GFILE) ;GET ALL THE FIELD NAMES FOR THE FILE
|
---|
107 | S @GRTN@(0)=GFILE_"^RNF1^"_GIEN_"^"_DT_"^"_$J_"^"_DUZ ; STRUCTURE SIGNATURE
|
---|
108 | S (C0CI,C0CJ)=""
|
---|
109 | F S C0CJ=$O(C0CTMP(C0CJ)) Q:C0CJ="" D ; FOR ALL SUBFILES
|
---|
110 | . S C0CREF=$O(C0CTMP(C0CJ,"")) ; RECORD REFERENCE
|
---|
111 | . F S C0CI=$O(C0CTMP(C0CJ,C0CREF,C0CI)) Q:C0CI="" D ; ARRAY OF FIELDS
|
---|
112 | . . ;W C0CJ," ",C0CI,!
|
---|
113 | . . S C0CNAME=$P(^DD(C0CJ,C0CI,0),"^",1) ;PULL THE FIELD NAME
|
---|
114 | . . S C0CVALUE=C0CTMP(C0CJ,C0CREF,C0CI) ;
|
---|
115 | . . I C0CVALUE["C0CTMP" S C0CVALUE=C0CTMP(C0CJ,C0CREF,C0CI,1) ;1ST LINE OF WP
|
---|
116 | . . S $P(@GRTN@(C0CNAME),"^",3)=C0CVALUE ;RETURN VALUE IN P3
|
---|
117 | I C0CNN D ; IF ONLY NON-NULL VALUES ARE TO BE RETURNED
|
---|
118 | . S C0CI=""
|
---|
119 | . F S C0CI=$O(@GRTN@(C0CI)) Q:C0CI="" D ; GO THROUGH THE WHOLE ARRAY
|
---|
120 | . . I $P(@GRTN@(C0CI),"^",3)="" K @GRTN@(C0CI) ; KILL THE NULL ENTRIES
|
---|
121 | Q
|
---|
122 | ;
|
---|
123 | GETALL(GARTN,GAFILE,GACNT,GASTRT,GANN) ; RETURN FIELD MAP AND VALUES
|
---|
124 | ; GARTN, PASSED BY NAME, RETURNS A FIELD MAP AND A VALUE MAP
|
---|
125 | ; .. FIELD MAP @GARTN@("F","FIELDNAME^FILE^FIELD#")=""
|
---|
126 | ; ... ANY FIELD USED BY ANY RECORD PROCESSED IS IN THE FIELD MAP
|
---|
127 | ; .. VALUE MAP @GARTN@("V","IEN","FIELDNAME")=VALUE
|
---|
128 | ; .. GARTN IS NOT INITIALIZED, SO MULTIPLE CALLS ARE CUMULATIVE
|
---|
129 | ; .. IF GANN="ALL" THEN ALL FIELDS FOR THE FILE ARE IN THE FIELD MAP
|
---|
130 | ; .. EVEN IF GANN="ALL" ONLY POPULATED FIELDS ARE RETURNED IN THE VALUE MAP
|
---|
131 | ; .. NUL FIELDS CAN BE DETERMINED BY CHECKING FIELD MAP - THIS SAVES SPACE
|
---|
132 | ; GAFILE IS THE FILE NUMBER TO BE PROCESSED. IT IS PASSED BY VALUE
|
---|
133 | ; GACNT IS THE NUMBER OF RECORDS TO PROCESS. IT IS PASSED BY VALUE
|
---|
134 | ; .. IF GARCNT IS NULL, ALL RECORDS ARE PROCESSED
|
---|
135 | ; GASTRT IS THE IEN OF THE FIRST RECORD TO PROCESS. IT IS PASSED BY VALUE
|
---|
136 | ; .. IF GARSTART IS NULL, PROCESSING STARTS AT THE FIRST RECORD
|
---|
137 | ; GANN= NOT NULL - IF GANN IS "ALL" THEN EVEN NULL FIELDS WILL BE RETURNED
|
---|
138 | ; OTHERWISE, ONLY POPULATED FIELDS ARE RETURNED IN GARFLD AND GARVAL
|
---|
139 | N GATMP,GAI,GAF
|
---|
140 | S GAF=$$FILEREF(GAFILE) ; GET CLOSED ROOT FOR THE FILE NUMBER GAFILE
|
---|
141 | W GAF,!
|
---|
142 | W $O(@GAF@(0)) ;
|
---|
143 | S GAI=0 ;ITERATOR
|
---|
144 | ; F S GAI=$O(@GAF@
|
---|
145 | Q
|
---|
146 | ;
|
---|
147 | FILEREF(FNUM) ; EXTRINSIC THAT RETURNS A CLOSED ROOT FOR FILE NUMBER FNUM
|
---|
148 | ;
|
---|
149 | N C0CF
|
---|
150 | S C0CF=^DIC(FNUM,0,"GL") ;OPEN ROOT TO FILE
|
---|
151 | S C0CF=$P(C0CF,",",1)_")" ; CLOSE THE ROOT
|
---|
152 | Q C0CF
|
---|
153 | ;
|
---|
154 | ZFILE(ZFN,ZTAB) ; EXTRINSIC TO RETURN FILE NUMBER FOR FIELD NAME PASSED
|
---|
155 | ; BY VALUE IN ZFN. FILE NUMBER IS PIECE 1 OF @ZTAB@(ZFN)
|
---|
156 | ; IF ZTAB IS NULL, IT DEFAULTS TO C0CA
|
---|
157 | I '$D(ZTAB) S ZTAB="C0CA"
|
---|
158 | Q $P(@ZTAB@(ZFN),"^",1)
|
---|
159 | ZFIELD(ZFN,ZTAB) ;EXTRINSIC TO RETURN FIELD NUMBER FOR FIELD NAME PASSED
|
---|
160 | ; BY VALUE IN ZFN. FILE NUMBER IS PIECE 2 OF @ZTAB@(ZFN)
|
---|
161 | ; IF ZTAB IS NULL, IT DEFAULTS TO C0CA
|
---|
162 | I '$D(ZTAB) S ZTAB="C0CA"
|
---|
163 | Q $P(@ZTAB@(ZFN),"^",2)
|
---|
164 | ZVALUE(ZFN,ZTAB) ;EXTRINSIC TO RETURN VALUE FOR FIELD NAME PASSED
|
---|
165 | ; BY VALUE IN ZFN. FILE NUMBER IS PIECE 3 OF @ZTAB@(ZFN)
|
---|
166 | ; IF ZTAB IS NULL, IT DEFAULTS TO C0CA
|
---|
167 | I '$D(ZTAB) S ZTAB="C0CA"
|
---|
168 | Q $P(@ZTAB@(ZFN),"^",3)
|
---|
169 | ;
|
---|