← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to share/OpenMS/SCHEMAS/Param_1_2.xsd

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2012-11-12 15:58:12 UTC
  • Revision ID: package-import@ubuntu.com-20121112155812-vr15wtg9b50cuesg
Tags: upstream-1.9.0
Import upstream version 1.9.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
share/OpenMS/SCHEMAS/Param_1_2.xsd
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
 
3
        <xs:element name="PARAMETERS">
 
4
                <xs:annotation>
 
5
                        <xs:documentation>Main parameters node.</xs:documentation>
 
6
                </xs:annotation>
 
7
                <xs:complexType>
 
8
                        <xs:sequence>
 
9
                                <xs:group ref="ITEMS" minOccurs="0" maxOccurs="unbounded">
 
10
                                        <xs:annotation>
 
11
                                                <xs:documentation>A group that encapsulates items and item lists</xs:documentation>
 
12
                                        </xs:annotation>
 
13
                                </xs:group>
 
14
                                <xs:element ref="NODE" minOccurs="0" maxOccurs="unbounded">
 
15
                                        <xs:annotation>
 
16
                                                <xs:documentation>Sections used to bundle related parameters.</xs:documentation>
 
17
                                        </xs:annotation>
 
18
                                </xs:element>
 
19
                        </xs:sequence>
 
20
                        <xs:attribute name="version" type="xs:string">
 
21
                                <xs:annotation>
 
22
                                        <xs:documentation>Schema version, e.g. '1.1'. If it is missing, version 1.0 is assumed.</xs:documentation>
 
23
                                </xs:annotation>
 
24
                        </xs:attribute>
 
25
                </xs:complexType>
 
26
        </xs:element>
 
27
        <xs:element name="NODE">
 
28
                <xs:complexType>
 
29
                        <xs:sequence>
 
30
                                <xs:element ref="ITEM" minOccurs="0" maxOccurs="unbounded">
 
31
                                        <xs:annotation>
 
32
                                                <xs:documentation>Actual parameters enty.</xs:documentation>
 
33
                                        </xs:annotation>
 
34
                                </xs:element>
 
35
                                <xs:element ref="NODE" minOccurs="0" maxOccurs="unbounded">
 
36
                                        <xs:annotation>
 
37
                                                <xs:documentation>Sections used to bundle related parameters.</xs:documentation>
 
38
                                        </xs:annotation>
 
39
                                </xs:element>
 
40
                        </xs:sequence>
 
41
                        <xs:attribute name="name" use="required">
 
42
                                <xs:annotation>
 
43
                                        <xs:documentation>Name of the section.</xs:documentation>
 
44
                                </xs:annotation>
 
45
                                <xs:simpleType>
 
46
                                        <xs:restriction base="xs:string">
 
47
                                                <xs:minLength value="1"/>
 
48
                                        </xs:restriction>
 
49
                                </xs:simpleType>
 
50
                        </xs:attribute>
 
51
                        <xs:attribute name="description" type="xs:string" default=""/>
 
52
                </xs:complexType>
 
53
        </xs:element>
 
54
        <xs:element name="ITEM">
 
55
                <xs:complexType>
 
56
                        <xs:attribute name="name" use="required">
 
57
                                <xs:annotation>
 
58
                                        <xs:documentation>Name of the parameter.</xs:documentation>
 
59
                                </xs:annotation>
 
60
                                <xs:simpleType>
 
61
                                        <xs:restriction base="xs:string">
 
62
                                                <xs:minLength value="1"/>
 
63
                                        </xs:restriction>
 
64
                                </xs:simpleType>
 
65
                        </xs:attribute>
 
66
                        <xs:attribute name="type" use="required">
 
67
                                <xs:annotation>
 
68
                                        <xs:documentation>Type of the parameter: 'string', 'int', 'float' or 'double'.</xs:documentation>
 
69
                                </xs:annotation>
 
70
                                <xs:simpleType>
 
71
                                        <xs:restriction base="xs:string">
 
72
                                                <xs:enumeration value="int"/>
 
73
                                                <xs:enumeration value="float"/>
 
74
                                                <xs:enumeration value="double"/>
 
75
                                                <xs:enumeration value="string"/>
 
76
                                        </xs:restriction>
 
77
                                </xs:simpleType>
 
78
                        </xs:attribute>
 
79
                        <xs:attribute name="value" type="xs:string" use="required">
 
80
                                <xs:annotation>
 
81
                                        <xs:documentation>Value that must be compatible with the type.</xs:documentation>
 
82
                                </xs:annotation>
 
83
                        </xs:attribute>
 
84
                        <xs:attribute name="description" type="xs:string" default="">
 
85
                                <xs:annotation>
 
86
                                        <xs:documentation>Parameter desription. It should contain unit and valid range where applicable.</xs:documentation>
 
87
                                </xs:annotation>
 
88
                        </xs:attribute>
 
89
                        <xs:attribute name="advanced" type="xs:boolean" default="false">
 
90
                                <xs:annotation>
 
91
                                        <xs:documentation>Flag that determines if the parameter is always shown, or in 'advanced  mode' only. This attribute is only used for displaying purposes.</xs:documentation>
 
92
                                </xs:annotation>
 
93
                        </xs:attribute>
 
94
                        <xs:attribute name="restrictions" type="xs:string" default="">
 
95
                                <xs:annotation>
 
96
                                        <xs:documentation>Restrictions for the value field. For numeric values the lower and upper boundary is given, e.g '[min]:[max]'. For string values a comma-separated list can be given, e.g. 'one,two,three'</xs:documentation>
 
97
                                </xs:annotation>
 
98
                        </xs:attribute>
 
99
                </xs:complexType>
 
100
        </xs:element>
 
101
        <xs:element name="ITEMLIST">
 
102
                <xs:complexType>
 
103
                        <xs:sequence>
 
104
                                <xs:element name="LISTITEM" minOccurs="0" maxOccurs="unbounded">
 
105
                                        <xs:annotation>
 
106
                                                <xs:documentation>Entry in the list</xs:documentation>
 
107
                                        </xs:annotation>
 
108
                                        <xs:complexType>
 
109
                                                <xs:attribute name="value" type="xs:string" use="required">
 
110
                                                        <xs:annotation>
 
111
                                                                <xs:documentation>Value that must be compatible with the type.</xs:documentation>
 
112
                                                        </xs:annotation>
 
113
                                                </xs:attribute>
 
114
                                        </xs:complexType>
 
115
                                </xs:element>
 
116
                        </xs:sequence>
 
117
                        <xs:attribute name="name" use="required">
 
118
                                <xs:annotation>
 
119
                                        <xs:documentation>Name of the parameter.</xs:documentation>
 
120
                                </xs:annotation>
 
121
                                <xs:simpleType>
 
122
                                        <xs:restriction base="xs:string">
 
123
                                                <xs:minLength value="1"/>
 
124
                                        </xs:restriction>
 
125
                                </xs:simpleType>
 
126
                        </xs:attribute>
 
127
                        <xs:attribute name="type" use="required">
 
128
                                <xs:annotation>
 
129
                                        <xs:documentation>Type of the parameter: 'string'.</xs:documentation>
 
130
                                </xs:annotation>
 
131
                                <xs:simpleType>
 
132
                                        <xs:restriction base="xs:string">
 
133
                                                <xs:enumeration value="string"/>
 
134
                                        </xs:restriction>
 
135
                                </xs:simpleType>
 
136
                        </xs:attribute>
 
137
                        <xs:attribute name="description" type="xs:string" default="">
 
138
                                <xs:annotation>
 
139
                                        <xs:documentation>Parameter desription. It should contain unit and valid range where applicable.</xs:documentation>
 
140
                                </xs:annotation>
 
141
                        </xs:attribute>
 
142
                        <xs:attribute name="advanced" type="xs:boolean" default="false">
 
143
                                <xs:annotation>
 
144
                                        <xs:documentation>Flag that determines if the parameter is always shown, or in 'advanced  mode' only. This attribute is only used for displaying purposes.</xs:documentation>
 
145
                                </xs:annotation>
 
146
                        </xs:attribute>
 
147
                        <xs:attribute name="restrictions" type="xs:string" default="">
 
148
                                <xs:annotation>
 
149
                                        <xs:documentation>Restrictions for the value field. For numeric values the lower and upper boundary is given, e.g '[min]:[max]'. For string values a comma-separated list can be given, e.g. 'one,two,three'</xs:documentation>
 
150
                                </xs:annotation>
 
151
                        </xs:attribute>
 
152
                </xs:complexType>
 
153
        </xs:element>
 
154
        <xs:group name="ITEMS">
 
155
                <xs:choice>
 
156
                        <xs:element ref="ITEM">
 
157
                                <xs:annotation>
 
158
                                        <xs:documentation>A single-value item</xs:documentation>
 
159
                                </xs:annotation>
 
160
                        </xs:element>
 
161
                        <xs:element ref="ITEMLIST">
 
162
                                <xs:annotation>
 
163
                                        <xs:documentation>A list of values of a certain type</xs:documentation>
 
164
                                </xs:annotation>
 
165
                        </xs:element>
 
166
                </xs:choice>
 
167
        </xs:group>
 
168
</xs:schema>