Project

General

Profile

Bug #489 » eml-protocol.xsd

Peter McCartney, 05/17/2002 10:14 AM

 
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:cit="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:res="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:complexType name="ProtocolType">
76
		<xs:annotation>
77
			<xs:appinfo>
78
				<doc:tooltip>
79
          ProtocolType
80
        </doc:tooltip>
81
				<doc:summary>
82
          A reusable container for protocol-related information
83
        </doc:summary>
84
				<doc:description> 
85
          The ProtocolType container defines a number of reusable fields that
86
          can be referenced from multiple EML modules.
87
        </doc:description>
88
				<doc:example>
89
          Please see the examples for the sub-fields.
90
        </doc:example>
91
				<doc:lineage>
92
          Introduced in EML 2.0
93
        </doc:lineage>
94
			</xs:appinfo>
95
		</xs:annotation>
96
		<xs:complexContent>
97
			<xs:extension base="res:ResourceBase">
98
				<xs:sequence>
99
					<xs:element name="methodStep" minOccurs="0" maxOccurs="unbounded">
100
						<xs:annotation>
101
							<xs:appinfo>
102
								<doc:tooltip>
103
              method information
104
            </doc:tooltip>
105
								<doc:summary>
106
              Information about the methods employed in collecting or generating
107
              a data set or other resource.
108
            </doc:summary>
109
								<doc:description> 
110
              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.
111
            </doc:description>
112
								<doc:example>          Please see the examples for the sub-fields.
113
</doc:example>
114
								<doc:lineage>
115
              Derived from EML 1.4; related to FGDC ProcessingStep
116
            </doc:lineage>
117
							</xs:appinfo>
118
						</xs:annotation>
119
						<xs:complexType>
120
							<xs:sequence>
121
								<xs:element name="description">
122
									<xs:annotation>
123
										<xs:appinfo>
124
											<doc:tooltip>
125
              method description
126
            </doc:tooltip>
127
											<doc:summary>
128
              Description of the methods employed in collecting or generating
129
              a data set or other resource.
130
            </doc:summary>
131
											<doc:description> 
132
              The description field allows for repeated paragraphs of text that
133
              describe the methodology for a project, experiment, or particular
134
              data table.  Likewise, a literature citation may be provided that
135
              describes the methodology that was employed.
136
            </doc:description>
137
											<doc:example><![CDATA[
138
                <paragraph>
139
                  1.Collect tissues from algae of interest.
140
                </paragraph>
141
                <paragraph>
142
                  a.We are currently collecting Egregia menziezii, Mazzaella 
143
                  splendens, M. flaccida, Hedophyllum sessile, Postelsia 
144
                  palmaeformis and Fucus gardneri.We stopped collecting 
145
                  Neorhodomela larix and Odonthalia floccosa because they can be 
146
                  heavily fouled and we feared that would skew the results.
147
                </paragraph>
148
                <paragraph>
149
                  b.We collect a 7-10 cm blade or branch from each plant. For 
150
                  Egregia, try to sample small, young plants or take the base of 
151
                  the blade. For Postelsia, take a few of the blades. The other 
152
                  plants are small enough so a whole blade can be taken.
153
                </paragraph>
154
                </paragraph>
155
              ]]></doc:example>
156
											<doc:lineage>
157
              Derived from EML 1.4
158
            </doc:lineage>
159
										</xs:appinfo>
160
									</xs:annotation>
161
									<xs:complexType>
162
										<xs:choice maxOccurs="unbounded">
163
											<xs:element ref="paragraph"/>
164
											<xs:element name="citation" type="cit:LitCitation">
165
												<xs:annotation>
166
													<xs:appinfo>
167
														<doc:tooltip>
168
              Literature citation
169
            </doc:tooltip>
170
														<doc:summary>
171
              Citation of any literature that provides the protocol description
172
            </doc:summary>
173
														<doc:description> 
174
             The citation field allows reference to a publication in which the full description of the method is provided
175
            </doc:description>
176
														<doc:example>see content model for eml-literature</doc:example>
177
														<doc:lineage>
178
              New in EML 2.0
179
            </doc:lineage>
180
													</xs:appinfo>
181
												</xs:annotation>
182
											</xs:element>
183
											<xs:element name="protocol" type="ProtocolType"/>
184
										</xs:choice>
185
									</xs:complexType>
186
								</xs:element>
187
								<xs:element name="instrumentation" type="xs:string" minOccurs="0" maxOccurs="unbounded">
188
									<xs:annotation>
189
										<xs:appinfo>
190
											<doc:tooltip>
191
              Instrumentation
192
            </doc:tooltip>
193
											<doc:summary>
194
              Instruments used for measurement and recording data.
195
            </doc:summary>
196
											<doc:description> 
197
             The Instrumentation field allows the description of any instruments used in the data collection. The description should include vendor, model number, optional equipment, etc. 
198
            </doc:description>
199
											<doc:example><![CDATA[
200
                <instrumentation>LACHAT analyzer, model XYZ</instrumentation>
201
              ]]></doc:example>
202
											<doc:lineage>
203
              New in EML 2.0
204
            </doc:lineage>
205
										</xs:appinfo>
206
									</xs:annotation>
207
								</xs:element>
208
								<xs:element name="software" type="xs:string" minOccurs="0" maxOccurs="unbounded">
209
									<xs:annotation>
210
										<xs:appinfo>
211
											<doc:tooltip>
212
              Software
213
            </doc:tooltip>
214
											<doc:summary>
215
              Software used in the processing of data.
216
            </doc:summary>
217
											<doc:description> 
218
             The software element allows reference to any software used to process data. 
219
            </doc:description>
220
											<doc:example><![CDATA[
221
                see content model for eml-software complex type
222
              ]]></doc:example>
223
											<doc:lineage>
224
              New in EML 2.0
225
            </doc:lineage>
226
										</xs:appinfo>
227
									</xs:annotation>
228
								</xs:element>
229
								<xs:element name="sourceDatasetUsed" type="xs:string" minOccurs="0" maxOccurs="unbounded">
230
									<xs:annotation>
231
										<xs:appinfo>
232
											<doc:tooltip>
233
              Source Dataset Used
234
            </doc:tooltip>
235
											<doc:summary>
236
             An existing dataset that was used as a primary source to produce a secondary data product.
237
            </doc:summary>
238
											<doc:description> 
239
             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. 
240
            </doc:description>
241
											<doc:example>see content model for eml-dataset</doc:example>
242
											<doc:lineage>
243
             FGDC-STD-001-1998 source used
244
            </doc:lineage>
245
										</xs:appinfo>
246
									</xs:annotation>
247
								</xs:element>
248
								<xs:element name="qualityControl" minOccurs="0" maxOccurs="unbounded">
249
									<xs:annotation>
250
										<xs:appinfo>
251
											<doc:tooltip>
252
              Quality Control
253
            </doc:tooltip>
254
											<doc:summary>
255
              Information on possible errors or on the quality of a data set.
256
            </doc:summary>
257
											<doc:description> 
258
              The qualityControl field provides a location for the description
259
              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.
260
            </doc:description>
261
											<doc:example><![CDATA[
262
                <paragraph>
263
                  Once the data file is received, verify it's integrity by
264
                  comparing it's checksum with the pre-calculated MD5 checksum by 
265
                  running the md5 command on the file. If they match, the file 
266
                  transferred correctly.
267
                </paragraph>
268
              ]]></doc:example>
269
											<doc:lineage>
270
              Introduced in EML 2.0
271
            </doc:lineage>
272
										</xs:appinfo>
273
									</xs:annotation>
274
									<xs:complexType>
275
										<xs:choice>
276
											<xs:element ref="paragraph"/>
277
											<xs:element name="citation" type="cit:LitCitation"/>
278
										</xs:choice>
279
									</xs:complexType>
280
								</xs:element>
281
							</xs:sequence>
282
						</xs:complexType>
283
					</xs:element>
284
				</xs:sequence>
285
			</xs:extension>
286
		</xs:complexContent>
287
	</xs:complexType>
288
	<xs:element name="protocol" type="ProtocolType">
289
		<xs:annotation>
290
			<xs:appinfo>
291
				<doc:tooltip>
292
          Protocol Information
293
        </doc:tooltip>
294
				<doc:summary>
295
          A container for methods and protocol-related information
296
        </doc:summary>
297
				<doc:description> 
298
          The protocol field provides a container for other related fields 
299
          such as methods, processingStep, and qualityControl.
300
        </doc:description>
301
				<doc:example>
302
          Please see the examples for the sub-fields.
303
        </doc:example>
304
				<doc:lineage>
305
          Introduced in EML 2.0
306
        </doc:lineage>
307
			</xs:appinfo>
308
		</xs:annotation>
309
	</xs:element>
310
	<xs:element name="paragraph" type="xs:string">
311
		<xs:annotation>
312
			<xs:appinfo>
313
				<doc:tooltip>
314
          Paragraph
315
        </doc:tooltip>
316
				<doc:summary>
317
          A field for text paragraphs
318
        </doc:summary>
319
				<doc:description> 
320
          The paragraph field is used as a generic field for text.  It allows
321
          the text to be divided into distinct paragraphs within an EML file.
322
        </doc:description>
323
				<doc:example>
324
          Any text, really, could be part of a single paragraph element...Please
325
          look at the examples for each of the protocol sub-fields.
326
        </doc:example>
327
				<doc:lineage>
328
          Derived from EML 1.3
329
        </doc:lineage>
330
			</xs:appinfo>
331
		</xs:annotation>
332
	</xs:element>
333
</xs:schema>
(3-3/3)