-
Notifications
You must be signed in to change notification settings - Fork 0
/
RiverscapesProject.xsd
540 lines (460 loc) · 20.1 KB
/
RiverscapesProject.xsd
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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsL="http://www.w3.org/2001/XMLSchema">
<!-- This is the very top level TEST -->
<xs:element name="Project">
<xs:complexType>
<xs:all>
<xs:element type="xs:string" name="Name" />
<xs:element type="xs:string" name="ProjectType" />
<xs:element type="WarehouseType" name="Warehouse" minOccurs="0" />
<xs:element type="xs:string" name="Summary" minOccurs="0" />
<xs:element type="xs:string" name="Description" minOccurs="0" />
<xs:element type="xs:string" name="Citation" minOccurs="0" />
<xs:element type="MetaDataType" name="MetaData">
<xs:unique name="UniqueMetadataKeys">
<xs:selector xpath="./Meta" />
<xs:field xpath="@name" />
</xs:unique>
</xs:element>
<xs:element type="QAQCEventsType" name="QAQCEvents" minOccurs="0" />
<xs:element type="DataSetContainerType" name="CommonDatasets" minOccurs="0">
<xs:unique name="UniqueIdsInsideCommonDatasets">
<xs:selector xpath=".//*" />
<xs:field xpath="@id" />
</xs:unique>
</xs:element>
<xs:element type="ProjectBoundsType" name="ProjectBounds" minOccurs="0" />
<xs:element name="Realizations">
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element type="RealizationType" name="Realization" maxOccurs="unbounded"
minOccurs="0">
<xs:unique name="UniqueIdsInsideRealization">
<xs:selector xpath=".//*" />
<xs:field xpath="@id" />
</xs:unique>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
<!-- Realization IDs must be unique -->
<xs:unique name="UniqueRealizationId">
<xs:selector xpath="Realizations/Realization" />
<xs:field xpath="@id" />
</xs:unique>
<!-- Input keys are referenceable -->
<xs:keyref name="InputIdRef" refer="UniqueIdsInsideCommonDatasets">
<xs:selector xpath=".//CommonDatasets" />
<xs:field xpath="@ref" />
</xs:keyref>
</xs:element>
<!-- The warehouse tag indicates how this project is stored in the warehouse -->
<xs:complexType name="WarehouseType" mixed="true">
<xs:attribute type="GUIDType" name="id" use="required" />
<xs:attribute type="WarehouseUrlType" name="apiUrl" use="required" />
<xs:attribute type="xs:string" name="ref" />
</xs:complexType>
<!-- =========================================================================
Common Elements:
- All projects must have the Following:
============================================================================== -->
<!-- A Project can have realizations -->
<xs:complexType name="RealizationType" mixed="true">
<xs:all>
<xs:element type="xs:string" name="Name" />
<xs:element type="xs:string" name="Summary" minOccurs="0" />
<xs:element type="xs:string" name="Description" minOccurs="0" />
<xs:element type="xs:string" name="Citation" minOccurs="0" />
<xs:element type="MetaDataType" name="MetaData" minOccurs="0">
<xs:unique name="UniqueRealMetadataKeys">
<xs:selector xpath="./Meta" />
<!-- Choose the name attribute inside the <Meta> element -->
<xs:field xpath="@name" />
</xs:unique>
</xs:element>
<xs:element name="Logs" minOccurs="0">
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element type="SimpleFileType" name="LogFile" />
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element type="DataSetContainerType" name="Datasets" minOccurs="0" />
<xs:element type="DataSetContainerType" name="Inputs" minOccurs="0" />
<xs:element type="DataSetContainerType" name="Intermediates" minOccurs="0" />
<xs:element type="DataSetContainerType" name="Outputs" minOccurs="0" />
<xs:element type="AnalysesType" name="Analyses" minOccurs="0">
<xs:unique name="UniqueIdsInsideAnalyses">
<xs:selector xpath="./*" />
<xs:field xpath="@id" />
</xs:unique>
</xs:element>
</xs:all>
<xs:attribute type="ProjectIdType" name="id" use="required" />
<xs:attribute type="xs:string" name="dateCreated" use="required" />
<xs:attribute type="VersionType" name="productVersion" use="required" />
</xs:complexType>
<!--Realizations
can have an Analyses-->
<xs:complexType name="AnalysesType" mixed="true">
<xs:sequence>
<xs:element name="Analysis" maxOccurs="unbounded" minOccurs="0">
<xs:complexType mixed="true">
<xs:all>
<xs:element type="xs:string" name="Name" minOccurs="0" />
<xs:element type="xs:string" name="Summary" minOccurs="0" />
<xs:element type="xs:string" name="Description" minOccurs="0" />
<xs:element type="xs:string" name="Citation" minOccurs="0" />
<xs:element type="MetricsType" name="Metrics" minOccurs="0" />
<xs:element type="MetaDataType" name="MetaData" minOccurs="0">
<xs:unique name="UniqueAnalysisMetadataKeys">
<xs:selector xpath="./Meta" />
<!-- Choose the name attribute inside the <Meta> element -->
<xs:field xpath="@name" />
</xs:unique>
</xs:element>
<xs:element type="DataSetContainerType" name="Configuration" minOccurs="0" />
<xs:element type="DataSetContainerType" name="Products" minOccurs="0" />
</xs:all>
<xs:attribute type="ProjectIdType" name="id" use="required" />
</xs:complexType>
<xs:unique name="UniqueProductIdsInsideAnalyses">
<xs:selector xpath="./Products/*" />
<xs:field xpath="@id" />
</xs:unique>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="MetaType">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute type="xs:string" name="name" use="required" />
<xs:attribute type="MetaKeyValueType" name="type" use="optional" />
<xs:attribute type="xsL:boolean" name="locked" use="optional" />
<xs:attribute type="MetaKeySrcType" name="ext" use="optional" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="MetaDataType">
<xs:sequence>
<xs:element type="MetaType" name="Meta" maxOccurs="unbounded" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="ParamType">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute type="xs:string" name="name" use="required" />
<xs:attribute type="MetaKeyValueType" name="type" use="optional" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="MetricType">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute type="xs:string" name="name" use="required" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="MetricsType">
<xs:sequence>
<xs:element type="MetricType" name="Metric" maxOccurs="unbounded" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<!-- =========================================================================
Datasets: Inputs, Outputs, files etc....
============================================================================== -->
<!-- Let's define our Input/Output Containers and what they can contain -->
<xs:complexType name="DataSetContainerType">
<xs:choice maxOccurs="unbounded" minOccurs="0">
<!-- References can also be used here -->
<xs:element type="CommonDatasetsRefType" name="CommonDatasetRef" />
<!-- A scalar value is possible as an input or an output but use <Params> if you can -->
<xs:element type="RasterType" name="Raster" />
<xs:element type="VectorType" name="Vector" />
<xs:element type="GeopackageType" name="Geopackage" />
<xs:element type="TINType" name="TIN" />
<xs:element type="DEMType" name="DEM" />
<xs:element type="HillShadeType" name="HillShade" />
<xs:element type="SimpleFileType" name="ConfigFile" />
<xs:element type="SimpleFileType" name="CSV" />
<xs:element type="SimpleFileType" name="Image" />
<xs:element type="SimpleFileType" name="Video" />
<xs:element type="SimpleFileType" name="DataTable" />
<xs:element type="SimpleFileType" name="Database" />
<xs:element type="SimpleFileType" name="SurveyQualityDB" />
<xs:element type="SimpleFileType" name="InstrumentFile" />
<xs:element type="SimpleFileType" name="AuxInstrumentFile" />
<xs:element type="SimpleFileType" name="MSAccessDB" />
<xs:element type="SimpleFileType" name="SQLiteDB" />
<xs:element type="SimpleFileType" name="PDF" />
<xs:element type="SimpleFileType" name="HTMLFile" />
<xs:element type="SimpleFileType" name="ZipFile" />
<xs:element type="SimpleFileType" name="LogFile" />
<!-- Last resort catch-all for anything we don't support -->
<xs:element type="SimpleFileType" name="File" />
</xs:choice>
</xs:complexType>
<!-- The base type -->
<xs:complexType name="DatasetType" mixed="true">
<xs:all>
<xs:element type="xs:string" name="Name" minOccurs="1" />
<xs:element type="xs:string" name="Summary" minOccurs="0" />
<xs:element type="xs:string" name="Description" minOccurs="0" />
<xs:element type="xs:string" name="Citation" minOccurs="0" />
<xs:element type="UnixPathType" name="Path" />
<xs:element type="MetaDataType" name="MetaData" minOccurs="0">
<xs:unique name="UniqueDSMetadataKeys">
<xs:selector xpath="./Meta" />
<!-- Choose the name attribute inside the <Meta> element -->
<xs:field xpath="@name" />
</xs:unique>
</xs:element>
</xs:all>
<xs:attribute type="ProjectIdType" name="id" use="required" />
<!-- Types are useful to have another attribute other than "id" to xpath search. This is mainly for business logic-->
<xs:attribute type="xs:string" name="type" use="optional" />
<xs:attribute type="ExternalReferenceType" name="extRef" use="optional" />
</xs:complexType>
<!-- Geopackage layers cannot reference external projects -->
<xs:complexType name="GeopackageDatasetType" mixed="true">
<xs:all>
<xs:element type="xs:string" name="Name" minOccurs="0" />
<xs:element type="xs:string" name="Summary" minOccurs="0" />
<xs:element type="xs:string" name="Description" minOccurs="0" />
<xs:element type="xs:string" name="Citation" minOccurs="0" />
<xs:element type="MetaDataType" name="MetaData" minOccurs="0" />
</xs:all>
<xs:attribute type="xs:string" name="lyrName" use="required" />
<xs:attribute type="xs:string" name="type" use="optional" />
<xs:attribute type="ExternalReferenceType" name="extRef" use="optional" />
</xs:complexType>
<xs:complexType name="CommonDatasetsRefType" mixed="true">
<xs:all>
<xs:element type="xs:string" name="Name" minOccurs="0" />
<xs:element type="MetaDataType" name="MetaData" minOccurs="0" />
</xs:all>
<xs:attribute type="xs:string" name="ref" use="required" />
</xs:complexType>
<!-- Now some Subtypes -->
<xs:complexType name="GeoSpatialType">
<xs:complexContent>
<xs:extension base="DatasetType" />
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ContextLayerType" mixed="true">
<xs:all>
<xs:element type="xs:string" name="Name" minOccurs="0" />
<xs:element type="xs:string" name="Summary" minOccurs="0" />
<xs:element type="xs:string" name="Description" minOccurs="0" />
<xs:element type="xs:string" name="Citation" minOccurs="0" />
<xs:element type="UnixPathType" name="Path" />
<xs:element type="MetaDataType" name="MetaData" minOccurs="0">
<xs:unique name="UniqueDSCtxMetadataKeys">
<xs:selector xpath="./Meta" />
<!-- Choose the name attribute inside the <Meta> element -->
<xs:field xpath="@name" />
</xs:unique>
</xs:element>
<xs:element type="xs:string" name="URL" default="http://" minOccurs="0" />
</xs:all>
<xs:attribute type="ProjectIdType" name="id" use="required" />
<xs:attribute type="xs:string" name="type" use="optional" />
<xs:attribute type="ExternalReferenceType" name="extRef" use="optional" />
</xs:complexType>
<xs:complexType name="SimpleFileType">
<xs:complexContent>
<xs:extension base="DatasetType" />
</xs:complexContent>
</xs:complexType>
<!-- Here are the GeoSpatial Types They are explicitly defined in case we need to extend them
later -->
<xs:complexType name="RasterType">
<xs:complexContent>
<xs:extension base="GeoSpatialType" />
</xs:complexContent>
</xs:complexType>
<xs:complexType name="TINType">
<xs:complexContent>
<xs:extension base="GeoSpatialType" />
</xs:complexContent>
</xs:complexType>
<xs:complexType name="VectorType">
<xs:complexContent>
<xs:extension base="GeoSpatialType" />
</xs:complexContent>
</xs:complexType>
<xs:complexType name="GeopackageType" mixed="true">
<xs:all>
<xs:element type="xs:string" name="Name" minOccurs="0" />
<xs:element type="xs:string" name="Summary" minOccurs="0" />
<xs:element type="xs:string" name="Description" minOccurs="0" />
<xs:element type="xs:string" name="Citation" minOccurs="0" />
<xs:element type="UnixPathType" name="Path" />
<xs:element type="MetaDataType" name="MetaData" minOccurs="0">
<xs:unique name="UniqueGPKGMetadataKeys">
<xs:selector xpath="./Meta" />
<!-- Choose the name attribute inside the <Meta> element -->
<xs:field xpath="@name" />
</xs:unique>
</xs:element>
<xs:element type="GeopackageLayersType" name="Layers" />
</xs:all>
<xs:attribute type="ProjectIdType" name="id" use="required" />
<xs:attribute type="xs:string" name="type" use="optional" />
<xs:attribute type="ExternalReferenceType" name="extRef" use="optional" />
</xs:complexType>
<xs:complexType name="GeopackageLayersType">
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element type="GeopackageDatasetType" name="Raster" />
<xs:element type="GeopackageDatasetType" name="Vector" />
<xs:element type="GeopackageDatasetType" name="DataTable" />
</xs:choice>
</xs:complexType>
<!-- DEMs extend rasters -->
<xs:complexType name="DEMType">
<xs:complexContent>
<xs:extension base="RasterType" />
</xs:complexContent>
</xs:complexType>
<!-- Here are our context layers -->
<xs:complexType name="HillShadeType">
<xs:complexContent>
<xs:extension base="ContextLayerType" />
</xs:complexContent>
</xs:complexType>
<xs:complexType name="QAQCEventsType">
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element type="QAQCEventType" name="QAQCEvent" />
</xs:choice>
</xs:complexType>
<xs:complexType name="QAQCEventType" mixed="true">
<xs:all>
<xs:element type="xs:string" name="Name" />
<xs:element type="xs:string" name="PerformedBy" minOccurs="0" />
<xs:element type="xs:string" name="Summary" minOccurs="0" />
<xs:element type="xs:string" name="Description" minOccurs="0" />
<xs:element type="xs:string" name="Citation" minOccurs="0" />
<xs:element name="Links" minOccurs="0">
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element name="URL">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute type="xs:string" name="text" />
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element type="MetaDataType" name="MetaData" minOccurs="0" />
</xs:all>
<xs:attribute type="QAQCState" name="state" />
<xs:attribute type="xs:string" name="datePerformed" />
</xs:complexType>
<!-- =========================================================================
Project Bounds: We introduced these to add a geospatial element to our projects
============================================================================== -->
<xs:complexType name="ProjectBoundsType" mixed="true">
<xs:all>
<xs:element type="CentroidType" name="Centroid" />
<xs:element type="BoundingBoxType" name="BoundingBox" />
<xs:element type="UnixPathType" name="Path" />
</xs:all>
</xs:complexType>
<xs:complexType name="CentroidType" mixed="true">
<xs:all>
<xs:element type="xs:string" name="Lat" />
<xs:element type="xs:string" name="Lng" />
</xs:all>
</xs:complexType>
<xs:complexType name="BoundingBoxType" mixed="true">
<xs:all>
<xs:element type="xs:string" name="MinLat" />
<xs:element type="xs:string" name="MinLng" />
<xs:element type="xs:string" name="MaxLat" />
<xs:element type="xs:string" name="MaxLng" />
</xs:all>
</xs:complexType>
<!-- =========================================================================
Simple types so we can validate better
============================================================================== -->
<!-- Generic constraints on IDs -->
<xs:simpleType name="ProjectIdType">
<xs:restriction base="xs:string">
<xs:minLength value="3" />
<xs:maxLength value="64" />
<xs:pattern value="[A-Za-z0-9_-]+" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="GUIDType">
<xs:restriction base="xs:string">
<xs:length value="36" />
<xs:pattern value="[0-9a-zA-Z-]+" />
</xs:restriction>
</xs:simpleType>
<!-- Note that we allow whitespace "\s*" before and after paths. we need to make sure this
is stripped out in any parsers -->
<xs:simpleType name="UnixPathType">
<xs:restriction base="xs:string">
<xs:maxLength value="256" />
<xs:pattern value="\s*([A-Za-z0-9_.-]+/)*[A-Za-z0-9_.-]+\s*" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="VersionType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]+\.[0-9]+\.[0-9]+[a-z-]*" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ExternalReferenceType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9a-zA-Z-]{36,}:Project/[A-Za-z0-9_/#-]+" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="WarehouseUrlType">
<xs:restriction base="xs:anyURI">
<xs:pattern value="https?://.+" />
</xs:restriction>
</xs:simpleType>
<!-- The type of string in the <Meta> tag. These are optional -->
<xs:simpleType name="MetaKeyValueType">
<xs:restriction base="xs:string">
<xs:enumeration value="guid" />
<xs:enumeration value="url" />
<xs:enumeration value="filepath" />
<xs:enumeration value="image" />
<xs:enumeration value="video" />
<xs:enumeration value="isodate" />
<xs:enumeration value="timestamp" />
<xs:enumeration value="float" />
<xs:enumeration value="boolean" />
<xs:enumeration value="int" />
<xs:enumeration value="richtext" />
<xs:enumeration value="markdown" />
<xs:enumeration value="json" />
<!-- Hidden just means this is rarely useful to humans so never render it directly
(it's not secret or private)
-->
<xs:enumeration value="hidden" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="QAQCState">
<xs:restriction base="xs:string">
<xs:enumeration value="passed" />
<xs:enumeration value="failed" />
<xs:enumeration value="provisional" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="MetaKeySrcType">
<xs:restriction base="xs:string">
<xs:enumeration value="warehouse" />
<xs:enumeration value="project" />
<xs:enumeration value="dataset" />
</xs:restriction>
</xs:simpleType>
</xs:schema>