JAL-1479 added SIFTS XSD and generated JAXB bindings from it
[jalview.git] / schemas / sifts / eFamily.xsd
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- edited with XMLSpy v2016 (http://www.altova.com) by Charles (student) -->
3 <xsd:schema xmlns="http://www.ebi.ac.uk/pdbe/docs/sifts/eFamily.xsd" xmlns:data="http://www.ebi.ac.uk/pdbe/docs/sifts/dataTypes.xsd" xmlns:align="http://www.ebi.ac.uk/pdbe/docs/sifts/alignment.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" targetNamespace="http://www.ebi.ac.uk/pdbe/docs/sifts/eFamily.xsd" elementFormDefault="qualified" attributeFormDefault="unqualified" version="2.0">
4         <xsd:include schemaLocation="alignment.xsd"/>
5         <xsd:import namespace="http://www.ebi.ac.uk/pdbe/docs/sifts/dataTypes.xsd" schemaLocation="dataTypes.xsd"/>
6         <xsd:annotation>
7                 <xsd:documentation>The eFamily schema is designed to allow the members of the eFamily consortium to exchange domain definitions.  As members of the different databases use different underlying data (languages) so we need a way of getting between the co-ordinates systems. MSD are to provide the mapping between the co-ordinates (translator), hence the reason for the incorporation of the mappings into the core of the schema. 
8                 </xsd:documentation>
9         </xsd:annotation>
10         <xsd:element name="entry">
11                 <xsd:annotation>
12                         <xsd:documentation>The entry represents a database entry.  This schema is currently designed for domain and mapping entires.</xsd:documentation>
13                 </xsd:annotation>
14                 <xsd:complexType>
15                         <xsd:sequence>
16                                 <xsd:element name="listDB" minOccurs="1" maxOccurs="1">
17                                         <xsd:complexType mixed="false">
18                                                 <xsd:sequence minOccurs="1" maxOccurs="unbounded">
19                                                         <xsd:element name="db">
20                                                                 <xsd:complexType>
21                                                                         <xsd:attributeGroup ref="data:listdbRef"/>
22                                                                 </xsd:complexType>
23                                                         </xsd:element>
24                                                 </xsd:sequence>
25                                         </xsd:complexType>
26                                 </xsd:element>
27                                 <xsd:element name="entryDetail" minOccurs="0" maxOccurs="unbounded">
28                                         <xsd:annotation>
29                                                 <xsd:documentation>This is a free text field that allows someone to attach some sort of documentation to the entry</xsd:documentation>
30                                         </xsd:annotation>
31                                         <xsd:complexType mixed="true">
32                                                 <xsd:attributeGroup ref="data:detail"/>
33                                         </xsd:complexType>
34                                 </xsd:element>
35                                 <xsd:element name="entity" maxOccurs="unbounded">
36                                         <xsd:annotation>
37                                                 <xsd:documentation> An entity is a single domain definition.  In the case of SCOP, there is only one entity per entry, but in the case of Pfam, an entry is a collection of domains/entities.</xsd:documentation>
38                                         </xsd:annotation>
39                                         <xsd:complexType>
40                                                 <xsd:sequence>
41                                                         <xsd:element name="entityDetail" minOccurs="0" maxOccurs="unbounded">
42                                                                 <xsd:annotation>
43                                                                         <xsd:documentation>This is a free text field that allows someone to attach some sort of documentation to the entity</xsd:documentation>
44                                                                 </xsd:annotation>
45                                                                 <xsd:complexType mixed="true">
46                                                                         <xsd:attributeGroup ref="data:detail"/>
47                                                                 </xsd:complexType>
48                                                         </xsd:element>
49                                                         <xsd:element name="segment" maxOccurs="unbounded">
50                                                                 <xsd:annotation>
51                                                                         <xsd:documentation>An entity may not comprise of a single continuous region. This may be used to a chimeric structure or a discontinuous domain</xsd:documentation>
52                                                                 </xsd:annotation>
53                                                                 <xsd:complexType>
54                                                                         <xsd:sequence>
55                                                                                 <xsd:element name="listResidue" minOccurs="0">
56                                                                                         <xsd:annotation>
57                                                                                                 <xsd:documentation>Contains a set of residues objects</xsd:documentation>
58                                                                                         </xsd:annotation>
59                                                                                         <xsd:complexType>
60                                                                                                 <xsd:sequence>
61                                                                                                         <xsd:element name="residue" maxOccurs="unbounded">
62                                                                                                                 <xsd:annotation>
63                                                                                                                         <xsd:documentation>A single residue object.  This object can contain information on what the residue is,  general annotation, the numbering system and co-ordinate mapping </xsd:documentation>
64                                                                                                                 </xsd:annotation>
65                                                                                                                 <xsd:complexType>
66                                                                                                                         <xsd:sequence>
67                                                                                                                                 <xsd:element name="crossRefDb" minOccurs="0" maxOccurs="unbounded">
68                                                                                                                                         <xsd:annotation>
69                                                                                                                                                 <xsd:documentation>Allows the linking between different co-ordinate systems</xsd:documentation>
70                                                                                                                                         </xsd:annotation>
71                                                                                                                                         <xsd:complexType>
72                                                                                                                                                 <xsd:attributeGroup ref="data:dbRef"/>
73                                                                                                                                                 <xsd:attributeGroup ref="data:resRef"/>
74                                                                                                                                                 <xsd:attribute name="dbChainId" type="data:chainId" use="optional"/>
75                                                                                                                                         </xsd:complexType>
76                                                                                                                                 </xsd:element>
77                                                                                                                                 <xsd:element name="residueDetail" minOccurs="0" maxOccurs="unbounded">
78                                                                                                                                         <xsd:annotation>
79                                                                                                                                                 <xsd:documentation>This allows one to add information to the residues.  For example whether it is observed or whether it is an active site residue</xsd:documentation>
80                                                                                                                                         </xsd:annotation>
81                                                                                                                                         <xsd:complexType mixed="true">
82                                                                                                                                                 <xsd:attributeGroup ref="data:detail"/>
83                                                                                                                                         </xsd:complexType>
84                                                                                                                                 </xsd:element>
85                                                                                                                         </xsd:sequence>
86                                                                                                                         <xsd:attributeGroup ref="data:resRef"/>
87                                                                                                                         <xsd:attributeGroup ref="data:listdbRef"/>
88                                                                                                                 </xsd:complexType>
89                                                                                                         </xsd:element>
90                                                                                                 </xsd:sequence>
91                                                                                         </xsd:complexType>
92                                                                                 </xsd:element>
93                                                                                 <xsd:element name="listMapRegion" minOccurs="0">
94                                                                                         <xsd:annotation>
95                                                                                                 <xsd:documentation>Allows cross referencing to another database.  For example, one may wish to include which the taxon that a mapping or sequence corresponds</xsd:documentation>
96                                                                                         </xsd:annotation>
97                                                                                         <xsd:complexType>
98                                                                                                 <xsd:sequence>
99                                                                                                         <xsd:element name="mapRegion" maxOccurs="unbounded">
100                                                                                                                 <xsd:annotation>
101                                                                                                                         <xsd:documentation>Defines the database that is being cross mapped to</xsd:documentation>
102                                                                                                                 </xsd:annotation>
103                                                                                                                 <xsd:complexType>
104                                                                                                                         <xsd:sequence>
105                                                                                                                                 <xsd:element name="db">
106                                                                                                                                         <xsd:annotation>
107                                                                                                                                                 <xsd:documentation>Contains the mapping coordinates.  The start end tags refer to the master databse co-ordinates.  The tags prefixed with sys refer to the database being mapped to.</xsd:documentation>
108                                                                                                                                         </xsd:annotation>
109                                                                                                                                         <xsd:complexType>
110                                                                                                                                                 <xsd:sequence>
111                                                                                                                                                         <xsd:element name="dbDetail" minOccurs="0" maxOccurs="unbounded">
112                                                                                                                                                                 <xsd:complexType mixed="true">
113                                                                                                                                                                         <xsd:attributeGroup ref="data:detail"/>
114                                                                                                                                                                 </xsd:complexType>
115                                                                                                                                                         </xsd:element>
116                                                                                                                                                 </xsd:sequence>
117                                                                                                                                                 <xsd:attributeGroup ref="data:dbRef"/>
118                                                                                                                                                 <xsd:attribute name="dbChainId" type="data:dbChainId" use="optional"/>
119                                                                                                                                                 <xsd:attributeGroup ref="data:region"/>
120                                                                                                                                         </xsd:complexType>
121                                                                                                                                 </xsd:element>
122                                                                                                                         </xsd:sequence>
123                                                                                                                         <xsd:attributeGroup ref="data:region"/>
124                                                                                                                 </xsd:complexType>
125                                                                                                         </xsd:element>
126                                                                                                 </xsd:sequence>
127                                                                                         </xsd:complexType>
128                                                                                 </xsd:element>
129                                                                                 <xsd:element name="segmentDetail" minOccurs="0" maxOccurs="unbounded">
130                                                                                         <xsd:annotation>
131                                                                                                 <xsd:documentation>This is a free text field that allows someone to attach some sort of documentation to the segment</xsd:documentation>
132                                                                                         </xsd:annotation>
133                                                                                         <xsd:complexType mixed="true">
134                                                                                                 <xsd:attributeGroup ref="data:detail"/>
135                                                                                         </xsd:complexType>
136                                                                                 </xsd:element>
137                                                                         </xsd:sequence>
138                                                                         <xsd:attribute name="segId" type="xsd:string" use="required"/>
139                                                                         <xsd:attributeGroup ref="data:region"/>
140                                                                 </xsd:complexType>
141                                                         </xsd:element>
142                                                 </xsd:sequence>
143                                                 <xsd:attribute name="type" type="data:entityType" use="required"/>
144                                                 <xsd:attribute name="entityId" type="xsd:string" use="required"/>
145                                         </xsd:complexType>
146                                 </xsd:element>
147                                 <xsd:element ref="alignment" minOccurs="0" maxOccurs="unbounded"/>
148                         </xsd:sequence>
149                         <xsd:attributeGroup ref="data:dbRef"/>
150                         <xsd:attribute name="date" type="xsd:date" use="required"/>
151                         <xsd:attribute name="dbEntryVersion" type="xsd:date" use="required"/>
152                 </xsd:complexType>
153         </xsd:element>
154 </xsd:schema>