mlhim-specs-dev team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 120
committer: Timothy W. Cook <timothywayne.cook@xxxxxxxxx>
branch nick: mlhim-specs
timestamp: Thu 2011-04-28 23:30:44 -0500
message:
  Inserted documentation for all structures.xsd complexTypes. See https://bugs.launchpad.net/mlhim-specs/+bug/771266
modified:
  schemas/structures.xsd


--
lp:mlhim-specs
https://code.launchpad.net/~mlhim-specs-dev/mlhim-specs/main

Your team MLHIM Specifications Developers is subscribed to branch lp:mlhim-specs.
To unsubscribe from this branch go to https://code.launchpad.net/~mlhim-specs-dev/mlhim-specs/main/+edit-subscription

=== modified file 'schemas/structures.xsd'
--- schemas/structures.xsd	2011-04-28 15:25:40 +0000
+++ schemas/structures.xsd	2011-04-29 04:30:44 +0000
@@ -5,7 +5,7 @@
            <xs:complexType name="DataStructure"  abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Abstract parent class of all data structure types.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -17,7 +17,7 @@
            <xs:complexType name="ItemStructure" abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Abstract parent class of all item structure types.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -29,7 +29,8 @@
            <xs:complexType name="Event" abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Defines the abstract notion of a single event in a series. This class is generic, allowing types to be generated which are 
+	locked to particular spatial types, such as Event<ItemList>. Subtypes express point or interval data.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -46,7 +47,7 @@
            <xs:complexType name="PointEvent"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Defines a single point event in a series.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -58,7 +59,7 @@
            <xs:complexType name="IntervalEvent"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Defines a single interval event in a series.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -75,7 +76,7 @@
            <xs:complexType name="Item" abstract="true">
 	<xs:annotation>
 	<xs:documentation>
-	
+	The abstract parent of Slot, Cluster and Element representation classes.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -87,7 +88,8 @@
            <xs:complexType name="Slot"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	A structure allowing the inclusion of one CCD inside a CCD. An unbounded list of allowable CCDs to choose from
+	should be available at runtime.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -103,7 +105,7 @@
            <xs:complexType name="Element" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	The leaf variant of Item, to which a DvAny instance is attached.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -118,7 +120,7 @@
            <xs:complexType name="Cluster"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	The grouping variant of Item, which may contain further instances of Item, in an ordered list.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -133,7 +135,9 @@
            <xs:complexType name="History"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Root object of a linear history, i.e. time series structure. For a periodic series of events, period will be set, and the time 
+	of each Event in the History must correspond; i.e. the Event.offset must be a multiple of period for each Event. 
+	Missing events in a period History are however allowed.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -153,7 +157,7 @@
            <xs:complexType name="ItemSingle"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Used to represent any data which is logically a single value, such as a person’s height or weight.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -168,7 +172,8 @@
            <xs:complexType name="ItemList"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Logical list data structure, where each item has a value and can be referred to by a name and a positional index in the list. 
+	The list may be empty.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -183,7 +188,11 @@
            <xs:complexType name="ItemTable"  abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Logical relational database style table data structure, in which columns are named and ordered with respect to each other.
+	Implemented using Cluster-per-row encoding. Each row Cluster must have an identical number of Elements, each of which 
+	in turn must have identical names and value types in the corresponding postions in each row. Some columns may be 
+	designated ‘key’ columns, containing key data for each row, in the manner of relational tables. This allows row-naming, 
+	where each row represents a body site, a blood antigen etc. All values in a column have the same data type.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>
@@ -199,7 +208,8 @@
            <xs:complexType name="ItemTree" abstract="false">
 	<xs:annotation>
 	<xs:documentation>
-	
+	Logical tree data structure. The tree may be empty. Used to represent data which are logically a tree such as audiology results, 
+	microbiology results, biochemistry results.
 	</xs:documentation>
 	</xs:annotation>
            <xs:complexContent>