Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
blob: bb1e7300dd122ec864954ab3d03d1698a5439c34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
<?xml version="1.0"?>
<!--
  Input/output map validation

  Copyright (C) 2016 LoVullo Associates, Inc.

    This file is part of TAME.

    TAME is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see
    <http://www.gnu.org/licenses/>.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://www.lovullo.com/rater/map"
  xmlns="http://www.lovullo.com/rater/map"
  elementFormDefault="qualified">


  <xs:complexType name="classDescriptorType">
    <xs:attribute name="name" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Classification name (lv:classify/@as)
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="ignores-eligibility" type="xs:boolean">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Classification should not add a match requiring that at least one
          eligible supplier use it (if supported by implementation)
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>


  <xs:simpleType name="valueType">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        String constant
      </xs:documentation>
    </xs:annotation>

    <xs:restriction base="xs:string" />
  </xs:simpleType>


  <xs:complexType name="defaultType">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        Default complex value for a translation

        Concatenates each value.
      </xs:documentation>
    </xs:annotation>

    <xs:choice maxOccurs="unbounded">
      <xs:element name="from" type="fromType"
                  minOccurs="0" maxOccurs="unbounded" />
      <xs:element name="value" type="valueType"
                  minOccurs="0" maxOccurs="unbounded" />
    </xs:choice>
  </xs:complexType>


  <xs:complexType name="translateType">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        Defines a translation for a given value
      </xs:documentation>
    </xs:annotation>

    <xs:choice maxOccurs="unbounded">
      <xs:element name="from" type="fromType"
                  minOccurs="0" maxOccurs="unbounded" />
      <xs:element name="value" type="valueType"
                  minOccurs="0" maxOccurs="unbounded" />
    </xs:choice>

    <xs:attribute name="key" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Source value to match against for translation
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="value" type="xs:string">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Value to translate to
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="empty" type="xs:string">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Default value when the resulting translation is the
          empty string
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>


  <xs:complexType name="fromType">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        Defines translation rules between source and destination fields; not
        to be used with @from
      </xs:documentation>
    </xs:annotation>

    <xs:choice maxOccurs="unbounded">
      <!-- translation rule -->
      <xs:element name="translate" type="translateType"
                  minOccurs="0" maxOccurs="unbounded" />
      <xs:element name="default" type="defaultType"
                  minOccurs="0" maxOccurs="unbounded" />
    </xs:choice>

    <xs:attribute name="name" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Identifier of source field
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="default" type="xs:string">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Optional default value if no source value is available
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="scalar" type="xs:boolean">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Whether to force result to a scalar
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="affects-eligibility" type="xs:boolean">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Whether this field should be considered when generating eligibility
          classes (if supported by implementation); default true
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>


  <xs:group name="setTransformGroup">
    <xs:choice>
      <xs:element name="set" type="setType" />


      <xs:element name="const">
        <xs:annotation>
          <xs:documentation xml:lang="en">
            Maps a static value
          </xs:documentation>
        </xs:annotation>

        <xs:complexType>
          <xs:attribute name="value" type="xs:string" use="required">
            <xs:annotation>
              <xs:documentation xml:lang="en">
                Static value to map to destination
              </xs:documentation>
            </xs:annotation>
          </xs:attribute>
        </xs:complexType>
      </xs:element>


      <xs:element name="from">
        <xs:annotation>
          <xs:documentation xml:lang="en">
            Maps a source value to its destination by index
          </xs:documentation>
        </xs:annotation>

        <xs:complexType>
          <xs:attribute name="name" type="xs:string" use="required">
            <xs:annotation>
              <xs:documentation xml:lang="en">
                Source field identifier
              </xs:documentation>
            </xs:annotation>
          </xs:attribute>

          <xs:attribute name="index" type="xs:string" use="required">
            <xs:annotation>
              <xs:documentation xml:lang="en">
                Iterator variable or constant integer representing the source
                value index
              </xs:documentation>
            </xs:annotation>
          </xs:attribute>
        </xs:complexType>
      </xs:element>
    </xs:choice>
  </xs:group>


  <xs:complexType name="setType">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        Translates source data into a set
      </xs:documentation>
    </xs:annotation>

    <xs:sequence>
      <xs:group ref="setTransformGroup" minOccurs="1" maxOccurs="unbounded" />
    </xs:sequence>

    <xs:attribute name="each" type="xs:string">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Source field identifier to use as index for the iterator
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="index" type="xs:string">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Variable to serve as a reference for the iterator index
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="ignore-empty" type="xs:boolean">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          When true, if a transformation yields a value that is undefined, an
          empty string, or the string "0", then omit it from the set
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>


  <xs:complexType name="mapType">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        Defines a map from a source field to a destination field with optional
        transformation rules
      </xs:documentation>
    </xs:annotation>

    <xs:sequence>
      <xs:element name="from" type="fromType" minOccurs="0" maxOccurs="1" />
      <xs:element name="set"  type="setType"  minOccurs="0" maxOccurs="1" />
    </xs:sequence>

    <xs:attribute name="to" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Identifier of destination field
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="from" type="xs:string">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Identifier of source field if no data transformations are to be
          performed; cannot be used with @value
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="value" type="xs:string">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Constant value to be mapped to destination; cannot be used with @from
          or from node
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="affects-eligibility" type="xs:boolean">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Whether this field should be considered when generating eligibility
          classes (if supported by implementation); default true
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="override" type="xs:boolean">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Override mapping sharing the same destination identifier in an
          imported package
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>


  <xs:complexType name="passType">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        Maps from a source field to a destination field of the same name without
        any translation; shorthand for identical @to and @from attributes on a
        general map node
      </xs:documentation>
    </xs:annotation>

    <xs:attribute name="name" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Identifier of the source (and consequently destination) field
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="novalidate" type="xs:boolean">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Do not validate that the field exists; useful for mapping data that is
          not explicitly recognized as a field by the source
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="affects-eligibility" type="xs:boolean">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Whether this field should be considered when generating eligibility
          classes (if supported by implementation); default true
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="override" type="xs:boolean">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Override mapping sharing the same destination identifier in an
          imported package
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>


  <!-- represents some type of mapping -->
  <xs:group name="mappingGroup">
    <xs:choice>
      <xs:element name="map" type="mapType"
        minOccurs="0" maxOccurs="unbounded" />
      <xs:element name="pass" type="passType"
        minOccurs="0" maxOccurs="unbounded" />
    </xs:choice>
  </xs:group>


  <xs:complexType name="importType">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        Includes mappings from another source file
      </xs:documentation>
    </xs:annotation>

    <xs:attribute name="path" type="xs:string">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Path to source map file
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>

    <xs:attribute name="package" type="xs:string">
      <xs:annotation>
        <xs:documentation xml:lang="en">
          Path to source package
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>


  <xs:element name="program-map">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        Maps program data between two points
      </xs:documentation>
    </xs:annotation>

    <xs:complexType>
      <xs:sequence>
        <xs:any namespace="##any" minOccurs="0" maxOccurs="unbounded"
                processContents="lax" />

        <xs:element name="import" type="importType"
          minOccurs="0" maxOccurs="unbounded" />
        <xs:element name="class" type="classDescriptorType"
          minOccurs="0" maxOccurs="unbounded" />

        <xs:group ref="mappingGroup" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>

      <xs:attribute name="src" type="xs:string" use="required">
        <xs:annotation>
          <xs:documentation xml:lang="en">
            Source document to validate against (document root node must be
            known to the implementation)
          </xs:documentation>
        </xs:annotation>
      </xs:attribute>
    </xs:complexType>
  </xs:element>


  <xs:element name="return-map">
    <xs:annotation>
      <xs:documentation xml:lang="en">
        Specifies data transformations/filtering to be performed on data before
        being returned to a caller
      </xs:documentation>
    </xs:annotation>

    <xs:complexType>
      <xs:sequence>
        <xs:element name="import" type="importType"
          minOccurs="0" maxOccurs="unbounded" />

        <xs:group ref="mappingGroup" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>