XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace BatteryML:2.0
Version 0.2
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.

Declared Namespaces

Prefix Namespace
Default namespace BatteryML:2.0
xml http://www.w3.org/XML/1998/namespace
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema targetNamespace="BatteryML:2.0" elementFormDefault="qualified" attributeFormDefault="unqualified" version="0.2">
...
</xsd:schema>
top

Global Declarations

Element: Device

Name Device
Type DeviceDBEntryType
Nillable no
Abstract no
Documentation Device element in DeviceDB.
XML Instance Representation
<Device
name="ShortTokenType [0..1]"
id="ShortNameType [1]"
type="DeviceTypeType [0..1]">
<Part> PartRefType </Part> [0..*]
<PartSet> ... </PartSet> [0..*]
<Pack> PackRefType </Pack> [0..*]
<PackSet> ... </PackSet> [0..*]
<Module> ModuleRefType </Module> [0..*]
<ModuleSet> ... </ModuleSet> [0..*]
<Cell> CellRefType </Cell> [0..*]
<CellSet> ... </CellSet> [0..*]
<CellSandwich> CellSandwichRefType </CellSandwich> [0..*]
<CellSandwichSet> ... </CellSandwichSet> [0..*]
Start Choice [0..1]
<Model> ModelType </Model> [0..1]
<ModelDefinition> DefinitionType </ModelDefinition> [0..1]
End Choice
<Parameters> ... </Parameters> [0..1]
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
Model group reference (not shown): ElementInfoGroup [0..1]
</Device>
Schema Component Representation
<xsd:element name="Device" type="DeviceDBEntryType"/>
top

Element: DeviceDB

Name DeviceDB
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Main database with device definitions. Definitions can exist only in DeviceDB. The device definitions are referenced from other databases by argument ref that is linked to device id.
XML Instance Representation
<DeviceDB
Attribute group reference (not shown): OptionalNameGroup
>
<!--
Key Constraint - DeviceIdKey
Selector - ./Device | ./DeviceSet
Field(s) - @id
-->

<Device> ... </Device> [0..*]
<DeviceSet> ... </DeviceSet> [0..*]
Model group reference (not shown): ElementInfoGroup [0..1]
</DeviceDB>
Schema Component Representation
<xsd:element name="DeviceDB">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="Device" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="DeviceSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
</xsd:complexType>
<xsd:key name="DeviceIdKey">
<xsd:selector xpath="./Device | ./DeviceSet"/>
<xsd:field xpath="@id"/>
</xsd:key>
</xsd:element>
top

Element: DeviceDB_Test_Doc

Name DeviceDB_Test_Doc
Type Locally-defined complex type
Nillable no
Abstract no
Documentation For testing.
XML Instance Representation
<DeviceDB_Test_Doc>
Allow any elements from this schema's namespace (strict validation). [0..*]
</DeviceDB_Test_Doc>
Schema Component Representation
<xsd:element name="DeviceDB_Test_Doc">
<xsd:complexType>
<xsd:sequence>
<xsd:any namespace="##targetNamespace" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: DeviceSet

Name DeviceSet
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Device set element in DeviceDB.
XML Instance Representation
<DeviceSet
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
<!--
Key Constraint - DeviceSetIdKey
Selector - ./Device
Field(s) - @idref
-->

<Device> DeviceRefType </Device> [0..*]
</DeviceSet>
Schema Component Representation
<xsd:element name="DeviceSet">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Device" type="DeviceRefType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="name" type="ShortTokenType" use="optional"/>
<xsd:attribute name="id" type="ShortNameType" use="required"/>
</xsd:complexType>
<xsd:key name="DeviceSetIdKey">
<xsd:selector xpath="./Device"/>
<xsd:field xpath="@idref"/>
</xsd:key>
</xsd:element>
top

Global Definitions

Complex Type: DeviceAbstractType

Super-types: None
Sub-types:
Name DeviceAbstractType
Abstract yes
Documentation Main instance of device type. Contains all the hierarchical devices of the device instance.
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [0..1]"
type="DeviceTypeType [0..1]"
idref="ShortNameType [0..1]">
<Part> PartRefType </Part> [0..*]
<PartSet> ... </PartSet> [0..*]
<Pack> PackRefType </Pack> [0..*]
<PackSet> ... </PackSet> [0..*]
<Module> ModuleRefType </Module> [0..*]
<ModuleSet> ... </ModuleSet> [0..*]
<Cell> CellRefType </Cell> [0..*]
<CellSet> ... </CellSet> [0..*]
<CellSandwich> CellSandwichRefType </CellSandwich> [0..*]
<CellSandwichSet> ... </CellSandwichSet> [0..*]
Start Choice [0..1]
<Model> ModelType </Model> [0..1]
<ModelDefinition> DefinitionType </ModelDefinition> [0..1]
End Choice
<Parameters> ... </Parameters> [0..1]
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
Model group reference (not shown): ElementInfoGroup [0..1]
</...>
Schema Component Representation
<xsd:complexType name="DeviceAbstractType" abstract="true">
<xsd:sequence>
<xsd:element name="Part" type="PartRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="PartSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Pack" type="PackRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="PackSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Module" type="ModuleRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="ModuleSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Cell" type="CellRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="CellSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="CellSandwich" type="CellSandwichRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="CellSandwichSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:choice minOccurs="0">
<xsd:element name="Model" type="ModelType" minOccurs="0"/>
<xsd:element name="ModelDefinition" type="DefinitionType" minOccurs="0"/>
</xsd:choice>
<xsd:element ref="Parameters" minOccurs="0"/>
<xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="name" type="ShortTokenType" use="optional"/>
<xsd:attribute name="id" type="ShortNameType" use="optional"/>
<xsd:attribute name="type" type="DeviceTypeType" use="optional"/>
<xsd:attribute name="idref" type="ShortNameType" use="optional"/>
</xsd:complexType>
top

Complex Type: DeviceDBEntryType

Super-types: DeviceAbstractType < DeviceDBEntryType (by restriction)
Sub-types: None
Name DeviceDBEntryType
Abstract no
Documentation Main instance of device type. Contains all the hierarchical devices of the device instance.
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [1]"
type="DeviceTypeType [0..1]">
<Part> PartRefType </Part> [0..*]
<PartSet> ... </PartSet> [0..*]
<Pack> PackRefType </Pack> [0..*]
<PackSet> ... </PackSet> [0..*]
<Module> ModuleRefType </Module> [0..*]
<ModuleSet> ... </ModuleSet> [0..*]
<Cell> CellRefType </Cell> [0..*]
<CellSet> ... </CellSet> [0..*]
<CellSandwich> CellSandwichRefType </CellSandwich> [0..*]
<CellSandwichSet> ... </CellSandwichSet> [0..*]
Start Choice [0..1]
<Model> ModelType </Model> [0..1]
<ModelDefinition> DefinitionType </ModelDefinition> [0..1]
End Choice
<Parameters> ... </Parameters> [0..1]
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
Model group reference (not shown): ElementInfoGroup [0..1]
</...>
Schema Component Representation
<xsd:complexType name="DeviceDBEntryType">
<xsd:complexContent>
<xsd:restriction base="DeviceAbstractType">
<xsd:sequence>
<xsd:element name="Part" type="PartRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="PartSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Pack" type="PackRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="PackSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Module" type="ModuleRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="ModuleSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Cell" type="CellRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="CellSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="CellSandwich" type="CellSandwichRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="CellSandwichSet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:choice minOccurs="0">
<xsd:element name="Model" type="ModelType" minOccurs="0"/>
<xsd:element name="ModelDefinition" type="DefinitionType" minOccurs="0"/>
</xsd:choice>
<xsd:element ref="Parameters" minOccurs="0"/>
<xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="name" type="ShortTokenType" use="optional"/>
<xsd:attribute name="id" type="ShortNameType" use="required"/>
<xsd:attribute name="type" type="DeviceTypeType" use="optional"/>
<xsd:attribute name="idref" type="ShortNameType" use="prohibited"/>
</xsd:restriction>
</xsd:complexContent>
</xsd:complexType>
top

Complex Type: DeviceRefType

Super-types: DeviceAbstractType < DeviceRefType (by restriction)
Sub-types: None
Name DeviceRefType
Abstract no
Documentation Main instance of battery device type referring to the entry in the device database.
XML Instance Representation
<...
idref="ShortNameType [1]">
Model group reference (not shown): ElementInfoGroup [0..1]
</...>
Schema Component Representation
<xsd:complexType name="DeviceRefType">
<xsd:complexContent>
<xsd:restriction base="DeviceAbstractType">
<xsd:sequence>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="name" type="ShortTokenType" use="prohibited"/>
<xsd:attribute name="id" type="ShortNameType" use="prohibited"/>
<xsd:attribute name="type" type="DeviceTypeType" use="prohibited"/>
<xsd:attribute name="idref" type="ShortNameType" use="required"/>
</xsd:restriction>
</xsd:complexContent>
</xsd:complexType>
top

Simple Type: DeviceTypeType

Super-types: ShortTokenType < DeviceTypeType (by restriction)
Sub-types: None
Name DeviceTypeType
Content
  • 'ShortTokenType' super type was not found in this schema. Its facets could not be printed out.
Documentation Device type model. Single choice.
Schema Component Representation
<xsd:simpleType name="DeviceTypeType">
<xsd:restriction base="ShortTokenType"/>
</xsd:simpleType>
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
<complexTypename="AusAddress">
<complexContent>
<extensionbase="Address">
<sequence>
<elementname="state" type="AusStates"/>
<elementname="postcode">
<simpleType>
<restrictionbase="string">
<patternvalue="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename="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

Generated by xs3p (old link) . Last modified: