source: TI01-discovery-API/trunk/MEDINDiscoveryService/src/main/resources/META-INF/DiscoverySchema.xsd @ 6657

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI01-discovery-API/trunk/MEDINDiscoveryService/src/main/resources/META-INF/DiscoverySchema.xsd@6657
Revision 6657, 15.8 KB checked in by mnagni, 11 years ago (diff)

Refactored the MetadataFormat? tag (again)

  • Property svn:mime-type set to text/plain
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2        <!--
3                Maurizio Nagni <maurizio.nagni@stcf.ac.uk>
4                (NERC Earth Observation Data Centre)
5        -->
6<xs:schema version="1.0" targetNamespace="http://medin.discovery.services.ndg/schema"
7        elementFormDefault="qualified" attributeFormDefault="unqualified"
8        xmlns:xs="http://www.w3.org/2001/XMLSchema"
9        xmlns:tns="http://medin.discovery.services.ndg/schema">
10
11        <!-- Request elements -->
12        <xs:element name="DoSearch" type="tns:SearchType"/>
13        <xs:element name="DoPresent" type="tns:PresentType"/>
14        <xs:element name="GetListNames" nillable="true"/>
15        <xs:element name="GetList" type="tns:GetListType"/>
16        <xs:complexType name="GetVersion"/>
17        <!-- Response elements -->
18        <xs:element name="DoSearchReturn" type="tns:SearchReturnType"/>
19        <xs:element name="DoPresentReturn" type="tns:PresentReturnType"/>
20        <xs:element name="GetListNamesReturn" type="tns:GetListNamesReturnType"/>
21        <xs:element name="GetListReturn" type="tns:GetListReturnType"/>
22
23        <xs:complexType name="GetVersionReturn">
24                <xs:complexContent>
25                        <xs:extension base="tns:GetVersionReturnType"/>
26                </xs:complexContent>
27        </xs:complexType>
28
29        <!-- Request global types -->
30        <xs:complexType name="PresentType">
31                <xs:sequence>
32                        <xs:element name="Documents" type="tns:SimpleDocument" maxOccurs="unbounded"/>
33
34                        <xs:element name="RetrieveCriteria" type="tns:RetrieveCriteriaType" minOccurs="0">
35                                <xs:annotation>
36                                        <xs:documentation>Comparison of a date dood  or date range to specified/default dates within metadata.</xs:documentation>
37                                </xs:annotation>
38                        </xs:element>
39                </xs:sequence>
40        </xs:complexType>
41
42        <xs:complexType name="RetrieveCriteriaType">
43                <xs:sequence>
44                        <xs:element name="OrderBy" type="tns:OrderByType" minOccurs="0" maxOccurs="unbounded">
45                                <xs:annotation>
46                                        <xs:documentation>Optional set of field(s) by which to order records in the result set and hence the search response. Direction can be specified alongside each field.</xs:documentation>
47                                </xs:annotation>
48                        </xs:element>
49                        <xs:element name="RecordDetail" type="xs:string" minOccurs="0">
50                                <xs:annotation>
51                                        <xs:documentation>Level of detail to be used for each record in the search response (before initiating doPresent). Values taken from recordDetailList. Default = "id", i.e. just the document id.
52                                        </xs:documentation>
53                                </xs:annotation>
54                        </xs:element>
55                        <xs:element name="MetadataFormat" type="xs:string" minOccurs="0" maxOccurs="1"/>               
56                </xs:sequence>
57        </xs:complexType>
58
59        <xs:complexType name="SearchType">
60                <xs:sequence>
61                        <xs:element name="SearchCriteria">
62                                <xs:annotation>
63                                        <xs:documentation>Must have at least one of : termSearch, spatialSearch, temporalSearch.</xs:documentation>
64                                </xs:annotation>
65                                <xs:complexType>
66                                        <xs:sequence>
67                                                <xs:element name="TermSearch" type="tns:TermSearchType" minOccurs="0"
68                                                        maxOccurs="unbounded">
69                                                        <xs:annotation>
70                                                                <xs:documentation>Can have multiple term searches - will treat multiple termSearches in "AND" combination, unless multiple instances of same termTarget, in which case "OR" combination is used for those with the same termTarget.</xs:documentation>
71                                                        </xs:annotation>
72                                                </xs:element>
73                                                <xs:element name="SpatialSearch" type="tns:SpatialType" minOccurs="0">
74                                                        <xs:annotation>
75                                                                <xs:documentation>Comparison of a single search bounding box to spatial coverage(s) of data.</xs:documentation>
76                                                        </xs:annotation>
77                                                </xs:element>
78                                                <xs:element name="TemporalSearch" type="tns:TemporalType" minOccurs="0">
79                                                        <xs:annotation>
80                                                                <xs:documentation>Comparison of a date or date range to specified/default dates within metadata.</xs:documentation>
81                                                        </xs:annotation>
82                                                </xs:element>
83                                        </xs:sequence>
84                                </xs:complexType>
85                        </xs:element>
86                        <xs:element name="RetrieveCriteria" type="tns:RetrieveCriteriaType" minOccurs="0">
87                                <xs:annotation>
88                                        <xs:documentation>Comparison of a date or date range to specified/default dates within metadata.</xs:documentation>
89                                </xs:annotation>
90                        </xs:element>
91                        <xs:element name="Start" type="xs:unsignedInt" minOccurs="0">
92                                <xs:annotation>
93                                        <xs:documentation>Sequential record number within result set used as first record within returned search response. Useful for pagination.</xs:documentation>
94                                </xs:annotation>
95                        </xs:element>
96                        <xs:element name="HowMany" type="xs:unsignedInt" minOccurs="0">
97                                <xs:annotation>
98                                        <xs:documentation>How many records from result set to include in search response.</xs:documentation>
99                                </xs:annotation>
100                        </xs:element>
101                        <xs:element name="Scope" type="xs:string" minOccurs="0" maxOccurs="unbounded">
102                                <xs:annotation>
103                                        <xs:documentation>Optional term used to restrict search to records tagged with a data provider "scope" as listed in scopeList. </xs:documentation>
104                                </xs:annotation>
105                        </xs:element>
106                </xs:sequence>
107        </xs:complexType>
108
109        <xs:complexType name="GetListType">
110                <xs:sequence>
111                        <xs:element name="listName" type="xs:string"/>
112                </xs:sequence>
113        </xs:complexType>
114
115        <!-- Response global types -->
116        <xs:complexType name="PresentReturnType">
117                <xs:sequence>
118                        <xs:element name="Status" type="xs:boolean"/>
119                        <xs:element name="StatusMessage" type="xs:string"/>
120                        <xs:element name="Documents" minOccurs="0" type="tns:Documents"/>
121                </xs:sequence>
122        </xs:complexType>
123
124        <xs:complexType name="SearchReturnType">
125                <xs:sequence>
126                        <xs:element name="Status" type="xs:boolean"/>
127                        <xs:element name="StatusMessage" type="xs:string"/>
128                        <xs:element name="ResultId" type="xs:int" minOccurs="0"/>
129                        <xs:element name="Hits" type="xs:int" minOccurs="0"/>
130                        <xs:element name="Documents" minOccurs="0" type="tns:Documents"/>
131                </xs:sequence>
132        </xs:complexType>
133
134        <xs:complexType name="GetListNamesReturnType">
135                <xs:sequence maxOccurs="unbounded">
136                        <xs:element name="listNames">
137                                <xs:complexType>
138                                        <xs:sequence>
139                                                <xs:element name="listName" type="xs:string" maxOccurs="unbounded"/>
140                                        </xs:sequence>
141                                </xs:complexType>
142                        </xs:element>
143                </xs:sequence>
144        </xs:complexType>
145
146        <xs:complexType name="GetListReturnType">
147                <xs:sequence>
148                        <xs:element name="list" minOccurs="0">
149                                <xs:complexType>
150                                        <xs:sequence>
151                                                <xs:element name="listMember" type="xs:string" maxOccurs="unbounded"/>
152                                        </xs:sequence>
153                                        <xs:attribute name="name" type="xs:string" use="required"/>
154                                </xs:complexType>
155                        </xs:element>
156                </xs:sequence>
157        </xs:complexType>
158
159        <!-- Other global types-->
160        <xs:complexType name="BoundingBoxType">
161                <xs:all>
162                        <xs:element name="LimitNorth" type="xs:float"/>
163                        <xs:element name="LimitSouth" type="xs:float"/>
164                        <xs:element name="LimitWest" type="xs:float"/>
165                        <xs:element name="LimitEast" type="xs:float"/>
166                </xs:all>
167        </xs:complexType>
168
169        <xs:complexType name="DateRangeType">
170                <xs:sequence>
171                        <xs:element name="Date" type="tns:DateValueType" maxOccurs="2">
172                                <xs:annotation>
173                                        <xs:documentation>Single date, or pair of dates representing a date range, to be used in search against specified date target in metadata.</xs:documentation>
174                                </xs:annotation>
175                        </xs:element>
176                        <xs:element name="DateRangeTarget" type="xs:string" minOccurs="0">
177                                <xs:annotation>
178                                        <xs:documentation>Target date to which date search should be applied (e.g. temporal coverage of data, date of publication). Value to be chosen from dateRangeTargetList. Default = temporalCoverage.</xs:documentation>
179                                </xs:annotation>
180                        </xs:element>
181                </xs:sequence>
182        </xs:complexType>
183
184        <xs:complexType name="DocumentsType"/>
185
186        <xs:simpleType name="OrderByDirectionType">
187                <xs:restriction base="xs:string">
188                        <xs:enumeration value="ascending"/>
189                        <xs:enumeration value="descending"/>
190                </xs:restriction>
191        </xs:simpleType>
192
193        <xs:complexType name="SpatialType">
194                <xs:sequence>
195                        <xs:element name="BoundingBox" type="tns:BoundingBoxType">
196                                <xs:annotation>
197                                        <xs:documentation>Bounding box with coordinates by default in EPSG:4326 (lat/lon)</xs:documentation>
198                                </xs:annotation>
199                        </xs:element>
200                        <xs:element name="SpatialOperator" type="xs:string" minOccurs="0">
201                                <xs:annotation>
202                                        <xs:documentation>Operator used to compare search bounding box with spatial coverage in metadata. Values from spatialOperatorList. Default is "overlaps".</xs:documentation>
203                                </xs:annotation>
204                        </xs:element>
205                        <xs:element name="SpatialReferenceSystem" type="xs:string" minOccurs="0">
206                                <xs:annotation>
207                                        <xs:documentation>Spatial reference system used for search bounding box e.g. EPSG:4326, taken from list spatialReferenceSystemList </xs:documentation>
208                                </xs:annotation>
209                        </xs:element>
210                </xs:sequence>
211        </xs:complexType>
212
213        <xs:complexType name="TermSearchType">
214                <xs:sequence>
215                        <xs:element name="Term" type="xs:string">
216                                <xs:annotation>
217                                        <xs:documentation>String(s) used in search. Whitespace between strings interpreted as OR combinations of those strings, unless "+" used to combine them, in which case AND combination. </xs:documentation>
218                                </xs:annotation>
219                        </xs:element>
220                        <xs:element name="TermTarget" type="xs:string" minOccurs="0" maxOccurs="1">
221                                <xs:annotation>
222                                        <xs:documentation>Metadata field used as target for search. From list termTargetList</xs:documentation>
223                                </xs:annotation>
224                        </xs:element>
225                </xs:sequence>
226        </xs:complexType>
227
228        <xs:complexType name="TemporalType">
229                <xs:sequence>
230                        <xs:element name="DateRange" type="tns:DateRangeType">
231                                <xs:annotation>
232                                        <xs:documentation>Specify start or end date, or both, along with target date field within metadata.</xs:documentation>
233                                </xs:annotation>
234                        </xs:element>
235                </xs:sequence>
236        </xs:complexType>
237
238        <xs:complexType name="DocumentReturnType"/>
239
240        <xs:complexType name="OrderingMetricType">
241                <xs:annotation>
242                        <xs:documentation>Intented to allow passing of ordering information
243                                at the present level</xs:documentation>
244                </xs:annotation>
245                <xs:sequence>
246                        <xs:element name="MetricName" type="xs:string"/>
247                        <xs:element name="MetricValue" type="xs:string" minOccurs="0">
248                                <xs:annotation>
249                                        <xs:documentation>Specific value of the metric when used in a 1:1 context with a document return</xs:documentation>
250                                </xs:annotation>
251                        </xs:element>
252                </xs:sequence>
253        </xs:complexType>
254
255        <xs:complexType name="DateValueType">
256                <xs:sequence>
257                        <xs:element name="DateValue" type="xs:date"/>
258                        <xs:element name="TemporalOperator" type="xs:string" minOccurs="0">
259                                <xs:annotation>
260                                        <xs:documentation>Comparison operator taken from temporalOperatorList. Default = "equals"</xs:documentation>
261                                </xs:annotation>
262                        </xs:element>
263                </xs:sequence>
264        </xs:complexType>
265
266        <xs:complexType name="OrderByType">
267                <xs:sequence>
268                        <xs:element name="OrderByField" type="xs:string">
269                                <xs:annotation>
270                                        <xs:documentation>Field to use for ordering within result set (and hence search response). Value taken from orderByFieldList </xs:documentation>
271                                </xs:annotation>
272                        </xs:element>
273                        <xs:element name="OrderByDirection" type="tns:OrderByDirectionType" minOccurs="0">
274                                <xs:annotation>
275                                        <xs:documentation>Direction of ordering used in result set and hence search response. Valid values : "ascending" or "descending". Default is descending.</xs:documentation>
276                                </xs:annotation>
277                        </xs:element>
278                </xs:sequence>
279        </xs:complexType>
280
281        <xs:complexType name="SimpleDocument">
282                <xs:sequence>
283                        <xs:element name="DocumentId" type="xs:string"/>
284                </xs:sequence>
285        </xs:complexType>
286
287        <xs:complexType name="ReturnSimpleType">
288                <xs:complexContent>
289                        <xs:extension base="tns:SimpleDocument"> </xs:extension>
290                </xs:complexContent>
291        </xs:complexType>
292
293        <xs:complexType name="ReturnBriefType">
294                <xs:complexContent>
295                        <xs:extension base="tns:ReturnSimpleType">
296                                <xs:sequence>
297                                        <xs:element name="AdditionalInformation" type="tns:CustomInfo"/>
298                                        <xs:element name="Title" type="xs:string" minOccurs="0"/>
299                                        <xs:element name="OrderedField" type="tns:OrderingMetricType" minOccurs="0"
300                                                maxOccurs="unbounded">
301                                                <xs:annotation>
302                                                        <xs:documentation>Name value pair(s) representing field(s) corresoponding to orderBy fields in search request. </xs:documentation>
303                                                </xs:annotation>
304                                        </xs:element>
305                                </xs:sequence>
306                        </xs:extension>
307                </xs:complexContent>
308        </xs:complexType>
309
310        <xs:complexType name="ReturnSummaryType">
311                <xs:complexContent>
312                        <xs:extension base="tns:ReturnSimpleType">
313                                <xs:sequence>
314                                        <xs:element name="Title" type="xs:string" minOccurs="0"/>
315                                        <xs:element name="OrderedField" type="tns:OrderingMetricType" minOccurs="0"
316                                                maxOccurs="unbounded">
317                                                <xs:annotation>
318                                                        <xs:documentation>Name value pair(s) representing field(s) corresoponding to orderBy fields in search request. </xs:documentation>
319                                                </xs:annotation>
320                                        </xs:element>
321                                        <xs:element name="Abstract" type="xs:string" minOccurs="0"/>
322                                        <xs:element name="Temporal" type="tns:TemporalType" minOccurs="0"
323                                                maxOccurs="unbounded"/>
324                                        <xs:element name="Spatial" type="tns:SpatialType" minOccurs="0"
325                                                maxOccurs="unbounded"/>
326                                </xs:sequence>
327                        </xs:extension>
328                </xs:complexContent>
329        </xs:complexType>
330
331        <xs:complexType name="ReturnFullType">
332                <xs:complexContent>
333                        <xs:extension base="tns:ReturnSimpleType">
334                                <xs:sequence>
335                                        <xs:element name="AdditionalInformation" type="tns:CustomInfo"/>
336                                        <xs:element name="Title" type="xs:string" minOccurs="0"/>
337                                        <xs:element name="OrderedField" type="tns:OrderingMetricType" minOccurs="0"
338                                                maxOccurs="unbounded">
339                                                <xs:annotation>
340                                                        <xs:documentation>Name value pair(s) representing field(s) corresoponding to orderBy fields in search request. </xs:documentation>
341                                                </xs:annotation>
342                                        </xs:element>
343                                        <xs:element name="Abstract" type="xs:string" minOccurs="0"/>
344                                        <xs:element name="Temporal" type="tns:TemporalType" minOccurs="0"
345                                                maxOccurs="unbounded"/>
346                                        <xs:element name="Spatial" type="tns:SpatialType" minOccurs="0"
347                                                maxOccurs="unbounded"/>
348                                        <xs:element name="Document" type="xs:string">
349                                                <xs:annotation>
350                                                        <xs:documentation>CDATA content of returned XML document. </xs:documentation>
351                                                </xs:annotation>
352                                        </xs:element>
353                                </xs:sequence>
354                        </xs:extension>
355                </xs:complexContent>
356        </xs:complexType>
357
358        <xs:complexType name="GetVersionReturnType">
359                <xs:sequence>
360                        <xs:element name="Version" type="xs:string"/>
361                        <xs:element name="Comment" type="xs:string"/>
362                </xs:sequence>
363        </xs:complexType>
364
365        <xs:complexType name="Documents">
366                <xs:complexContent>
367                        <xs:extension base="tns:DocumentsType">
368                                <xs:choice>
369                                        <xs:sequence>
370                                                <xs:element name="DocumentSimple" type="tns:ReturnSimpleType"
371                                                        maxOccurs="unbounded"/>
372                                        </xs:sequence>
373                                        <xs:sequence>
374                                                <xs:element name="DocumentFull" type="tns:ReturnFullType"
375                                                        maxOccurs="unbounded"/>
376                                        </xs:sequence>
377                                        <xs:sequence>
378                                                <xs:element name="DocumentBrief" type="tns:ReturnBriefType"
379                                                        maxOccurs="unbounded"/>
380                                        </xs:sequence>
381                                        <xs:sequence>
382                                                <xs:element name="DocumentSummary" type="tns:ReturnSummaryType"
383                                                        maxOccurs="unbounded"/>
384                                        </xs:sequence>
385                                </xs:choice>
386                        </xs:extension>
387                </xs:complexContent>
388        </xs:complexType>
389
390
391        <xs:complexType name="CustomInfo">
392                <xs:annotation>
393                        <xs:documentation>Customizable part of the document</xs:documentation>
394                </xs:annotation>
395                <xs:sequence>
396                        <xs:element name="Authors" type="xs:string"/>
397                        <xs:element name="Parameters" type="xs:string"/>
398                        <xs:element name="ResourceType" type="xs:string"/>
399                        <xs:element name="TopicCategory" type="xs:string"/>
400                        <xs:element name="Lineage" type="xs:string"/>
401                        <xs:element name="LimitationsPublicAccess" type="xs:string"/>
402                        <xs:element name="DataOriginator" type="xs:string"/>
403                        <xs:element name="OriginalFormatName" type="xs:string"/>               
404                </xs:sequence>
405        </xs:complexType>
406</xs:schema>
Note: See TracBrowser for help on using the repository browser.