/[volute]/trunk/projects/registry/SimpleDALRegExt/SSA-v1.3.xsd
ViewVC logotype

Contents of /trunk/projects/registry/SimpleDALRegExt/SSA-v1.3.xsd

Parent Directory Parent Directory | Revision Log Revision Log


Revision 5920 - (show annotations)
Wed Dec 16 09:31:00 2020 UTC (4 months ago) by msdemlei
File size: 22213 byte(s)
Preparing for PR-1.2.


1 <?xml version="1.0" encoding="UTF-8"?>
2 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
3 xmlns:vr="http://www.ivoa.net/xml/VOResource/v1.0"
4 xmlns:ssap="http://www.ivoa.net/xml/SSA/v1.1"
5 xmlns:vm="http://www.ivoa.net/xml/VOMetadata/v0.1"
6 targetNamespace="http://www.ivoa.net/xml/SSA/v1.1"
7 elementFormDefault="unqualified" attributeFormDefault="unqualified"
8 version="1.3-pr">
9
10 <xs:annotation>
11 <xs:appinfo>
12 <vm:schemaName>SSA</vm:schemaName>
13 <vm:schemaPrefix>xs</vm:schemaPrefix>
14 <vm:targetPrefix>ssap</vm:targetPrefix>
15 </xs:appinfo>
16 <xs:documentation>
17 XML Schema used to describe the capabilities of a service instance
18 conforming to the Simple Spectral Access (SSA) protocol.
19 </xs:documentation>
20 </xs:annotation>
21
22 <xs:import namespace="http://www.ivoa.net/xml/VOResource/v1.0"
23 schemaLocation="http://www.ivoa.net/xml/VOResource/v1.0"/>
24
25 <!-- SSA Capabilities -->
26 <xs:complexType name="SimpleSpectralAccess">
27 <xs:annotation>
28 <xs:documentation>
29 The capabilities of an SSA service implementation.
30 </xs:documentation>
31 </xs:annotation>
32
33 <xs:complexContent>
34 <xs:extension base="vr:Capability">
35 <xs:sequence>
36
37 <xs:element name="complianceLevel" type="ssap:ComplianceLevel">
38 <xs:annotation>
39 <xs:documentation>
40 The category indicating the level to which
41 this instance complies with the SSA standard.
42 </xs:documentation>
43 <xs:documentation>
44 Allowed values are "query", "minimal", and "full".
45 See definitions of allowed values for details.
46 </xs:documentation>
47 </xs:annotation>
48 </xs:element>
49
50 <xs:element name="productType" type="xs:token"
51 minOccurs="0" maxOccurs="unbounded">
52 <xs:annotation>
53 <xs:documentation>
54 The type of data product served by this
55 service, with each element declaring one
56 of http://www.ivoa.net/rdf/product-type.
57 </xs:documentation>
58 <xs:documentation>
59 If no productType is declared, clients can assume
60 the service serves spectra. Spectral services
61 should still declare “spectrum” here.
62 </xs:documentation>
63 </xs:annotation>
64 </xs:element>
65
66 <xs:element name="dataSource" type="ssap:DataSource"
67 minOccurs="1" maxOccurs="unbounded">
68 <xs:annotation>
69 <xs:documentation>
70 The category specifying where the data originally
71 came from.
72 </xs:documentation>
73 <xs:documentation>
74 Allowed values are "survey", "pointed", "custom",
75 "theory", "artificial"
76 </xs:documentation>
77 </xs:annotation>
78 </xs:element>
79
80 <xs:element name="creationType" type="ssap:CreationType"
81 minOccurs="1" maxOccurs="unbounded">
82 <xs:annotation>
83 <xs:documentation>
84 The category that describes the process used to
85 produce the dataset.
86 </xs:documentation>
87 <xs:documentation>
88 Typically this describes only the processing
89 performed by the data service, but it could
90 describe some additional earlier processing as
91 well, e.g., if data is partially precomputed.
92 </xs:documentation>
93 <xs:documentation>
94 Allowed values are "archival", "cutout", "filtered",
95 "mosaic", "projection", "spectralExtraction",
96 "catalogExtraction"
97 </xs:documentation>
98 </xs:annotation>
99 </xs:element>
100
101 <xs:element name="supportedFrame" type="xs:token"
102 minOccurs="1" maxOccurs="unbounded">
103 <xs:annotation>
104 <xs:documentation>
105 Identifiers of spatial reference frames that can be used
106 in the POS parameter. The identifiers must be taken
107 from the vocabulary http://www.ivoa.net/rdf/refframe.
108 </xs:documentation>
109 <xs:documentation>
110 At least one recognized value must be listed
111 when the service supports POS.
112 With SSA v1.1, ICRS must be supported in that
113 case; thus,
114 this list must include at least this value.
115 </xs:documentation>
116 </xs:annotation>
117 </xs:element>
118
119 <xs:element name="maxSearchRadius" type="xs:double"
120 minOccurs="0" maxOccurs="1">
121 <xs:annotation>
122 <xs:documentation>
123 The largest search radius, in degrees, that will be
124 accepted by the service without returning an error
125 condition. Not providing this element or
126 specifying a value of 180 indicates that there
127 is no restriction.
128 </xs:documentation>
129 <xs:documentation>
130 Not providing a value is the prefered way to indicate
131 that there is no restriction.
132 </xs:documentation>
133 </xs:annotation>
134 </xs:element>
135
136 <xs:element name="maxRecords" type="xs:positiveInteger"
137 minOccurs="0" maxOccurs="1">
138 <xs:annotation>
139 <xs:documentation>
140 The hard limit on the largest number of records that
141 the query operation will return in a single response.
142 Not providing this value means that there is no
143 effective limit.
144 </xs:documentation>
145 <xs:documentation>
146 This does not refer to the total number of spectra in
147 the archive but rather maximum number of records the
148 service is capable of returning. A limit that is
149 greater than the number of spectra available in the
150 archive is equivalent to their being no effective
151 limit. (See RM, Hanisch 2007.)
152 </xs:documentation>
153 </xs:annotation>
154 </xs:element>
155
156 <xs:element name="defaultMaxRecords" type="xs:positiveInteger"
157 minOccurs="0" maxOccurs="1">
158 <xs:annotation>
159 <xs:documentation>
160 The largest number of records that the service will
161 return when the MAXREC parameter not specified
162 in the query input. Not providing a value means
163 that the hard limit implied by maxRecords will be
164 the default limit.
165 </xs:documentation>
166 </xs:annotation>
167 </xs:element>
168
169 <xs:element name="maxAperture" type="xs:double"
170 minOccurs="0" maxOccurs="1">
171 <xs:annotation>
172 <xs:documentation>
173 The largest aperture that can be supported upon
174 request via the APERTURE input parameter by a
175 service that supports the spectral extraction
176 creation method. A value of 180 or not providing
177 a value means there is no theoretical limit.
178 </xs:documentation>
179 <xs:documentation>
180 Not providing a value is the preferred way to
181 indicate that there is no limit.
182 </xs:documentation>
183 </xs:annotation>
184 </xs:element>
185
186 <xs:element name="maxFileSize" type="xs:positiveInteger"
187 minOccurs="0" maxOccurs="1">
188 <xs:annotation>
189 <xs:documentation>
190 The maximum spectrum file size in bytes that will
191 be returned. Not providing
192 a value indicates that there is no effective limit
193 the size of files that can be returned.
194 </xs:documentation>
195 <xs:documentation>
196 This is primarily relevant when spectra are created
197 on the fly (see creationType). If the service
198 provides access to static spectra, this should only
199 be specified if there are spectra in the archive that
200 can be searched for but not returned because they are
201 too big.
202 </xs:documentation>
203 </xs:annotation>
204 </xs:element>
205
206 <xs:element name="testQuery" type="ssap:Query"
207 minOccurs="0" maxOccurs="1">
208 <xs:annotation>
209 <xs:documentation>
210 a set of query parameters that is expected to
211 produce at least one matched record which can be
212 used to test the service.
213 </xs:documentation>
214 </xs:annotation>
215 </xs:element>
216
217 </xs:sequence>
218 </xs:extension>
219 </xs:complexContent>
220 </xs:complexType>
221
222 <xs:simpleType name="ComplianceLevel">
223 <xs:annotation>
224 <xs:documentation>
225 The allowed values for indicating the level at which a
226 service instance complies with the SSA standard.
227 </xs:documentation>
228 </xs:annotation>
229
230 <xs:restriction base="xs:token">
231 <xs:enumeration value="query">
232 <xs:annotation>
233 <xs:documentation>
234 The service supports all of the capabilities and features
235 of the SSA protocol identified as "must" in the
236 specification, except that it does not support returning
237 data in at least one SSA-compliant format.
238 </xs:documentation>
239 <xs:documentation>
240 This level represents the lowest level of compliance.
241 </xs:documentation>
242 </xs:annotation>
243 </xs:enumeration>
244
245 <xs:enumeration value="minimal">
246 <xs:annotation>
247 <xs:documentation>
248 The service supports all of the capabilities and features
249 of the SSA protocol identified as "must" in the
250 specification.
251 </xs:documentation>
252 <xs:documentation>
253 In brief, this includes:
254 * implementing the GET interface,
255 * support the parameters POS, SIZE, TOME, BAND, and
256 FORMAT
257 * includes all mandatory metadata fields in query
258 response
259 * supports getData method retrieval in at least one
260 SSA-compliant format
261 * supports the "FORMAT=METADATA" metadata query.
262 </xs:documentation>
263 <xs:documentation>
264 This level represents the middle level of compliance.
265 </xs:documentation>
266 </xs:annotation>
267 </xs:enumeration>
268
269 <xs:enumeration value="full">
270 <xs:annotation>
271 <xs:documentation>
272 The service supports all of the capabilities and features
273 of the SSA protocol identified as "must" or "should" in the
274 specification.
275 </xs:documentation>
276 <xs:documentation>
277 This level represents the highest level of compliance.
278 </xs:documentation>
279 </xs:annotation>
280 </xs:enumeration>
281 </xs:restriction>
282 </xs:simpleType>
283
284 <xs:simpleType name="DataSource">
285 <xs:annotation>
286 <xs:documentation>
287 The defined categories that specify where the spectral data
288 originally came from.
289 </xs:documentation>
290 </xs:annotation>
291
292 <xs:restriction base="xs:token">
293 <xs:enumeration value="survey">
294 <xs:annotation>
295 <xs:documentation>
296 A survey dataset, which typically covers some region of
297 observational parameter space in a uniform fashion, with
298 as complete as possible coverage in the region of parameter
299 space observed.
300 </xs:documentation>
301 </xs:annotation>
302 </xs:enumeration>
303
304 <xs:enumeration value="pointed">
305 <xs:annotation>
306 <xs:documentation>
307 A pointed observation of a particular astronomical object
308 or field.
309 </xs:documentation>
310 <xs:documentation>
311 Typically, these are instrumental observations taken as
312 part of some PI observing program. The data quality and
313 characteristics may be variable, but the observations of
314 a particular object or field may be more extensive than
315 for a survey.
316 </xs:documentation>
317 </xs:annotation>
318 </xs:enumeration>
319
320 <xs:enumeration value="custom">
321 <xs:annotation>
322 <xs:documentation>
323 Data which has been custom processed, e.g., as part of
324 a specific research project.
325 </xs:documentation>
326 </xs:annotation>
327 </xs:enumeration>
328
329 <xs:enumeration value="theory">
330 <xs:annotation>
331 <xs:documentation>
332 Theory data, or any data generated from a theoretical
333 model, for example a synthetic spectrum.
334 </xs:documentation>
335 </xs:annotation>
336 </xs:enumeration>
337
338 <xs:enumeration value="artificial">
339 <xs:annotation>
340 <xs:documentation>
341 Artificial or simulated data.
342 </xs:documentation>
343 <xs:documentation>
344 This is similar to theory data but need not be based on
345 a physical model, and is often used for testing purposes.
346 </xs:documentation>
347 </xs:annotation>
348 </xs:enumeration>
349
350 </xs:restriction>
351 </xs:simpleType>
352
353 <xs:simpleType name="CreationType">
354 <xs:restriction base="xs:token">
355 <xs:enumeration value="archival">
356 <xs:annotation>
357 <xs:documentation>
358 The entire archival or project dataset is returned.
359 Transformations such as metadata or data model mediation
360 or format conversions may take place, but the content of
361 the dataset is not substantially modified (e.g., all the
362 data is returned and the sample values are not modified).
363 </xs:documentation>
364 </xs:annotation>
365 </xs:enumeration>
366
367 <xs:enumeration value="cutout">
368 <xs:annotation>
369 <xs:documentation>
370 The dataset is subsetted in some region of parameter
371 space to produce a subset dataset. Sample values are not
372 modified, e.g., cutouts could be recombined to reconstitute
373 the original dataset.
374 </xs:documentation>
375 </xs:annotation>
376 </xs:enumeration>
377
378 <xs:enumeration value="filtered">
379 <xs:annotation>
380 <xs:documentation>
381 The data is filtered in some fashion to exclude portions
382 of the dataset, e.g., passing only data in selected regions
383 along a measurement axis, or processing the data in a way
384 which recomputes the sample values, e.g., due to
385 interpolation or flux transformation.
386 </xs:documentation>
387 <xs:documentation>
388 Filtering is often
389 combined with other forms of processing, e.g., projection.
390 </xs:documentation>
391 </xs:annotation>
392 </xs:enumeration>
393
394 <xs:enumeration value="mosaic">
395 <xs:annotation>
396 <xs:documentation>
397 Data from multiple non- or partially-overlapping datasets
398 are combined to produce a new dataset.
399 </xs:documentation>
400 </xs:annotation>
401 </xs:enumeration>
402
403 <xs:enumeration value="projection">
404 <xs:annotation>
405 <xs:documentation>
406 Data is geometrically warped or dimensionally reduced by
407 projecting through a multidimensional dataset.
408 </xs:documentation>
409 </xs:annotation>
410 </xs:enumeration>
411
412 <xs:enumeration value="spectralExtraction">
413 <xs:annotation>
414 <xs:documentation>
415 Extraction of a spectrum from another dataset, e.g.,
416 extraction of a spectrum from a spectral data cube
417 through a simulated aperture.
418 </xs:documentation>
419 </xs:annotation>
420 </xs:enumeration>
421
422 <xs:enumeration value="catalogExtraction">
423 <xs:annotation>
424 <xs:documentation>
425 Extraction of a catalog of some form from another dataset,
426 e.g., extraction of a source catalog from an image, or
427 extraction of a line list catalog from a spectrum (not
428 valid for a SSA service).
429 </xs:documentation>
430 </xs:annotation>
431 </xs:enumeration>
432
433 </xs:restriction>
434 </xs:simpleType>
435
436 <xs:complexType name="Query">
437 <xs:annotation>
438 <xs:documentation>
439 A query to be sent to the service
440 </xs:documentation>
441 </xs:annotation>
442
443 <xs:sequence>
444 <xs:element name="pos" type="ssap:PosParam" minOccurs="0">
445 <xs:annotation>
446 <xs:documentation>
447 the center position the search cone given in
448 decimal degrees.
449 </xs:documentation>
450 </xs:annotation>
451 </xs:element>
452
453 <xs:element name="size" type="xs:double" minOccurs="0">
454 <xs:annotation>
455 <xs:documentation>
456 the size of the search radius.
457 </xs:documentation>
458 </xs:annotation>
459 </xs:element>
460
461 <xs:element name="queryDataCmd" type="xs:string" minOccurs="0">
462 <xs:annotation>
463 <xs:documentation>
464 Fully specified test query formatted as an URL
465 argument list in the syntax specified by the SSA standard.
466 The list must exclude the REQUEST argument which is
467 assumed to be set to "queryData".
468 </xs:documentation>
469 <xs:documentation>
470 This value must be in the form of name=value
471 pairs delimited with ampersands (&amp;). A query
472 may then be formed by appending to the base URL the
473 request argument, "REQUEST=queryData&amp;", followed
474 by the contents of this element.
475 </xs:documentation>
476 </xs:annotation>
477 </xs:element>
478 </xs:sequence>
479 </xs:complexType>
480
481 <xs:complexType name="PosParam">
482 <xs:annotation>
483 <xs:documentation>
484 a position in the sky to search.
485 </xs:documentation>
486 </xs:annotation>
487
488 <xs:sequence>
489 <xs:element name="long" type="xs:double">
490 <xs:annotation>
491 <xs:documentation>
492 The longitude (e.g. Right Ascension) of the center of the
493 search position in decimal degrees.
494 </xs:documentation>
495 </xs:annotation>
496 </xs:element>
497
498 <xs:element name="lat" type="xs:double">
499 <xs:annotation>
500 <xs:documentation>
501 The latitude (e.g. Declination) of the center of the
502 search position in decimal degrees.
503 </xs:documentation>
504 </xs:annotation>
505 </xs:element>
506
507 <xs:element name="refframe" type="xs:token" minOccurs="0">
508 <xs:annotation>
509 <xs:documentation>
510 the coordinate system reference frame name indicating
511 the frame to assume for the given position. If not
512 provided, ICRS is assumed.
513 </xs:documentation>
514 </xs:annotation>
515 </xs:element>
516 </xs:sequence>
517 </xs:complexType>
518
519 </xs:schema>
520 <!-- vim:et:sta:sw=3
521 -->

msdemlei@ari.uni-heidelberg.de
ViewVC Help
Powered by ViewVC 1.1.26