Project

General

Profile

Bug #2054 » eml.xsd

Matt Jones, 06/30/2006 09:07 AM

 
1
<?xml version="1.0" encoding="UTF-8"?>
2
<xs:schema 
3
    xmlns:xs="http://www.w3.org/2001/XMLSchema" 
4
    xmlns="eml://ecoinformatics.org/eml-2.0.1" 
5
    xmlns:res="eml://ecoinformatics.org/resource-2.0.1" 
6
    xmlns:eml="eml://ecoinformatics.org/eml-2.0.1" 
7
    xmlns:doc="eml://ecoinformatics.org/documentation-2.0.1" 
8
    xmlns:prot="eml://ecoinformatics.org/protocol-2.0.1" 
9
    xmlns:ds="eml://ecoinformatics.org/dataset-2.0.1" 
10
    xmlns:cit="eml://ecoinformatics.org/literature-2.0.1" 
11
    xmlns:sw="eml://ecoinformatics.org/software-2.0.1" 
12
    targetNamespace="eml://ecoinformatics.org/eml-2.0.1">
13
  <xs:import namespace="eml://ecoinformatics.org/documentation-2.0.1" 
14
  schemaLocation="eml-documentation.xsd"/>
15
  <xs:import namespace="eml://ecoinformatics.org/dataset-2.0.1" 
16
  schemaLocation="eml-dataset.xsd"/>
17
  <xs:import namespace="eml://ecoinformatics.org/literature-2.0.1" 
18
  schemaLocation="eml-literature.xsd"/>
19
  <xs:import namespace="eml://ecoinformatics.org/software-2.0.1" 
20
  schemaLocation="eml-software.xsd"/>
21
  <xs:import namespace="eml://ecoinformatics.org/protocol-2.0.1" 
22
  schemaLocation="eml-protocol.xsd"/>
23
  <xs:import namespace="eml://ecoinformatics.org/resource-2.0.1" 
24
  schemaLocation="eml-resource.xsd"/>
25
  <xs:annotation>
26
    <xs:documentation>
27
                       '$RCSfile: eml.xsd,v $'
28
       Copyright: 1997-2002 Regents of the University of California,
29
                            University of New Mexico, and
30
                            Arizona State University
31
        Sponsors: National Center for Ecological Analysis and Synthesis and
32
                  Partnership for Interdisciplinary Studies of Coastal Oceans,
33
                     University of California Santa Barbara
34
                  Long-Term Ecological Research Network Office,
35
                     University of New Mexico
36
                  Center for Environmental Studies, Arizona State University
37
   Other funding: National Science Foundation (see README for details)
38
                  The David and Lucile Packard Foundation
39
     For Details: http://knb.ecoinformatics.org/
40

    
41
        '$Author: jones $'
42
          '$Date: 2006/06/30 15:50:32 $'
43
      '$Revision: 1.49 $'
44

    
45
    This program is free software; you can redistribute it and/or modify
46
    it under the terms of the GNU General Public License as published by
47
    the Free Software Foundation; either version 2 of the License, or
48
    (at your option) any later version.
49

    
50
    This program is distributed in the hope that it will be useful,
51
    but WITHOUT ANY WARRANTY; without even the implied warranty of
52
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
53
    GNU General Public License for more details.
54

    
55
    You should have received a copy of the GNU General Public License
56
    along with this program; if not, write to the Free Software
57
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
58
    </xs:documentation>
59
    <xs:appinfo>
60
      <doc:moduleDocs>
61
        <doc:moduleName>eml</doc:moduleName>
62
        <doc:moduleDescription>
63
        <section xmlns="">
64
          <title>
65
            The eml module - A metadata container
66
          </title>
67
          <para>
68
            The eml module is a wrapper container that allows the inclusion
69
            of any metadata content in a single EML document. The eml module
70
            is used as a container to hold structured descriptions of
71
            ecological resources.  In EML, the definition of a resource comes
72
            from the
73
            <ulink url="http://dublincore.org/documents/usageguide/">
74
              <citetitle>
75
                The Dublin Core Metadata Initiative
76
              </citetitle>
77
            </ulink>, which describes a general element set used to describe
78
            "networked digital resources". The top-level structure
79
            of EML has been designed to be compatible with the Dublin Core
80
            syntax. In general, dataset resources, literature resources,
81
            software resources, and protocol resources comprise the
82
            list of information that may be described in EML. EML is largely
83
            designed to describe digital resources, however, it may also be
84
            used to describe non-digital resources such as paper maps and
85
            other non-digital media.
86
            <emphasis>
87
              In EML, the definition of a "Data Package" is the
88
              combination of both the data and metadata for a resource.
89
            </emphasis>
90
              So, data packages are built by using the &lt;eml&gt; wrapper,
91
              which will include all of the metadata, and optionally the data
92
              (or references to them). All EML packages must begin with the
93
              &lt;eml&gt; tag and end with the &lt;/eml&gt; tag.
94
          </para>
95
          <para>
96
            The eml module may be extended to describe other resources by
97
            means of its optional sub-field, &lt;additionalMetadata&gt;.
98
            This field is largely reserved for the inclusion of metadata that
99
            may be highly discipline specific and not covered in this version
100
            of EML, or it may be used to internally extend fields within the
101
            EML standard.
102
          </para>
103
        </section>
104
        
105
        </doc:moduleDescription>
106
        <doc:recommendedUsage>all datasets</doc:recommendedUsage>
107
        <doc:standAlone>yes</doc:standAlone>
108
        <doc:module>eml.xsd</doc:module>
109
        <doc:module>eml-access.xsd</doc:module>
110
        <doc:module>eml-attribute.xsd</doc:module>
111
        <doc:module>eml-constraint.xsd</doc:module>
112
        <doc:module>eml-coverage.xsd</doc:module>
113
        <doc:module>eml-dataset.xsd</doc:module>
114
        <doc:module>eml-dataTable.xsd</doc:module>
115
        <doc:module>eml-entity.xsd</doc:module>
116
        <doc:module>eml-literature.xsd</doc:module>
117
        <doc:module>eml-methods.xsd</doc:module>
118
        <doc:module>eml-party.xsd</doc:module>
119
        <doc:module>eml-physical.xsd</doc:module>
120
        <doc:module>eml-project.xsd</doc:module>
121
        <doc:module>eml-protocol.xsd</doc:module>
122
        <doc:module>eml-resource.xsd</doc:module>
123
        <doc:module>eml-software.xsd</doc:module>
124
        <doc:module>eml-spatialRaster.xsd</doc:module>
125
        <doc:module>eml-spatialReference.xsd</doc:module>
126
        <doc:module>eml-spatialVector.xsd</doc:module>
127
        <doc:module>eml-storedProcedure.xsd</doc:module>
128
        <doc:module>eml-text.xsd</doc:module>
129
        <doc:module>eml-view.xsd</doc:module>
130
      </doc:moduleDocs>
131
    </xs:appinfo>
132
  </xs:annotation>
133
  <xs:element name="eml">
134
    <xs:annotation>
135
      <xs:appinfo>
136
        <doc:tooltip>Ecological Metadata</doc:tooltip>
137
        <doc:summary>A collection of EML metadata and additional metadata
138
        linked using the inline references.</doc:summary>
139
        <doc:description>The "eml" element allows for the inclusion of of
140
        any metadata content in a single EML document. In general, dataset
141
        resources, literature resources, and software resources, or another
142
        type that extends eml-resource are described using an eml document.
143
        The eml document represents a "package" that can contain both metadata
144
        and data.  It can optionally include non-EML metadata through the
145
        flexibility of the "additionalMetadata" element.  Any additional
146
        metadata that is provided can provide a pointer into the EML metadata
147
        indicating what the context of the additional metadata is (ie, what
148
        it describes).         For example, a spatial raster image might
149
        be described in EML, and an FGDC CSDGM metadata document could be
150
        included in the additionalMetadata element with a pointer to the EML
151
        spatialRaster element to indicate that the FGDC metadata is providing
152
        supplemental documentation about that particular image entity.
153
        There is no validity constraint that restricts what metadata may be
154
        present in additionalMetadata.
155
        </doc:description>
156
        
157
      </xs:appinfo>
158
    </xs:annotation>
159
    <xs:complexType>
160
      <xs:sequence>
161
        <xs:choice>
162
          <xs:element name="dataset" type="ds:DatasetType">
163
            <xs:annotation>
164
              <xs:appinfo>
165
                <doc:tooltip>Dataset Resource</doc:tooltip>
166
                <doc:summary>A resource that describes a data set, which can
167
                include one or more data entities such as data tables.
168
                </doc:summary>
169
                <doc:description>A resource that describes a data set,
170
                which can include one or more data entities such as
171
                data tables and spatial images (raster and vector).
172
                If included, this represents the primary resource that is
173
                desciribed in this eml document.
174
                </doc:description>
175
              </xs:appinfo>
176
            </xs:annotation>
177
          </xs:element>
178
          <xs:element name="citation" type="cit:CitationType">
179
            <xs:annotation>
180
              <xs:appinfo>
181
                <doc:tooltip>Literature Resource</doc:tooltip>
182
                <doc:summary>A resource that describes a literature
183
                citation that one might find in a bibliography.
184
                </doc:summary>
185
                <doc:description>A resource that describes a literature
186
                citation that one might find in a bibliography.
187
                If included, this represents the primary resource that is
188
                desciribed in this eml document.
189
                </doc:description>
190
              </xs:appinfo>
191
            </xs:annotation>
192
          </xs:element>
193
          <xs:element name="software" type="sw:SoftwareType">
194
            <xs:annotation>
195
              <xs:appinfo>
196
                <doc:tooltip>Software Resource</doc:tooltip>
197
                <doc:summary>A resource that describes a software
198
                package, which can include commercial and non-commercial
199
                software as well as data processing programs.
200
                </doc:summary>
201
                <doc:description>A resource that describes a software
202
                package, which can include commercial and non-commercial
203
                software as well as data processing programs.
204
                If included, this represents the primary resource that is
205
                desciribed in this eml document.
206
                </doc:description>
207
              </xs:appinfo>
208
            </xs:annotation>
209
          </xs:element>
210
          <xs:element name="protocol" type="prot:ProtocolType">
211
            <xs:annotation>
212
              <xs:appinfo>
213
                <doc:tooltip>Protocol Resource</doc:tooltip>
214
                <doc:summary>A resource that describes a scientific
215
                protocol, which can include one or more descriptions
216
                of methods and procedures.
217
                </doc:summary>
218
                <doc:description>A resource that describes a scientific
219
                protocol, which can include one or more descriptions
220
                of methods and procedures.
221
                If included, this represents the primary resource that is
222
                desciribed in this eml document.
223
                </doc:description>
224
              </xs:appinfo>
225
            </xs:annotation>
226
          </xs:element>
227
        </xs:choice>
228
        <xs:element name="additionalMetadata" minOccurs="0" maxOccurs="unbounded">
229
            <xs:annotation>
230
              <xs:appinfo>
231
                <doc:tooltip>Additional Metadata</doc:tooltip>
232
                <doc:summary>A flexible field for including any other
233
                relevant metadata that pertains to the resource being
234
                described.</doc:summary>
235
                <doc:description>A flexible field for including any other
236
                relevant metadata that pertains to the resource being
237
                described.  This field allows EML to be extensible in
238
                that any XML-based metadata can be included in this
239
                element, including metadata from other standards such as
240
                the FGDC CSDGM.  The "describes" element of this field
241
                allows the specific part of the resource which is described
242
                by the additional metadata to be indicated formally.
243
                </doc:description>
244
              </xs:appinfo>
245
            </xs:annotation>
246
          <xs:complexType>
247
            <xs:sequence>
248
              <xs:element name="describes" type="xs:string" minOccurs="0" maxOccurs="unbounded">
249
                <xs:annotation>
250
                  <xs:appinfo>
251
                    <doc:tooltip>Describes Reference</doc:tooltip>
252
                    <doc:summary>A pointer to the
253
                    id attribute for the subportion of the resource that
254
                    is described by this additional metadata.
255
                    </doc:summary>
256
                    <doc:description>A pointer to the
257
                    id attribute for the subportion of the resource that
258
                    is described by this additional metadata. This is a
259
                    formal field in that it is an error to provide a value
260
                    in the "describes" element that does not correspond
261
                    to the value of one of the "id" attributes in another
262
                    eml module.  This is designed to allow automated
263
                    processors to discover the contextual relationship
264
                    between the additional metadata and the resource it
265
                    describes.
266
                    </doc:description>
267
                    <doc:example>knb.343.22</doc:example>
268
                  </xs:appinfo>
269
                </xs:annotation>
270
              </xs:element>
271
              <xs:element name="metadata" type="xs:string" maxOccurs="1">
272
                <xs:annotation>
273
                  <xs:appinfo>
274
                    <doc:tooltip>Additional metadata</doc:tooltip>
275
                    <doc:summary>This element contains the additional
276
                    metadata that is to be included in the document.  The 
277
                    content of this field can be any well-formed XML fragment.
278
                    </doc:summary>
279
                    <doc:description>This element contains the additional
280
                    metadata to be included in the document.  This element
281
                    should be used for extending EML to include metadata
282
                    that is not already available in another part of the EML
283
                    specification, or to include site- or system-specific
284
                    extensions that are needed beyond the core metadata.  The
285
                    additional metadata contained in this field describes the
286
                    element referenced in the 'describes' element preceding it.
287
                    The content of this field is any well-formed XML fragment.
288
                    If that content contains namespace declarations, and if
289
                    the namespace declaration can be resolved to a schema
290
                    defniition, then the content will be validated against
291
                    that schema definition.  If no namespace is present,
292
                    or if no schema can be resolved, validation for this
293
                    fragment will be skipped (validation is "lax").
294
                    </doc:description>
295
                    <doc:example>
296
                      <![CDATA[
297
                      <embargoDate>2006-10-10</embargoDate>
298
                      ]]>
299
                    </doc:example>
300
                  </xs:appinfo>
301
                </xs:annotation>
302
                <xs:complexType>
303
                  <xs:sequence>
304
                    <xs:any processContents="lax">
305
                      <xs:annotation>
306
                        <xs:appinfo>
307
                          <doc:tooltip>Any Metadata</doc:tooltip>
308
                          <doc:summary>Any well-formed XML-formatted metadata
309
                          may be inserted at this location in the EML document.
310
                          If an element inserted here contains a reference
311
                          to its namespace, and if there is an association
312
                          between that namespace and an XML Schema that
313
                          can be located by the processing application,
314
                          then the processing application must validate the
315
                          metadata element.  If these conditions are not met,
316
                          then validation need not occur.
317
                          </doc:summary>
318
                          <doc:description>Any well-formed XML-formatted
319
                          metadata may be inserted at this location in the
320
                          EML document.  If an element inserted here contains
321
                          a reference to its namespace, and if there is an
322
                          association between that namespace and an XML Schema
323
                          that can be located by the processing application,
324
                          then the processing application must validate the
325
                          metadata element.  If these conditions are not met,
326
                          then validation need not occur.
327
                          </doc:description>
328
                        </xs:appinfo>
329
                      </xs:annotation>
330
                    </xs:any>
331
                  </xs:sequence>
332
                </xs:complexType>
333
              </xs:element> 
334
            </xs:sequence>
335
            <xs:attribute name="id" type="res:IDType" use="optional"/>
336
          </xs:complexType>
337
        </xs:element>
338
      </xs:sequence>
339
      <xs:attribute name="packageId" type="xs:string" use="required">
340
        <xs:annotation>
341
          <xs:appinfo>
342
            <doc:tooltip>Package Identifer</doc:tooltip>
343
            <doc:summary>A unique identifier for this entire EML
344
            metadata document that can be used to reference it elsewhere.
345
            </doc:summary>
346
            <doc:description>A unique identifier for this entire EML
347
            metadata document that can be used to reference it elsewhere.
348
            This identifier can be interpreted as the formal accession
349
            number for this EML package, and is therefore required.  It
350
            must be unique within a particular data management system
351
            (see the "system" attribute).
352
            </doc:description>
353
            <doc:example>knb.343.22</doc:example>
354
          </xs:appinfo>
355
        </xs:annotation>
356
      </xs:attribute>
357
      <xs:attribute name="system" type="res:SystemType" use="required"/>
358
      <xs:attribute name="scope" type="res:ScopeType" fixed="system">
359
        <xs:annotation>
360
          <xs:appinfo>
361
            <doc:tooltip>Identifer Scope</doc:tooltip>
362
            <doc:summary>The scope of the identifier.</doc:summary>
363
            <doc:description>The scope of the identifier.  Scope is generally
364
            set to either "system", meaning that it is scoped according to
365
            the "system" attribute, or "document" if it is only to be in scope
366
            within this single document instance.  In this particular use of
367
            scope, it is FIXED to be "system" because the packageId is
368
            required and always has the scope of the required "system".
369
            </doc:description>
370
            <doc:example>system</doc:example>
371
          </xs:appinfo>
372
        </xs:annotation>
373
      </xs:attribute>
374
    </xs:complexType>
375
  </xs:element>
376
</xs:schema>
(2-2/2)