Changeset 195 for Xml/Working/SPW.xsd
- Timestamp:
- 09/10/08 12:03:10 (4 months ago)
- Files:
-
- 1 modified
-
Xml/Working/SPW.xsd (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
Xml/Working/SPW.xsd
r189 r195 1 1 <?xml version="1.0" encoding="UTF-8"?> 2 2 <!-- 3 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~4 #5 # Copyright (C) 2003-2008 Open Microscopy Environment6 #Massachusetts Institute of Technology,7 #National Institutes of Health,8 #University of Dundee,9 #University of Wisconsin at Madison10 #11 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~3 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4 # 5 # Copyright (C) 2003-2008 Open Microscopy Environment 6 # Massachusetts Institute of Technology, 7 # National Institutes of Health, 8 # University of Dundee, 9 # University of Wisconsin at Madison 10 # 11 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 12 12 --> 13 13 <!-- 14 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~15 # Written by: Andrew Patterson <ajpatterson@lifesci.dundee.ac.uk>16 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~14 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 15 # Written by: Andrew Patterson <ajpatterson@lifesci.dundee.ac.uk> 16 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 17 17 --> 18 18 <xsd:schema xmlns="http://www.openmicroscopy.org/Schemas/SPW/2008-02" 19 targetNamespace="http://www.openmicroscopy.org/Schemas/SPW/2008-02"20 xmlns:OME="http://www.openmicroscopy.org/Schemas/OME/2008-02"21 xmlns:xsd="http://www.w3.org/2001/XMLSchema"22 version="1"23 elementFormDefault="qualified">24 <xsd:import namespace="http://www.openmicroscopy.org/Schemas/OME/2008-02" schemaLocation="http://www.openmicroscopy.org/Schemas/OME/2008-02/ome.xsd"/>25 26 <xsd:annotation>27 <xsd:documentation>28 Open Microscopy Environment29 Screen, Plate, and Well XML Schema30 Author:Andrew J Patterson31 </xsd:documentation>32 </xsd:annotation>33 34 <xsd:element name="Plate">35 <xsd:annotation>36 <xsd:documentation>37 This element identifies microtiter plates within a screen.38 A plate can belong to more than one screen.39 The Screen(s) that a plate belongs to are specified by the ScreenRef element.40 The Plate ID and Name attributes are required.19 targetNamespace="http://www.openmicroscopy.org/Schemas/SPW/2008-02" 20 xmlns:OME="http://www.openmicroscopy.org/Schemas/OME/2008-02" 21 xmlns:xsd="http://www.w3.org/2001/XMLSchema" 22 version="1" 23 elementFormDefault="qualified"> 24 <xsd:import namespace="http://www.openmicroscopy.org/Schemas/OME/2008-02" schemaLocation="http://www.openmicroscopy.org/Schemas/OME/2008-02/ome.xsd"/> 25 26 <xsd:annotation> 27 <xsd:documentation> 28 Open Microscopy Environment 29 Screen, Plate, and Well XML Schema 30 Author: Andrew J Patterson 31 </xsd:documentation> 32 </xsd:annotation> 33 34 <xsd:element name="Plate"> <!-- top level definition --> 35 <xsd:annotation> 36 <xsd:documentation> 37 This element identifies microtiter plates within a screen. 38 A plate can belong to more than one screen. 39 The Screen(s) that a plate belongs to are specified by the ScreenRef element. 40 The Plate ID and Name attributes are required. 41 41 The Wells in a plate are numbers from the top-left corner in a grid starting at zero. 42 42 i.e The top-left well of a plate is index (0,0) 43 </xsd:documentation>44 </xsd:annotation>45 <xsd:complexType>46 <xsd:sequence>47 <xsd:element ref="ScreenRef" minOccurs="0" maxOccurs="unbounded"/>48 <xsd:element ref="Well" minOccurs="0" maxOccurs="unbounded"/>49 </xsd:sequence>50 <xsd:attribute name="ID" use="required" type="PlateID"/>51 <xsd:attribute name="Name" use="required" type="xsd:string">52 <xsd:annotation>53 <xsd:documentation>54 The Name identifies the plate to the user.It is used much like the55 ID, and so must be unique within the document.56 </xsd:documentation>57 </xsd:annotation>58 </xsd:attribute> 59 <xsd:attribute name="Description" type="xsd:string"/>60 <xsd:attribute name="Status" type="xsd:string">61 <xsd:annotation>62 <xsd:documentation>63 A textual annotation of the current state of the plate with respect to the43 </xsd:documentation> 44 </xsd:annotation> 45 <xsd:complexType> 46 <xsd:sequence> 47 <xsd:element ref="ScreenRef" minOccurs="0" maxOccurs="unbounded"/> 48 <xsd:element ref="Well" minOccurs="0" maxOccurs="unbounded"/> 49 </xsd:sequence> 50 <xsd:attribute name="ID" use="required" type="PlateID"/> 51 <xsd:attribute name="Name" use="required" type="xsd:string"> 52 <xsd:annotation> 53 <xsd:documentation> 54 The Name identifies the plate to the user. It is used much like the 55 ID, and so must be unique within the document. 56 </xsd:documentation> 57 </xsd:annotation> 58 </xsd:attribute> 59 <xsd:attribute name="Description" use="optional" type="xsd:string"/> 60 <xsd:attribute name="Status" use="optional" type="xsd:string"> 61 <xsd:annotation> 62 <xsd:documentation> 63 A textual annotation of the current state of the plate with respect to the 64 64 experiment work-flow; e.g. 65 65 1. Seed cell: done; 2. Transfection: done; 3. Gel doc: todo. 66 </xsd:documentation>67 </xsd:annotation>68 </xsd:attribute> 69 <xsd:attribute name="ExternalIdentifier" type="xsd:string">70 <xsd:annotation>71 <xsd:documentation>72 The ExternalIdentifier attribute may contain a reference to an external database.73 </xsd:documentation>74 </xsd:annotation>75 </xsd:attribute> 76 </xsd:complexType>77 </xsd:element>78 79 <xsd:element name="PlateRef">80 <xsd:annotation>81 <xsd:documentation>82 The PlateRef element is a reference to a Plate element.83 Screen elements may have one or more PlateRef elements to define the plates that are part of the screen.84 Plates may belong to more than one screen.85 </xsd:documentation>86 </xsd:annotation>87 <xsd:complexType>88 <xsd:complexContent>89 <xsd:extension base="OME:Reference">90 <xsd:attribute name="ID" use="required" type="PlateID"/>91 </xsd:extension>92 </xsd:complexContent>93 </xsd:complexType>94 </xsd:element>95 96 <xsd:simpleType name="PlateID">97 <xsd:restriction base="OME:LSID">98 <xsd:pattern value="(urn:lsid:([\w\-\.]+\.[\w\-\.]+)+:Plate:\S+)|(Plate:\S+)"/>99 </xsd:restriction>100 </xsd:simpleType>101 102 <xsd:element name="Reagent">103 <xsd:annotation>104 <xsd:documentation>105 Reagent is used to describe a chemical or some other physical experimental parameter.106 </xsd:documentation>107 </xsd:annotation>108 <xsd:complexType>109 <xsd:attribute name="ID" use="required" type="ReagentID"/>110 <xsd:attribute name="Description" type="xsd:string">111 <xsd:annotation>112 <xsd:documentation>66 </xsd:documentation> 67 </xsd:annotation> 68 </xsd:attribute> 69 <xsd:attribute name="ExternalIdentifier" use="optional" type="xsd:string"> 70 <xsd:annotation> 71 <xsd:documentation> 72 The ExternalIdentifier attribute may contain a reference to an external database. 73 </xsd:documentation> 74 </xsd:annotation> 75 </xsd:attribute> 76 </xsd:complexType> 77 </xsd:element> 78 79 <xsd:element name="PlateRef"> <!-- top level definition --> 80 <xsd:annotation> 81 <xsd:documentation> 82 The PlateRef element is a reference to a Plate element. 83 Screen elements may have one or more PlateRef elements to define the plates that are part of the screen. 84 Plates may belong to more than one screen. 85 </xsd:documentation> 86 </xsd:annotation> 87 <xsd:complexType> 88 <xsd:complexContent> 89 <xsd:extension base="OME:Reference"> 90 <xsd:attribute name="ID" use="required" type="PlateID"/> 91 </xsd:extension> 92 </xsd:complexContent> 93 </xsd:complexType> 94 </xsd:element> 95 96 <xsd:simpleType name="PlateID"> 97 <xsd:restriction base="OME:LSID"> 98 <xsd:pattern value="(urn:lsid:([\w\-\.]+\.[\w\-\.]+)+:Plate:\S+)|(Plate:\S+)"/> 99 </xsd:restriction> 100 </xsd:simpleType> 101 102 <xsd:element name="Reagent"> <!-- top level definition --> 103 <xsd:annotation> 104 <xsd:documentation> 105 Reagent is used to describe a chemical or some other physical experimental parameter. 106 </xsd:documentation> 107 </xsd:annotation> 108 <xsd:complexType> 109 <xsd:attribute name="ID" use="required" type="ReagentID"/> 110 <xsd:attribute name="Description" use="optional" type="xsd:string"> 111 <xsd:annotation> 112 <xsd:documentation> 113 113 A long description for the reagent 114 </xsd:documentation>115 </xsd:annotation> 116 </xsd:attribute>117 <xsd:attribute name="Name" type="xsd:string">118 <xsd:annotation>119 <xsd:documentation>114 </xsd:documentation> 115 </xsd:annotation> 116 </xsd:attribute> 117 <xsd:attribute name="Name" use="optional" type="xsd:string"> 118 <xsd:annotation> 119 <xsd:documentation> 120 120 A short name for the reagent 121 </xsd:documentation>122 </xsd:annotation>123 </xsd:attribute>124 <xsd:attribute name="ReagentIdentifier" type="xsd:string">125 <xsd:annotation>126 <xsd:documentation>127 This is a reference to an external (to OME) representation of the Reagent.128 It serves as a foreign key into an external database. - It is sometimes refereed to as ExternalIdentifier.129 </xsd:documentation>130 </xsd:annotation>131 </xsd:attribute>132 </xsd:complexType>133 </xsd:element>134 135 <xsd:element name="ReagentRef">136 <xsd:complexType>137 <xsd:complexContent>138 <xsd:extension base="OME:Reference">139 <xsd:attribute name="ID" use="required" type="ReagentID"/>140 </xsd:extension>141 </xsd:complexContent>142 </xsd:complexType>143 </xsd:element>144 145 <xsd:simpleType name="ReagentID">146 <xsd:restriction base="OME:LSID">147 <xsd:pattern value="(urn:lsid:([\w\-\.]+\.[\w\-\.]+)+:Reagent:\S+)|(Reagent:\S+)"/>148 </xsd:restriction>149 </xsd:simpleType>150 151 <xsd:element name="Screen">152 <xsd:annotation>153 <xsd:documentation>154 The Screen element is a grouping for Plates.155 The required attribute is the Screen's Name and ID - both must be unique within the document.156 The Screen element may contain an ExternalRef attribute that refers to an external database.157 A description of the screen may be specified in the Description element.158 Screens may contain overlapping sets of Plates i.e.Screens and Plates have a many-to-many relationship.159 Plates contain one or more ScreenRef elements to specify what screens they belong to.160 </xsd:documentation>161 </xsd:annotation>162 <xsd:complexType>163 <xsd:sequence>164 <xsd:element ref="OME:Description" minOccurs="0"/>165 <xsd:element ref="Reagent" minOccurs="0" maxOccurs="unbounded"/>166 <xsd:element ref="PlateRef" minOccurs="0" maxOccurs="unbounded"/>167 <xsd:element ref="ScreenAcquisition" minOccurs="0" maxOccurs="unbounded"/>168 </xsd:sequence>169 <xsd:attribute name="ID" use="required" type="ScreenID"/>170 <xsd:attribute name="Name" use="required" type="xsd:string"/>171 <xsd:attribute name="ProtocolIdentifier" type="xsd:string">172 <xsd:annotation>173 <xsd:documentation>121 </xsd:documentation> 122 </xsd:annotation> 123 </xsd:attribute> 124 <xsd:attribute name="ReagentIdentifier" use="optional" type="xsd:string"> 125 <xsd:annotation> 126 <xsd:documentation> 127 This is a reference to an external (to OME) representation of the Reagent. 128 It serves as a foreign key into an external database. - It is sometimes refereed to as ExternalIdentifier. 129 </xsd:documentation> 130 </xsd:annotation> 131 </xsd:attribute> 132 </xsd:complexType> 133 </xsd:element> 134 135 <xsd:element name="ReagentRef"> <!-- top level definition --> 136 <xsd:complexType> 137 <xsd:complexContent> 138 <xsd:extension base="OME:Reference"> 139 <xsd:attribute name="ID" use="required" type="ReagentID"/> 140 </xsd:extension> 141 </xsd:complexContent> 142 </xsd:complexType> 143 </xsd:element> 144 145 <xsd:simpleType name="ReagentID"> 146 <xsd:restriction base="OME:LSID"> 147 <xsd:pattern value="(urn:lsid:([\w\-\.]+\.[\w\-\.]+)+:Reagent:\S+)|(Reagent:\S+)"/> 148 </xsd:restriction> 149 </xsd:simpleType> 150 151 <xsd:element name="Screen"> <!-- top level definition --> 152 <xsd:annotation> 153 <xsd:documentation> 154 The Screen element is a grouping for Plates. 155 The required attribute is the Screen's Name and ID - both must be unique within the document. 156 The Screen element may contain an ExternalRef attribute that refers to an external database. 157 A description of the screen may be specified in the Description element. 158 Screens may contain overlapping sets of Plates i.e. Screens and Plates have a many-to-many relationship. 159 Plates contain one or more ScreenRef elements to specify what screens they belong to. 160 </xsd:documentation> 161 </xsd:annotation> 162 <xsd:complexType> 163 <xsd:sequence> 164 <xsd:element ref="OME:Description" minOccurs="0" maxOccurs="1"/> 165 <xsd:element ref="Reagent" minOccurs="0" maxOccurs="unbounded"/> 166 <xsd:element ref="PlateRef" minOccurs="0" maxOccurs="unbounded"/> 167 <xsd:element ref="ScreenAcquisition" minOccurs="0" maxOccurs="unbounded"/> 168 </xsd:sequence> 169 <xsd:attribute name="ID" use="required" type="ScreenID"/> 170 <xsd:attribute name="Name" use="required" type="xsd:string"/> 171 <xsd:attribute name="ProtocolIdentifier" use="optional" type="xsd:string"> 172 <xsd:annotation> 173 <xsd:documentation> 174 174 A pointer to an externally defined protocol, usually in a screening database. 175 </xsd:documentation>176 </xsd:annotation>175 </xsd:documentation> 176 </xsd:annotation> 177 177 </xsd:attribute> 178 <xsd:attribute name="ProtocolDescription" type="xsd:string">179 <xsd:annotation>180 <xsd:documentation>178 <xsd:attribute name="ProtocolDescription" use="optional" type="xsd:string"> 179 <xsd:annotation> 180 <xsd:documentation> 181 181 A description of the screen protocol; may contain very detailed information to 182 182 reproduce some of that found in a screening database. 183 </xsd:documentation>184 </xsd:annotation>183 </xsd:documentation> 184 </xsd:annotation> 185 185 </xsd:attribute> 186 <xsd:attribute name="ReagentSetDescription" type="xsd:string">187 <xsd:annotation>188 <xsd:documentation>186 <xsd:attribute name="ReagentSetDescription" use="optional" type="xsd:string"> 187 <xsd:annotation> 188 <xsd:documentation> 189 189 A description of the set of reagents; may contain very detailed information to 190 190 reproduce some of that information found in a screening database. 191 </xsd:documentation>192 </xsd:annotation>191 </xsd:documentation> 192 </xsd:annotation> 193 193 </xsd:attribute> 194 <xsd:attribute name="ReagentSetIdentifier" type="xsd:string">195 <xsd:annotation>196 <xsd:documentation>194 <xsd:attribute name="ReagentSetIdentifier" use="optional" type="xsd:string"> 195 <xsd:annotation> 196 <xsd:documentation> 197 197 A pointer to an externally defined set of reagents, usually in a screening 198 198 database/automation database. 199 </xsd:documentation>200 </xsd:annotation>199 </xsd:documentation> 200 </xsd:annotation> 201 201 </xsd:attribute> 202 <xsd:attribute name="Type" type="xsd:string">203 <xsd:annotation>204 <xsd:documentation>202 <xsd:attribute name="Type" use="optional" type="xsd:string"> 203 <xsd:annotation> 204 <xsd:documentation> 205 205 A human readable identifier for the screen type; e.g. RNAi, cDNA, SiRNA, etc. 206 206 This string is likely to become an enumeration in future releases. 207 </xsd:documentation>208 </xsd:annotation>207 </xsd:documentation> 208 </xsd:annotation> 209 209 </xsd:attribute> 210 </xsd:complexType>211 </xsd:element>212 213 <xsd:simpleType name="ScreenID">214 <xsd:restriction base="OME:LSID">215 <xsd:pattern value="(urn:lsid:([\w\-\.]+\.[\w\-\.]+)+:Screen:\S+)|(Screen:\S+)"/>216 </xsd:restriction>217 </xsd:simpleType>218 219 <xsd:element name="ScreenRef">220 <xsd:annotation>221 <xsd:documentation>222 The ScreenRef element is a reference to a Screen element.223 Plate elements may have one or more ScreenRef elements to define the screen that a plate belongs to.224 Plates may belong to more than one screen.225 </xsd:documentation>226 </xsd:annotation>227 <xsd:complexType>228 <xsd:complexContent>229 <xsd:extension base="OME:Reference">230 <xsd:attribute name="ID" use="required" type="ScreenID"/>231 </xsd:extension>232 </xsd:complexContent>233 </xsd:complexType>234 </xsd:element>235 236 <xsd:element name="ScreenAcquisition">237 <xsd:annotation>238 <xsd:documentation>239 ScreenAcquisition is used to describe a single acquisition run for a screen.240 Since Screens are abstract, this object is used to record the set of images241 acquired in a single acquisition run. The Images for this run are linked242 to ScreenAcquisition through WellSample.243 </xsd:documentation>244 </xsd:annotation>245 <xsd:complexType>246 <xsd:sequence>247 <xsd:element ref="WellSampleRef" minOccurs="0" maxOccurs="unbounded"/>248 </xsd:sequence>249 <xsd:attribute name="ID" use="required" type="ScreenAcquisitionID"/>250 <xsd:attribute name="EndTime" type="xsd:dateTime">251 <xsd:annotation>252 <xsd:documentation>210 </xsd:complexType> 211 </xsd:element> 212 213 <xsd:simpleType name="ScreenID"> 214 <xsd:restriction base="OME:LSID"> 215 <xsd:pattern value="(urn:lsid:([\w\-\.]+\.[\w\-\.]+)+:Screen:\S+)|(Screen:\S+)"/> 216 </xsd:restriction> 217 </xsd:simpleType> 218 219 <xsd:element name="ScreenRef"> <!-- top level definition --> 220 <xsd:annotation> 221 <xsd:documentation> <!-- top level definition --> 222 The ScreenRef element is a reference to a Screen element. 223 Plate elements may have one or more ScreenRef elements to define the screen that a plate belongs to. 224 Plates may belong to more than one screen. 225 </xsd:documentation> 226 </xsd:annotation> 227 <xsd:complexType> 228 <xsd:complexContent> 229 <xsd:extension base="OME:Reference"> 230 <xsd:attribute name="ID" use="required" type="ScreenID"/> 231 </xsd:extension> 232 </xsd:complexContent> 233 </xsd:complexType> 234 </xsd:element> 235 236 <xsd:element name="ScreenAcquisition"> <!-- top level definition --> 237 <xsd:annotation> 238 <xsd:documentation> 239 ScreenAcquisition is used to describe a single acquisition run for a screen. 240 Since Screens are abstract, this object is used to record the set of images 241 acquired in a single acquisition run. The Images for this run are linked 242 to ScreenAcquisition through WellSample. 243 </xsd:documentation> 244 </xsd:annotation> 245 <xsd:complexType> 246 <xsd:sequence> 247 <xsd:element ref="WellSampleRef" minOccurs="0" maxOccurs="unbounded"/> 248 </xsd:sequence> 249 <xsd:attribute name="ID" use="required" type="ScreenAcquisitionID"/> 250 <xsd:attribute name="EndTime" use="optional" type="xsd:dateTime"> 251 <xsd:annotation> 252 <xsd:documentation> 253 253 Time when the last image of this acquisition was collected 254 </xsd:documentation>255 </xsd:annotation>256 </xsd:attribute>257 <xsd:attribute name="StartTime" type="xsd:dateTime">258 <xsd:annotation>259 <xsd:documentation>254 </xsd:documentation> 255 </xsd:annotation> 256 </xsd:attribute> 257 <xsd:attribute name="StartTime" use="optional" type="xsd:dateTime"> 258 <xsd:annotation> 259 <xsd:documentation> 260 260 Time when the first image of this acquisition was collected 261 </xsd:documentation>262 </xsd:annotation>263 </xsd:attribute>264 </xsd:complexType>265 </xsd:element>266 267 <xsd:simpleType name="ScreenAcquisitionID">268 <xsd:restriction base="OME:LSID">269 <xsd:pattern value="(urn:lsid:([\w\-\.]+\.[\w\-\.]+)+:ScreenAcquisition:\S+)|(ScreenAcquisition:\S+)"/>270 </xsd:restriction>271 </xsd:simpleType>272 273 <xsd:element name="Well">274 <xsd:annotation>275 <xsd:documentation>276 A Well is a component of the Well/Plate/Screen construct to describe screening applications.277 A Well has a number of WellSample elements that link to the Images collected in this well.278 The ReagentRef links any Reagents that were used in this Well. A well is part of only one Plate.261 </xsd:documentation> 262 </xsd:annotation>
