source: FOIAVistA/trunk/r/VA_FILEMAN-ARJT-DI-DD-DM-DT-%DT-%RCR/DINIT124.m@ 1487

Last change on this file since 1487 was 628, checked in by George Lilly, 15 years ago

initial load of FOIAVistA 6/30/08 version
File size: 6.6 KB
Line 
1DINIT124 ;SFISC/MKO-SORT TEMPLATE FILE ;1:13 PM 13 Nov 1998
2 ;;22.0;VA FileMan;;Mar 30, 1999
3 ;Per VHA Directive 10-93-142, this routine should not be modified.
4 F I=1:2 S X=$T(Q+I) Q:X="" S Y=$E($T(Q+I+1),4,999),X=$E(X,4,999) S:$A(Y)=126 I=I+1,Y=$E(Y,2,999)_$E($T(Q+I+1),5,99) S:$A(Y)=61 Y=$E(Y,2,999) S @X=Y
5 G ^DINIT125
6Q Q
7 ;;^DD(.4014,9,3)
8 ;;=First ^ piece null, second piece=static part of cross-reference, third piece=global reference, 4th piece=number of variable subscripts to get to (and including) record number.
9 ;;^DD(.4014,9,21,0)
10 ;;=^^8^8^2930115^
11 ;;^DD(.4014,9,21,1,0)
12 ;;= Piece 1 is always null
13 ;;^DD(.4014,9,21,2,0)
14 ;;= Piece 2 is the static part of the cross-reference: ex. DIZ(662001,"B",
15 ;;^DD(.4014,9,21,3,0)
16 ;;= Piece 3 is the global reference: ex. DIZ(662001,
17 ;;^DD(.4014,9,21,4,0)
18 ;;= Piece 4 tells FileMan how many variable subscripts must be sorted
19 ;;^DD(.4014,9,21,5,0)
20 ;;=through to get to the record number, plus 1 for the record number
21 ;;^DD(.4014,9,21,6,0)
22 ;;=itself. ex. for a regular cross-reference, ^DIZ(662001,"B",X,DA),
23 ;;^DD(.4014,9,21,7,0)
24 ;;=the number is 2. One for the value of the X subscript, and one for the
25 ;;^DD(.4014,9,21,8,0)
26 ;;=record number itself (DA).
27 ;;^DD(.4014,9,23,0)
28 ;;=^^6^6^2930115^
29 ;;^DD(.4014,9,23,1,0)
30 ;;=The IX nodes are normally derived by FileMan during the entry of sort
31 ;;^DD(.4014,9,23,2,0)
32 ;;=fields (in routine XR^DIP). However, they can also be passed to the
33 ;;^DD(.4014,9,23,3,0)
34 ;;=print (^DIP) in the BY(0) variable to cause FileMan to either use a MUMPS
35 ;;^DD(.4014,9,23,4,0)
36 ;;=type cross-reference, or a previously sorted list of record numbers.
37 ;;^DD(.4014,9,23,5,0)
38 ;;=Fileman sometimes builds the IX node prior to calling the print, as in
39 ;;^DD(.4014,9,23,6,0)
40 ;;=the INQUIRE option, where the user then goes on to print the records.
41 ;;^DD(.4014,9,"DT")
42 ;;=2930115
43 ;;^DD(.4014,9.5,0)
44 ;;=POINT TO CROSS REFERENCE^F^^PTRIX;E1,245^K:$L(X)>245!($L(X)<1) X
45 ;;^DD(.4014,9.5,3)
46 ;;=Enter global reference for "B" index of .01 field on pointed-to file. Answer must be 1-245 characters in length.
47 ;;^DD(.4014,9.5,21,0)
48 ;;=^^7^7^2931221^
49 ;;^DD(.4014,9.5,21,1,0)
50 ;;=This node will exist only if the sort field is a pointer, if the sort
51 ;;^DD(.4014,9.5,21,2,0)
52 ;;=field has a regular cross-reference, if the .01 field on the pointed-to
53 ;;^DD(.4014,9.5,21,3,0)
54 ;;=file has a "B" index, and if the .01 field on the pointed-to file is
55 ;;^DD(.4014,9.5,21,4,0)
56 ;;=either a numeric, date, set-of-codes or free-text field, and does not have
57 ;;^DD(.4014,9.5,21,5,0)
58 ;;=an output transform. If this node exists, it will be set to the static
59 ;;^DD(.4014,9.5,21,6,0)
60 ;;=part of the global reference of the "B" index on the pointed-to file. (ex.
61 ;;^DD(.4014,9.5,21,7,0)
62 ;;=^DIZ(662001,"B",).
63 ;;^DD(.4014,9.5,"DT")
64 ;;=2931221
65 ;;^DD(.4014,10,0)
66 ;;=GET CODE^K^^GET;E1,245^K:$L(X)>245 X D:$D(X) ^DIM
67 ;;^DD(.4014,10,3)
68 ;;=This is Standard MUMPS code used to extract the sort field from a record.
69 ;;^DD(.4014,10,9)
70 ;;=@
71 ;;^DD(.4014,10,21,0)
72 ;;=^^3^3^2930115^
73 ;;^DD(.4014,10,21,1,0)
74 ;;=The GET CODE is MUMPS code that is executed after a record (or sub-record)
75 ;;^DD(.4014,10,21,2,0)
76 ;;=has been selected. The code extracts the SORT field from that record
77 ;;^DD(.4014,10,21,3,0)
78 ;;=into a local variable.
79 ;;^DD(.4014,10,23,0)
80 ;;=^^1^1^2930115^
81 ;;^DD(.4014,10,23,1,0)
82 ;;=GET CODE can be generated by a call to FileMan routine GET^DIOU.
83 ;;^DD(.4014,10,"DT")
84 ;;=2930115
85 ;;^DD(.4014,11,0)
86 ;;=QUERY CONDITION^K^^QCON;E1,245^K:$L(X)>245 X D:$D(X) ^DIM
87 ;;^DD(.4014,11,3)
88 ;;=This is Standard MUMPS code used to test the field to see whether it meets the query condition (ex., whether it's within the from/to range specified by the user).
89 ;;^DD(.4014,11,9)
90 ;;=@
91 ;;^DD(.4014,11,21,0)
92 ;;=^^5^5^2930115^
93 ;;^DD(.4014,11,21,1,0)
94 ;;=The QUERY CONDITION is MUMPS code that takes a field in a local variable,
95 ;;^DD(.4014,11,21,2,0)
96 ;;=and executes some query condition. The results of executing the code
97 ;;^DD(.4014,11,21,3,0)
98 ;;=will return a truth value of TRUE if the field met the condition, or
99 ;;^DD(.4014,11,21,4,0)
100 ;;=FALSE if not. It is used, for example, to see whether a SORT FIELD falls
101 ;;^DD(.4014,11,21,5,0)
102 ;;=within the FROM/TO range requested by the user.
103 ;;^DD(.4014,11,23,0)
104 ;;=^^2^2^2930115^
105 ;;^DD(.4014,11,23,1,0)
106 ;;=The QUERY CONDITION code is generated by various calls to FileMan
107 ;;^DD(.4014,11,23,2,0)
108 ;;=routines DIOC*.
109 ;;^DD(.4014,11,"DT")
110 ;;=2930115
111 ;;^DD(.4014,12,0)
112 ;;=DESCRIPTION OF SORT^F^^TXT;E1,200^K:$L(X)>200!($L(X)<1) X
113 ;;^DD(.4014,12,3)
114 ;;=Answer must be 1-200 characters in length. Text explaining the query condition (field name and what conditions must be met in order for the record to be selected).
115 ;;^DD(.4014,12,21,0)
116 ;;=^^4^4^2930115^
117 ;;^DD(.4014,12,21,1,0)
118 ;;=This field contains a brief textual description of the SORT FIELD and
119 ;;^DD(.4014,12,21,2,0)
120 ;;=the SORT CRITERIA used on it (i.e., the from/to values). This
121 ;;^DD(.4014,12,21,3,0)
122 ;;=description can be printed in the heading of a report, at the users
123 ;;^DD(.4014,12,21,4,0)
124 ;;=request.
125 ;;^DD(.4014,12,23,0)
126 ;;=^^2^2^2930115^
127 ;;^DD(.4014,12,23,1,0)
128 ;;=This text is build as the developer answers the FROM/TO questions
129 ;;^DD(.4014,12,23,2,0)
130 ;;=during the SORT sequence.
131 ;;^DD(.4014,12,"DT")
132 ;;=2930115
133 ;;^DD(.4014,13,0)
134 ;;=SEARCH EFFICIENCY RATING^NJ9,4^^SER;1^K:+X'=X!(X>9999.9999)!(X<0)!(X?.E1"."5N.N) X
135 ;;^DD(.4014,13,3)
136 ;;=Type a Number between 0 and 9999.9999, 4 Decimal Digits. Search efficiency number returned by Query Optimizer Routine.
137 ;;^DD(.4014,13,21,0)
138 ;;=^^7^7^2930125^
139 ;;^DD(.4014,13,21,1,0)
140 ;;=Fields are assigned a search efficiency rating based on the number of
141 ;;^DD(.4014,13,21,2,0)
142 ;;=hits found for the query (or sort) condition. The fewer the hits, the
143 ;;^DD(.4014,13,21,3,0)
144 ;;=higher the rating. A high rating indicates the criteria will more quickly
145 ;;^DD(.4014,13,21,4,0)
146 ;;=cut down the number of records to be processed. The rating will be
147 ;;^DD(.4014,13,21,5,0)
148 ;;=higher if the field has a cross-reference. The field with the highest
149 ;;^DD(.4014,13,21,6,0)
150 ;;=rating is used to do the initial loop through the file during the sort
151 ;;^DD(.4014,13,21,7,0)
152 ;;=phase.
153 ;;^DD(.4014,13,23,0)
154 ;;=^^1^1^2930125^
155 ;;^DD(.4014,13,23,1,0)
156 ;;=Calculated in the Query Optimizer routine ^DIOQ.
157 ;;^DD(.4014,13,"DT")
158 ;;=2930125
159 ;;^DD(.4014,14,0)
160 ;;=PROBABILITY RATING^NJ9,4^^SER;2^K:+X'=X!(X>9999.9999)!(X<0)!(X?.E1"."5N.N) X
161 ;;^DD(.4014,14,3)
162 ;;=Type a Number between 0 and 9999.9999, 4 Decimal Digits. Probability of field meeting the sort criteria--returned by Query Optimizer routine.
163 ;;^DD(.4014,14,21,0)
164 ;;=^^6^6^2930125^^
Note: See TracBrowser for help on using the repository browser.