Documentation for OME Schemas

Table of Contents

Master schema documentation file: ome.xsd.html

top

Schema Document Properties

Target Namespace http://www.openmicroscopy.org/Schemas/STD/2008-09
Version 1
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
STD http://www.openmicroscopy.org/Schemas/STD/2008-09
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema targetNamespace="http://www.openmicroscopy.org/Schemas/STD/2008-09" version="1" elementFormDefault="qualified">
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="http://www.w3.org/2001/xml.xsd"/>
...
</xsd:schema>
top

Global Declarations

Attribute: SemanticTypeName

Name SemanticTypeName
Type Locally-defined simple type
XML Instance Representation
STD:SemanticTypeName=" xsd:string (length <= 64)"
Diagram
Schema Component Representation
<xsd:attribute name="SemanticTypeName">
<-- top level definition -->
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:maxLength value="64"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
top

Element: Description

Name Description
Used by (from the same schema document) Element Element , Element SemanticType
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Just some human-readable text to serve as documentation.
Logical Diagram
XML Instance Representation
<STD:Description
xml:lang="[0..1]">
xsd:string
</STD:Description>
Diagram
Schema Component Representation
<xsd:element name="Description">
<-- top level definition -->
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute ref=" xml:lang" default="en" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
top

Element: Element

Name Element
Used by (from the same schema document) Element SemanticType
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Describes a field of a SemanticType
Logical Diagram
element_Label element_Description
XML Instance Representation
<STD:Element
Name=" xsd:string (length <= 64) [1]"
DBLocation=" xsd:string [0..1]"
DataType=" xsd:string (value comes from list: {'bigint'|'integer'|'smallint'|'double'|'float'|'boolean'|'string'|'reference'}) [1]"
RefersTo=" xsd:string [0..1]">
<STD:Label> ... </STD:Label> [0..*]
<STD:Description> ... </STD:Description> [0..*]
</STD:Element>
Diagram
element_Label element_Description
Schema Component Representation
<xsd:element name="Element">
<-- top level definition -->
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" STD:Label " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref=" STD:Description " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="Name" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:maxLength value="64"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="DBLocation" type=" xsd:string " use="optional"/>
<xsd:attribute name="DataType" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="bigint"/>
<xsd:enumeration value="integer"/>
<xsd:enumeration value="smallint"/>
<xsd:enumeration value="double"/>
<xsd:enumeration value="float"/>
<xsd:enumeration value="boolean"/>
<xsd:enumeration value="string"/>
<xsd:enumeration value="reference"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="RefersTo" type=" xsd:string " use="optional"/>
</xsd:complexType>
</xsd:element>
top

Element: Label

Name Label
Used by (from the same schema document) Element Element , Element SemanticType
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<STD:Label
xml:lang="[0..1]">
xsd:string
</STD:Label>
Diagram
Schema Component Representation
<xsd:element name="Label">
<-- top level definition -->
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute ref=" xml:lang" default="en" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
top

Element: SemanticType

Name SemanticType
Used by (from the same schema document) Element SemanticTypeDefinitions
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Defines a semantic type. Notes: Granularity of SemanticType is infered from the granularity of the record it derives from. In a record, this granularity is specified by the AppliesTo attribute.
Logical Diagram
element_Label element_Description element_Element
XML Instance Representation
<STD:SemanticType
Name=" xsd:string (length <= 64) [1]"
Parent=" xsd:string (length <= 64) [0..1]"
AppliesTo=" xsd:string (value comes from list: {'G'|'D'|'I'|'F'}) (length = 1) [1]

'This specifies what this record is an attribute of. The options are Global, Dataset, Image, or Region (was called Feature hence letter F).'

"
>
<!--
Uniqueness Constraint - SemanticElement
Selector - STD:SemanticElement
Field(s) - @Name
-->

<STD:Label> ... </STD:Label> [0..*]
<STD:Description> ... </STD:Description> [0..*]
<STD:Element> ... </STD:Element> [1..*]
</STD:SemanticType>
Diagram
element_Label element_Description element_Element
Schema Component Representation
<xsd:element name="SemanticType">
<-- top level definition -->
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" STD:Label " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref=" STD:Description " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref=" STD:Element " maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="Name" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:maxLength value="64"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="Parent" use="optional">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:maxLength value="64"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="AppliesTo" use="required">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="G"/>
<xsd:enumeration value="D"/>
<xsd:enumeration value="I"/>
<xsd:enumeration value="F"/>
<xsd:length value="1"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
<xsd:unique name="SemanticElement">
<xsd:selector xpath="STD:SemanticElement"/>
<xsd:field xpath="@Name"/>
</xsd:unique>
</xsd:element>
top

Element: SemanticTypeDefinitions

Name SemanticTypeDefinitions
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Describes semantic types that can be derived from custom attributes.
Logical Diagram
element_SemanticType
XML Instance Representation
<STD:SemanticTypeDefinitions>
<!--
Uniqueness Constraint - SemanticTypeName
Selector - STD:SemanticType
Field(s) - @SemanticTypeName
-->

<STD:SemanticType> ... </STD:SemanticType> [1..*]
</STD:SemanticTypeDefinitions>
Diagram
element_SemanticType
Schema Component Representation
<xsd:element name="SemanticTypeDefinitions">
<-- top level definition -->
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" STD:SemanticType " minOccurs="1" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:unique name="SemanticTypeName">
<xsd:selector xpath="STD:SemanticType"/>
<xsd:field xpath="@SemanticTypeName"/>
</xsd:unique>
</xsd:element>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top