Project

General

Profile

Bug #489 » eml-protocol.xsd

Peter McCartney, 05/16/2002 01:33 PM

 
1
<?xml version="1.0"?>
2
<!-- edited with XML Spy v4.0.1 U (http://www.xmlspy.com) by Peter McCartney (private) -->
3
<xs:schema targetNamespace="eml:protocol-2.0.0beta8" xmlns:lit="eml:literature-2.0.0beta8" xmlns:ds="eml:dataset-2.0.0beta8" xmlns:soft="eml:software-2.0.0beta8" xmlns="eml:protocol-2.0.0beta8" xmlns:rsb="eml:resource-2.0.0beta8" xmlns:doc="eml:documentation-2.0.0beta8" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified" attributeFormDefault="unqualified">
4
	<xs:import namespace="eml:dataset-2.0.0beta8" schemaLocation="eml-dataset.xsd"/>
5
	<xs:import namespace="eml:resource-2.0.0beta8" schemaLocation="eml-resource.xsd"/>
6
	<xs:import namespace="eml:software-2.0.0beta8" schemaLocation="eml-software.xsd"/>
7
	<xs:import namespace="eml:documentation-2.0.0beta8" schemaLocation="eml-documentation.xsd"/>
8
	<xs:annotation>
9
		<xs:documentation>
10
       '$RCSfile: eml-protocol.xsd,v $'
11
       Copyright: 2000 Regents of the University of California and the
12
                  National Center for Ecological Analysis and Synthesis
13
     For Details: http://knb.ecoinformatics.org/
14
  
15
        '$Author: berkley $'
16
          '$Date: 2002/05/15 22:57:54 $'
17
      '$Revision: 1.15 $'
18
    
19
    This program is free software; you can redistribute it and/or modify
20
    it under the terms of the GNU General Public License as published by
21
    the Free Software Foundation; either version 2 of the License, or
22
    (at your option) any later version.
23
  
24
    This program is distributed in the hope that it will be useful,
25
    but WITHOUT ANY WARRANTY; without even the implied warranty of
26
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27
    GNU General Public License for more details.
28
  
29
    You should have received a copy of the GNU General Public License
30
    along with this program; if not, write to the Free Software
31
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
32
    </xs:documentation>
33
		<xs:appinfo>
34
			<doc:moduleDocs>
35
				<doc:moduleName>eml-protocol</doc:moduleName>
36
				<doc:moduleDescription>
37
          The EML Protocol Module is used to describe methods and identify the 
38
          proccesses that have been used to define / improve the quality of a data
39
          file, also used to identify potential problems with the data file.
40
        </doc:moduleDescription>
41
				<doc:recommendedUsage>
42
          all datasets
43
        </doc:recommendedUsage>
44
				<doc:standAlone>
45
          yes
46
        </doc:standAlone>
47
				<doc:relationship>
48
					<doc:moduleName>
49
            eml-dataset
50
          </doc:moduleName>
51
					<doc:relationshipType>
52
            has research protocol rules for
53
          </doc:relationshipType>
54
				</doc:relationship>
55
				<doc:relationship>
56
					<doc:moduleName>
57
            eml-literature
58
          </doc:moduleName>
59
					<doc:relationshipType>
60
            has research protocol rules for
61
          </doc:relationshipType>
62
				</doc:relationship>
63
				<doc:relationship>
64
					<doc:moduleName>
65
            eml-software
66
          </doc:moduleName>
67
					<doc:relationshipType>
68
            has research protocol rules for
69
          </doc:relationshipType>
70
				</doc:relationship>
71
			</doc:moduleDocs>
72
		</xs:appinfo>
73
	</xs:annotation>
74
	<xs:import namespace="eml:literature-2.0.0beta8" schemaLocation="eml-literature.xsd"/>
75
	<xs:element name="eml-protocol">
76
		<xs:annotation>
77
			<xs:appinfo>
78
				<doc:tooltip>
79
          EML Protocol
80
        </doc:tooltip>
81
				<doc:summary>
82
          A set of fields that contains method, processing, and quality control
83
          information.
84
        </doc:summary>
85
				<doc:description> 
86
          eml-protocol is a set of fields that contains method, processing, and 
87
          quality control information.  It may consist of paragraphs of descriptive
88
          text that describes the methods to be employed, or optionally references 
89
          to literature citations that do the same.  Likewise, descriptions of pre
90
          and post processing of data files may be described within.
91
        </doc:description>
92
				<doc:example>
93
          Please see the examples for the sub-fields.
94
        </doc:example>
95
				<doc:lineage>
96
          Derived from EML 1.4: eml-status, and eml-quality modules.
97
        </doc:lineage>
98
			</xs:appinfo>
99
		</xs:annotation>
100
		<xs:complexType>
101
			<xs:sequence>
102
				<xs:element name="identifier" maxOccurs="unbounded">
103
					<xs:annotation>
104
						<xs:appinfo>
105
							<doc:tooltip>
106
                Unique identifier
107
              </doc:tooltip>
108
							<doc:summary>
109
                The unique identifier of this metadata file or object.
110
              </doc:summary>
111
							<doc:description>
112
                The identifier field provides a unique identifier for this
113
                metadata documentation.  It will most likely be part of a 
114
                sequence of numbers or letters that are meaningful in a 
115
                larger context, such as a metadata catalog. That larger
116
                system can be identified in the "system" attribute. Multiple
117
                identifiers can be listed corresponding to different catalog
118
                systems.
119
              </doc:description>
120
							<doc:example><![CDATA[<identifier system="metacat">nceas.3.2</identifier>]]></doc:example>
121
							<doc:lineage>
122
                The 'identifier' field is derived from the eml-dataset 
123
                meta_file_id filed in EML 1.4.
124
              </doc:lineage>
125
						</xs:appinfo>
126
					</xs:annotation>
127
					<xs:complexType>
128
						<xs:annotation>
129
							<xs:appinfo>
130
								<doc:tooltip>
131
                    Catalog system
132
                  </doc:tooltip>
133
								<doc:summary>
134
                    The catalog system in which this identifier is used.
135
                  </doc:summary>
136
								<doc:description>
137
                    This element gives the name of the catalog system in which
138
                    this identifier is used.  It is useful to determine the
139
                    scope of the identifier, and to determine the semantics
140
                    of the various subparts of the identifier. Unresolved issue:
141
                    can or should this be a URI/URL pointing to the catalog
142
                    system, or just the name?
143
                  </doc:description>
144
								<doc:example><![CDATA[
145
                    <identifier system="metacat">nceas.3.2</identifier>]]></doc:example>
146
								<doc:lineage>
147
                    New to EML 2.0.
148
                </doc:lineage>
149
							</xs:appinfo>
150
						</xs:annotation>
151
						<xs:simpleContent>
152
							<xs:extension base="xs:string">
153
								<xs:attribute name="system" type="xs:string" use="optional"/>
154
							</xs:extension>
155
						</xs:simpleContent>
156
					</xs:complexType>
157
				</xs:element>
158
				<xs:element ref="protocol" maxOccurs="unbounded"/>
159
			</xs:sequence>
160
		</xs:complexType>
161
	</xs:element>
162
	<xs:complexType name="ProtocolType">
163
		<xs:annotation>
164
			<xs:appinfo>
165
				<doc:tooltip>
166
          ProtocolType
167
        </doc:tooltip>
168
				<doc:summary>
169
          A reusable container for protocol-related information
170
        </doc:summary>
171
				<doc:description> 
172
          The ProtocolType container defines a number of reusable fields that
173
          can be referenced from multiple EML modules.
174
        </doc:description>
175
				<doc:example>
176
          Please see the examples for the sub-fields.
177
        </doc:example>
178
				<doc:lineage>
179
          Introduced in EML 2.0
180
        </doc:lineage>
181
			</xs:appinfo>
182
		</xs:annotation>
183
		<xs:complexContent>
184
			<xs:extension base="rsb:ResourceBase">
185
				<xs:sequence>
186
					<xs:element name="methodStep" minOccurs="0" maxOccurs="unbounded">
187
						<xs:annotation>
188
							<xs:appinfo>
189
								<doc:tooltip>
190
              method information
191
            </doc:tooltip>
192
								<doc:summary>
193
              Information about the methods employed in collecting or generating
194
              a data set or other resource.
195
            </doc:summary>
196
								<doc:description> 
197
              The methodStep field allows for repeated sets of elements that document a series of procedures followed to produce a data object. These include text descriptions of the procedures, relevant literature, software, instrumentation, source data and any quality control measures taken.
198
            </doc:description>
199
								<doc:example>          Please see the examples for the sub-fields.
200
</doc:example>
201
								<doc:lineage>
202
              Derived from EML 1.4; related to FGDC ProcessingStep
203
            </doc:lineage>
204
							</xs:appinfo>
205
						</xs:annotation>
206
						<xs:complexType>
207
							<xs:sequence>
208
								<xs:element name="description">
209
									<xs:annotation>
210
										<xs:appinfo>
211
											<doc:tooltip>
212
              method description
213
            </doc:tooltip>
214
											<doc:summary>
215
              Description of the methods employed in collecting or generating
216
              a data set or other resource.
217
            </doc:summary>
218
											<doc:description> 
219
              The description field allows for repeated paragraphs of text that
220
              describe the methodology for a project, experiment, or particular
221
              data table.  Likewise, a literature citation may be provided that
222
              describes the methodology that was employed.
223
            </doc:description>
224
											<doc:example><![CDATA[
225
                <paragraph>
226
                  1.Collect tissues from algae of interest.
227
                </paragraph>
228
                <paragraph>
229
                  a.We are currently collecting Egregia menziezii, Mazzaella 
230
                  splendens, M. flaccida, Hedophyllum sessile, Postelsia 
231
                  palmaeformis and Fucus gardneri.We stopped collecting 
232
                  Neorhodomela larix and Odonthalia floccosa because they can be 
233
                  heavily fouled and we feared that would skew the results.
234
                </paragraph>
235
                <paragraph>
236
                  b.We collect a 7-10 cm blade or branch from each plant. For 
237
                  Egregia, try to sample small, young plants or take the base of 
238
                  the blade. For Postelsia, take a few of the blades. The other 
239
                  plants are small enough so a whole blade can be taken.
240
                </paragraph>
241
                </paragraph>
242
              ]]></doc:example>
243
											<doc:lineage>
244
              Derived from EML 1.4
245
            </doc:lineage>
246
										</xs:appinfo>
247
									</xs:annotation>
248
									<xs:complexType>
249
										<xs:choice maxOccurs="unbounded">
250
											<xs:element ref="paragraph" maxOccurs="unbounded"/>
251
											<xs:element name="citation" type="lit:LitCitation" maxOccurs="unbounded">
252
												<xs:annotation>
253
													<xs:appinfo>
254
														<doc:tooltip>
255
              Literature citation
256
            </doc:tooltip>
257
														<doc:summary>
258
              Citation of any literature that provides the protocol description
259
            </doc:summary>
260
														<doc:description> 
261
             The citation field allows reference to a publication in which the full description of the method is provided
262
            </doc:description>
263
														<doc:example>see content model for eml-literature</doc:example>
264
														<doc:lineage>
265
              New in EML 2.0
266
            </doc:lineage>
267
													</xs:appinfo>
268
												</xs:annotation>
269
											</xs:element>
270
										</xs:choice>
271
									</xs:complexType>
272
								</xs:element>
273
								<xs:element name="instrumentation" type="xs:string" minOccurs="0" maxOccurs="unbounded">
274
									<xs:annotation>
275
										<xs:appinfo>
276
											<doc:tooltip>
277
              Instrumentation
278
            </doc:tooltip>
279
											<doc:summary>
280
              Instruments used for measurement and recording data.
281
            </doc:summary>
282
											<doc:description> 
283
             The Instrumentation field allows the description of any instruments used in the data collection. The description should include vendor, model number, optional equipment, etc. 
284
            </doc:description>
285
											<doc:example><![CDATA[
286
                <instrumentation>LACHAT analyzer, model XYZ</instrumentation>
287
              ]]></doc:example>
288
											<doc:lineage>
289
              New in EML 2.0
290
            </doc:lineage>
291
										</xs:appinfo>
292
									</xs:annotation>
293
								</xs:element>
294
								<xs:element name="software" type="xs:string" minOccurs="0" maxOccurs="unbounded">
295
									<xs:annotation>
296
										<xs:appinfo>
297
											<doc:tooltip>
298
              Software
299
            </doc:tooltip>
300
											<doc:summary>
301
              Software used in the processing of data.
302
            </doc:summary>
303
											<doc:description> 
304
             The software element allows reference to any software used to process data. 
305
            </doc:description>
306
											<doc:example><![CDATA[
307
                see content model for eml-software complex type
308
              ]]></doc:example>
309
											<doc:lineage>
310
              New in EML 2.0
311
            </doc:lineage>
312
										</xs:appinfo>
313
									</xs:annotation>
314
								</xs:element>
315
								<xs:element name="sourceDatasetUsed" type="xs:string" minOccurs="0" maxOccurs="unbounded">
316
									<xs:annotation>
317
										<xs:appinfo>
318
											<doc:tooltip>
319
              Source Dataset Used
320
            </doc:tooltip>
321
											<doc:summary>
322
             An existing dataset that was used as a primary source to produce a secondary data product.
323
            </doc:summary>
324
											<doc:description> 
325
             The sourceDatasetUsed element allows reference to any existing dataset(s) that were used as source data to produce this datset. A metadata description of an NDVI image would include a sourceDatasetUsed element to reference the remote sensing image upon which it was calculated. 
326
            </doc:description>
327
											<doc:example>see content model for eml-dataset</doc:example>
328
											<doc:lineage>
329
             FGDC-STD-001-1998 source used
330
            </doc:lineage>
331
										</xs:appinfo>
332
									</xs:annotation>
333
								</xs:element>
334
								<xs:element name="qualityControl" minOccurs="0" maxOccurs="unbounded">
335
									<xs:annotation>
336
										<xs:appinfo>
337
											<doc:tooltip>
338
              Quality Control
339
            </doc:tooltip>
340
											<doc:summary>
341
              Information on possible errors or on the quality of a data set.
342
            </doc:summary>
343
											<doc:description> 
344
              The qualityControl field provides a location for the description
345
              of actions taken to either control or assess the quality of data resulting from the associated  method step. TA quality control description should identifiy a quality goal and describe prescriptive steps taken to ensure that the data meet those standards or to postcriptive steps taken to assess the extent to which they are met. A quality ccontrol statement is associated with the methodStep that could have affected the targeted quality goal.
346
            </doc:description>
347
											<doc:example><![CDATA[
348
                <paragraph>
349
                  Once the data file is received, verify it's integrity by
350
                  comparing it's checksum with the pre-calculated MD5 checksum by 
351
                  running the md5 command on the file. If they match, the file 
352
                  transferred correctly.
353
                </paragraph>
354
              ]]></doc:example>
355
											<doc:lineage>
356
              Introduced in EML 2.0
357
            </doc:lineage>
358
										</xs:appinfo>
359
									</xs:annotation>
360
									<xs:complexType>
361
										<xs:choice>
362
											<xs:element ref="paragraph" maxOccurs="unbounded"/>
363
											<xs:element name="citation" type="lit:LitCitation" maxOccurs="unbounded"/>
364
										</xs:choice>
365
									</xs:complexType>
366
								</xs:element>
367
							</xs:sequence>
368
						</xs:complexType>
369
					</xs:element>
370
				</xs:sequence>
371
			</xs:extension>
372
		</xs:complexContent>
373
	</xs:complexType>
374
	<xs:element name="protocol" type="ProtocolType">
375
		<xs:annotation>
376
			<xs:appinfo>
377
				<doc:tooltip>
378
          Protocol Information
379
        </doc:tooltip>
380
				<doc:summary>
381
          A container for methods and protocol-related information
382
        </doc:summary>
383
				<doc:description> 
384
          The protocol field provides a container for other related fields 
385
          such as methods, processingStep, and qualityControl.
386
        </doc:description>
387
				<doc:example>
388
          Please see the examples for the sub-fields.
389
        </doc:example>
390
				<doc:lineage>
391
          Introduced in EML 2.0
392
        </doc:lineage>
393
			</xs:appinfo>
394
		</xs:annotation>
395
	</xs:element>
396
	<xs:element name="paragraph" type="xs:string">
397
		<xs:annotation>
398
			<xs:appinfo>
399
				<doc:tooltip>
400
          Paragraph
401
        </doc:tooltip>
402
				<doc:summary>
403
          A field for text paragraphs
404
        </doc:summary>
405
				<doc:description> 
406
          The paragraph field is used as a generic field for text.  It allows
407
          the text to be divided into distinct paragraphs within an EML file.
408
        </doc:description>
409
				<doc:example>
410
          Any text, really, could be part of a single paragraph element...Please
411
          look at the examples for each of the protocol sub-fields.
412
        </doc:example>
413
				<doc:lineage>
414
          Derived from EML 1.3
415
        </doc:lineage>
416
			</xs:appinfo>
417
		</xs:annotation>
418
	</xs:element>
419
</xs:schema>
(2-2/3)