Project

General

Profile

Bug #600 » eml-storedProcedure.xsd

David Blankman, 09/23/2002 01:15 PM

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

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

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

    
54
    You should have received a copy of the GNU General Public License
55
    along with this program; if not, write to the Free Software
56
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
57
    </xs:documentation>
58
    <xs:appinfo>
59
      <doc:moduleDocs>
60
        <doc:moduleName>eml-storedProcedure</doc:moduleName>
61
        <doc:moduleDescription>The StoredProcedure module is meant to capture
62
        information on procedures that produce data output in the form of a
63
        data table. In an RDBMS one can code complex queries and transactions
64
        into stored procedures and then invoke them directly from front-end
65
        applications. It allows the optional describtion of any parameters that
66
        are expected to be passed to the procedure when it is
67
        called.</doc:moduleDescription>
68
        <doc:recommendedUsage>Use the StoredProcedure module to document
69
        datasets that use storedProcedures to retrieve archived
70
        data.</doc:recommendedUsage>
71
        <doc:standAlone>yes</doc:standAlone>
72
      </doc:moduleDocs>
73
    </xs:appinfo>
74
  </xs:annotation>
75
  <xs:element name="storedProcedure" type="StoredProcedureType">
76
    <xs:annotation>
77
      <xs:appinfo>
78
        <doc:tooltip>Stored Procedure&gt;</doc:tooltip>
79
        <doc:summary>The storedProcedure element documents stored
80
        procedures.</doc:summary>
81
        <doc:description>The StoredProcedure element is meant to capture
82
        information on procedures that produce data output in the form of a
83
        data table. In an RDBMS one can code complex queries and transactions
84
        into stored procedures and then invoke them directly from front-end
85
        applications. This element allows the optional describtion of any
86
        parameters that are expected to be passed to the procedure when it is
87
        called.</doc:description>
88
        <doc:lineage>EML 2.0</doc:lineage>
89
      </xs:appinfo>
90
    </xs:annotation>
91
  </xs:element>
92
  <xs:complexType name="StoredProcedureType">
93
    <xs:annotation>
94
      <xs:appinfo>
95
        <doc:tooltip>Stored Procedure complex type&gt;</doc:tooltip>
96
        <doc:summary>Structure for documenting a stored procedure</doc:summary>
97
        <doc:description>The StoredProcedure complex type defines the structure
98
        for documenting a stored procedure.</doc:description>
99
        <doc:lineage>EML 2.0</doc:lineage>
100
      </xs:appinfo>
101
    </xs:annotation>
102
    <xs:choice>
103
      <xs:sequence>
104
        <xs:group ref="ent:EntityGroup" />
105
        <xs:sequence>
106
          <xs:element name="parameter" type="ParameterType" minOccurs="0"
107
          maxOccurs="unbounded">
108
            <xs:annotation>
109
              <xs:appinfo>
110
                <doc:tooltip>Parameter</doc:tooltip>
111
                <doc:summary>A parameter that is required as input to the
112
                stored procedure.</doc:summary>
113
                <doc:description>The parameter elements defines the fields that
114
                may be required to invoke a stored procedure.</doc:description>
115
                <doc:lineage>EML 2.0</doc:lineage>
116
              </xs:appinfo>
117
            </xs:annotation>
118
          </xs:element>
119
        </xs:sequence>
120
      </xs:sequence>
121
      <xs:element name="references" type="xs:string" />
122
    </xs:choice>
123
    <xs:attribute name="id" type="xs:string" use="optional" />
124
    <xs:attribute name="system" type="xs:string" use="optional" />
125
    <xs:attribute name="scope" type="res:ScopeType" use="optional"
126
    default="document" />
127
  </xs:complexType>
128
  <xs:complexType name="ParameterType">
129
    <xs:annotation>
130
      <xs:appinfo>
131
        <doc:tooltip>Parameter complex type</doc:tooltip>
132
        <doc:summary>The structure for defining a parameter that is required as
133
        input to the stored procedure.</doc:summary>
134
        <doc:description>The parameter complex type defines the structure for
135
        documenting the parameters that may be required to invoke a stored
136
        procedure.</doc:description>
137
        <doc:lineage>EML 2.0</doc:lineage>
138
      </xs:appinfo>
139
    </xs:annotation>
140
    <xs:sequence>
141
      <xs:element name="name" type="xs:string">
142
        <xs:annotation>
143
          <xs:appinfo>
144
            <doc:tooltip>Parameter Name</doc:tooltip>
145
            <doc:summary>The name of the parameter.</doc:summary>
146
            <doc:description>The value of the name field is the name of the
147
            parameter.</doc:description>
148
            <doc:example>SiteID</doc:example>
149
            <doc:lineage>EML 2.0</doc:lineage>
150
          </xs:appinfo>
151
        </xs:annotation>
152
      </xs:element>
153
      <xs:element name="datatype">
154
        <xs:annotation>
155
          <xs:appinfo>
156
            <doc:tooltip>Data type</doc:tooltip>
157
            <doc:summary>The data type for the parameter value.</doc:summary>
158
            <doc:description>The value of the datatype field is the data type
159
            of the parameter. Datatype has an attribute of typeSystem, with a
160
            default of "http://www.w3.org/2001/XMLSchema-datatypes". The user 
161
            can specify another system such as "oracle" or "sql server"
162
            The data type used should conform to the system type.
163
            </doc:description>
164
            <doc:example>string</doc:example>
165
            <doc:example>varchar2</doc:example>
166
            <doc:lineage>EML 2.0</doc:lineage>
167
          </xs:appinfo>
168
        </xs:annotation>
169
        <xs:complexType>
170
          <xs:simpleContent>
171
            <xs:extension base="xs:string">
172
              <xs:attribute name="typeSystem" type="xs:string" use="optional"
173
              default="http://www.w3.org/2001/XMLSchema-datatypes" />
174
            </xs:extension>
175
          </xs:simpleContent>
176
        </xs:complexType>
177
      </xs:element>
178
      <xs:element name="required" type="xs:boolean">
179
        <xs:annotation>
180
          <xs:appinfo>
181
            <doc:tooltip>Required</doc:tooltip>
182
            <doc:summary>Whether or not the parameter is
183
            required.</doc:summary>
184
            <doc:description>The required field is used to document whether
185
            the parameter being described is or is not required when invoking
186
            the stored procedure.</doc:description>
187
            <doc:example>true</doc:example>
188
            <doc:lineage>EML 2.0</doc:lineage>
189
          </xs:appinfo>
190
        </xs:annotation>
191
      </xs:element>
192
      <xs:element name="repeats" type="xs:boolean">
193
        <xs:annotation>
194
          <xs:appinfo>
195
            <doc:tooltip>Repeats</doc:tooltip>
196
            <doc:summary>Whether or not the parameter repeats.</doc:summary>
197
            <doc:description>The repeats field is used to document whether or ]
198
            not the parameter being described is repeted when invoking
199
            the stored procedure.</doc:description>
200
            <doc:example>true</doc:example>
201
            <doc:lineage>EML 2.0</doc:lineage>
202
          </xs:appinfo>
203
        </xs:annotation>
204
      </xs:element>
205
    </xs:sequence>
206
  </xs:complexType>
207
</xs:schema>
208

    
(2-2/3)