JAL-3187 findFeaturesAtResidue answer in render order (tests TODO)
[jalview.git] / schemas / vamsas.xsd
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
4  * Copyright (C) $$Year-Rel$$ The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18  * The Jalview Authors are detailed in the 'AUTHORS' file.
19 -->
20 <!-- edited with XMLSpy v2006 sp1 U (http://www.altova.com) by ioh[ (o[ih[oh) -->
21 <!-- 
22         Java JAXB binding classes are generated by running command line tool xjc:
23             xjc schemas/jalview.xsd -d src -p jalview.xml.binding.jalview
24         Note this also generates code for included schemas
25 -->
26 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:vamsas="www.vamsas.ac.uk/jalview/version2" targetNamespace="www.vamsas.ac.uk/jalview/version2" elementFormDefault="qualified" attributeFormDefault="unqualified">
27         <xs:complexType name="VAMSAS">
28                 <xs:sequence>
29                         <xs:element name="Tree" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
30                         <xs:element ref="vamsas:SequenceSet" minOccurs="0" maxOccurs="unbounded"/>
31                 </xs:sequence>
32         </xs:complexType>
33         <xs:complexType name="mapListType">
34                 <xs:annotation>
35                         <xs:documentation> 
36                                 developed after mapRangeType from http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes
37                         </xs:documentation>
38                         <xs:documentation>
39                                 This effectively represents a java.util.MapList object
40                         </xs:documentation>
41                 </xs:annotation>
42                 <xs:sequence>
43                         <xs:element name="mapListFrom" minOccurs="0" maxOccurs="unbounded">
44                                 <xs:annotation>
45                                         <xs:documentation> a region from start to end inclusive</xs:documentation>
46                                 </xs:annotation>
47                                 <xs:complexType>
48                                         <xs:attribute name="start" type="xs:int" use="required"/>
49                                         <xs:attribute name="end" type="xs:int" use="required"/>
50                                 </xs:complexType>
51                         </xs:element>                                   
52                         <xs:element name="mapListTo" minOccurs="0" maxOccurs="unbounded">
53                                 <xs:annotation>
54                                         <xs:documentation> a region from start to end inclusive</xs:documentation>
55                                 </xs:annotation>
56                                 <xs:complexType>
57                                         <xs:attribute name="start" type="xs:int" use="required"/>
58                                         <xs:attribute name="end" type="xs:int" use="required"/>
59                                 </xs:complexType>
60                         </xs:element>                                   
61                 </xs:sequence>
62                 <xs:attribute name="mapFromUnit" type="xs:positiveInteger" use="required">
63                         <xs:annotation>
64                                 <xs:documentation>number of dictionary symbol widths involved in each
65                                         mapped position on this sequence (for example, 3 for a dna sequence exon
66                                         region that is being mapped to a protein sequence). This is optional,
67                                         since the unit can be usually be inferred from the dictionary type of
68                                         each sequence involved in the mapping. </xs:documentation>
69                         </xs:annotation>
70                 </xs:attribute>
71                 <xs:attribute name="mapToUnit" type="xs:positiveInteger" use="required">
72                         <xs:annotation>
73                                 <xs:documentation>number of dictionary symbol widths involved in each
74                                         mapped position on this sequence (for example, 3 for a dna sequence exon
75                                         region that is being mapped to a protein sequence). This is optional,
76                                         since the unit can be usually be inferred from the dictionary type of
77                                         each sequence involved in the mapping. </xs:documentation>
78                         </xs:annotation>
79                 </xs:attribute>
80         </xs:complexType>
81         <xs:element name="Mapping">
82                 <xs:complexType>
83                         <xs:annotation>
84                                 <xs:documentation>
85                                         Represent the jalview.datamodel.Mapping object - it also provides
86                                         a way of storing sequences that are mapped 'to' without adding them
87                                         to the sequence set (which will mean they are then added to the alignment too).
88                                 </xs:documentation>
89                         </xs:annotation>
90                         <xs:complexContent>
91                                 <xs:extension base="vamsas:mapListType">
92                                         <xs:sequence>
93                                                 <xs:choice minOccurs="0" maxOccurs="1">
94                                                         <xs:element ref="vamsas:Sequence"/>
95                                                         <xs:element name="dseqFor">
96                                                                 <xs:simpleType>
97                                                                         <xs:restriction base="xs:string">
98                                                                                 <xs:annotation>
99                                                                                         <xs:documentation>The sequence whose dataset sequence is to be referenced here</xs:documentation>
100                                                                                 </xs:annotation>
101                                                                         </xs:restriction>
102                                                                 </xs:simpleType>
103                                                         </xs:element>
104                                                 </xs:choice>
105                                         </xs:sequence>
106                                 </xs:extension>
107                         </xs:complexContent>    
108                 </xs:complexType>
109         </xs:element>
110         <xs:element name="AlcodonFrame">
111                 <xs:complexType>
112                         <xs:sequence>
113                                 <xs:element name="alcodon" minOccurs="0" maxOccurs="unbounded">
114                                         <xs:complexType>
115                                                 <xs:annotation>
116                                                         <xs:documentation>
117                                                                 specifies a series of aligned codons from an associated DNA sequence alignment that when translated correspond to columns of a peptide alignment.
118                                                                 Element may have either all pos1,2,3 attributes specified, or none at all (indicating a gapped column with no translated peptide).
119                                                         </xs:documentation>
120                                                 </xs:annotation>
121                                                 <xs:attribute name="pos1" type="xs:integer" use="optional"/>
122                                                 <xs:attribute name="pos2" type="xs:integer" use="optional"/>
123                                                 <xs:attribute name="pos3" type="xs:integer" use="optional"/>
124                                         </xs:complexType>
125                                 </xs:element>
126                                 <xs:element name="alcodMap" minOccurs="0" maxOccurs="unbounded">
127                                         <xs:complexType>
128                                                 <xs:sequence>
129                                                         <xs:element ref="vamsas:Mapping" maxOccurs="1" minOccurs="1">
130                                                                 <xs:annotation>
131                                                                         <xs:documentation>
132                                                                                 a Mapping entry and an associated protein sequence
133                                                                         </xs:documentation>
134                                                                 </xs:annotation>
135                                                         </xs:element>
136                                                 </xs:sequence>
137                                                 <xs:attribute name="dnasq" type="xs:string" use="required">
138                                                         <xs:annotation>
139                                                                 <xs:documentation>
140                                                                         internal jalview id for the dnasq for this mapping.
141                                                                 </xs:documentation>
142                                                         </xs:annotation>
143                                                 </xs:attribute>
144                                         </xs:complexType>
145                                         
146                                 </xs:element>
147                                 
148                         </xs:sequence>
149                 </xs:complexType>
150         </xs:element>
151         <xs:element name="Sequence">
152                 <xs:complexType>
153                         <xs:complexContent>
154                                 <xs:extension base="vamsas:SequenceType">
155                                         <xs:sequence>
156                                                 <xs:element name="DBRef" minOccurs="0" maxOccurs="unbounded">
157                                                         <xs:complexType>
158                                                                 <xs:sequence>
159                                                                         <xs:element ref="vamsas:Mapping" minOccurs="0" maxOccurs="1"/>
160                                                                 </xs:sequence>                                                                                                  
161                                                                 <xs:attribute name="source" type="xs:string"/>
162                                                                 <xs:attribute name="version" type="xs:string"/>
163                                                                 <xs:attribute name="accessionId" type="xs:string"/>
164                                                         </xs:complexType>
165                                                 </xs:element>
166                                         </xs:sequence>
167                                         <xs:attribute name="dsseqid" type="xs:string" use="optional">
168                                                 <xs:annotation>
169                                                         <xs:documentation>
170                                                                 dataset sequence id for this sequence. Will be created as union of sequences.
171                                                         </xs:documentation>
172                                                 </xs:annotation>
173                                         </xs:attribute>
174                                 </xs:extension>
175                         </xs:complexContent>
176                 </xs:complexType>
177         </xs:element>
178         <xs:element name="Annotation">
179                 <xs:complexType>
180                         <xs:sequence>
181                                 <xs:element ref="vamsas:annotationElement" minOccurs="0"
182                                         maxOccurs="unbounded" />
183                                 <xs:element name="label" type="xs:string" />
184                                 <xs:element name="description" type="xs:string"
185                                         minOccurs="0" />
186                                 <xs:element name="thresholdLine" minOccurs="0">
187                                         <xs:complexType>
188                                                 <xs:attribute name="label" type="xs:string" />
189                                                 <xs:attribute name="value" type="xs:float" />
190                                                 <xs:attribute name="colour" type="xs:int" />
191                                         </xs:complexType>
192                                 </xs:element>
193                                 <xs:element name="property" minOccurs="0" maxOccurs="unbounded">
194                                         <xs:complexType>
195                                                 <xs:attribute name="name" type="xs:string" />
196                                                 <xs:attribute name="value" type="xs:string" />
197                                         </xs:complexType>
198                                 </xs:element>
199                         </xs:sequence>
200                         <xs:attribute name="graph" type="xs:boolean" use="required" />
201                         <xs:attribute name="graphType" type="xs:int" use="optional" />
202                         <xs:attribute name="sequenceRef" type="xs:string"
203                                 use="optional" />
204                         <xs:attribute name="groupRef" type="xs:string"
205                                 use="optional" />
206                         <xs:attribute name="graphColour" type="xs:int"
207                                 use="optional" />
208                         <xs:attribute name="graphGroup" type="xs:int"
209                                 use="optional" />
210                         <xs:attribute name="graphHeight" type="xs:int" use="optional">
211                         <xs:annotation><xs:documentation>height in pixels for the graph if this is a graph-type annotation.</xs:documentation></xs:annotation></xs:attribute>
212                         <xs:attribute name="id" type="xs:string" use="optional" />
213                         <xs:attribute name="scoreOnly" type="xs:boolean"
214                                 use="optional" default="false" />
215                         <xs:attribute name="score" type="xs:double" use="optional" />
216                         <xs:attribute name="visible" type="xs:boolean"
217                                 use="optional" />
218                         <xs:attribute name="centreColLabels" type="xs:boolean"
219                                 use="optional" />
220                         <xs:attribute name="scaleColLabels" type="xs:boolean"
221                                 use="optional" />
222                         <xs:attribute name="showAllColLabels" type="xs:boolean"
223                                 use="optional" />
224
225
226                         <xs:attribute name="autoCalculated" type="xs:boolean" use="optional" default="false">
227                         <xs:annotation><xs:documentation>is an autocalculated annotation row</xs:documentation>
228                         </xs:annotation></xs:attribute>
229                         <xs:attribute name="belowAlignment" type="xs:boolean" use="optional" default="true">
230                         <xs:annotation><xs:documentation>is to be shown below the alignment - introduced in Jalview 2.8 for visualizing T-COFFEE alignment scores</xs:documentation></xs:annotation></xs:attribute>
231                         <xs:attribute name="calcId" type="xs:string" use="optional">
232                         <xs:annotation><xs:documentation>Optional string identifier used to group sets of annotation produced by a particular calculation. Values are opaque strings but have semantic meaning to Jalview's renderer, data importer and calculation system.</xs:documentation></xs:annotation>
233                         </xs:attribute>
234                 </xs:complexType>
235         </xs:element>   
236         <xs:element name="SequenceSet">
237                 <xs:complexType>
238                         <xs:sequence>
239                                 <xs:element ref="vamsas:Sequence" minOccurs="0" maxOccurs="unbounded"/>
240                                 <xs:element ref="vamsas:Annotation" minOccurs="0" maxOccurs="unbounded"/>
241                                 <xs:element name="sequenceSetProperties" minOccurs="0" maxOccurs="unbounded">
242                                         <xs:complexType>
243                                                 <xs:attribute name="key" type="xs:string"/>
244                                                 <xs:attribute name="value" type="xs:string"/>
245                                         </xs:complexType>
246                                 </xs:element>
247                                 <xs:element ref="vamsas:AlcodonFrame" minOccurs="0" maxOccurs="unbounded"/>
248                         </xs:sequence>
249                         <xs:attribute name="gapChar" type="xs:string" use="required"/>
250                         <xs:attribute name="datasetId" type="xs:string" use="optional">
251                                 <xs:annotation>
252                                         <xs:documentation>
253                                                 reference to set where jalview will gather the dataset sequences for all sequences in the set. 
254                                         </xs:documentation>
255                                 </xs:annotation>
256                         </xs:attribute>
257                 </xs:complexType>
258         </xs:element>
259         <xs:element name="annotationElement">
260                 <xs:complexType>
261                         <xs:sequence>
262                                 <xs:element name="displayCharacter" type="xs:string" minOccurs="0"/>
263                                 <xs:element name="description" type="xs:string" minOccurs="0"/>
264                                 <xs:element name="secondaryStructure" minOccurs="0">
265                                         <xs:simpleType>
266                                                 <xs:restriction base="xs:string">
267                                                         <xs:length value="1"/>
268                                                 </xs:restriction>
269                                         </xs:simpleType>
270                                 </xs:element>
271                                 <xs:element name="value" type="xs:float" minOccurs="0"/>
272                         </xs:sequence>
273                         <xs:attribute name="position" type="xs:int" use="required"/>
274                         <xs:attribute name="colour" type="xs:int" use="optional"/>
275                 </xs:complexType>
276         </xs:element>
277         <xs:complexType name="SequenceType">
278                 <xs:sequence>
279                         <xs:element name="sequence" type="xs:string" minOccurs="0"/>
280                         <xs:element name="name" type="xs:string" minOccurs="0"/>
281                 </xs:sequence>
282                 <xs:attribute name="id" type="xs:string"/>
283                 <xs:attribute name="description" type="xs:string"/>
284         </xs:complexType>
285 </xs:schema>