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: BuildingBlock

Name BuildingBlock
Type BuildingBlockDBEntryType
Nillable no
Abstract no
Documentation BuildingBlock element in BuildingBlockDB.
XML Instance Representation
<BuildingBlock
name="ShortTokenType [0..1]"
id="ShortNameType [1]"
type="BuildingBlockTypeType [1]">
<BuildingBlock> ... </BuildingBlock> [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]
</BuildingBlock>
Schema Component Representation
<xsd:element name="BuildingBlock" type="BuildingBlockDBEntryType"/>
top

Element: BuildingBlockDB

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

Start Choice [0..*]
<BuildingBlock> ... </BuildingBlock> [0..*]
<BuildingBlockSet> ... </BuildingBlockSet> [0..*]
End Choice
Model group reference (not shown): ElementInfoGroup [0..1]
</BuildingBlockDB>
Schema Component Representation
<xsd:element name="BuildingBlockDB">
<xsd:complexType>
<xsd:sequence>
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element ref="BuildingBlock" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="BuildingBlockSet" minOccurs="0" maxOccurs="unbounded"/>
</xsd:choice>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
</xsd:complexType>
<xsd:key name="BuildingBlockIdKey">
<xsd:selector xpath="./BuildingBlock | ./BuildingBlockSet"/>
<xsd:field xpath="@id"/>
</xsd:key>
</xsd:element>
top

Element: BuildingBlockDB_Test_Doc

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

Element: BuildingBlockSet

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

<BuildingBlock> BuildingBlockRefType </BuildingBlock> [0..*]
<BuildingBlockSet> BuildingBlockRefType </BuildingBlockSet> [0..*]
Start Choice [0..1]
<Model> ModelType </Model> [0..1]
<ModelDefinition> DefinitionType </ModelDefinition> [0..1]
End Choice
<Parameters> ... </Parameters> [0..1]
Model group reference (not shown): ElementInfoGroup [0..1]
</BuildingBlockSet>
Schema Component Representation
<xsd:element name="BuildingBlockSet">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="BuildingBlock" type="BuildingBlockRefType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="BuildingBlockSet" type="BuildingBlockRefType" 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:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="name" type="ShortTokenType" use="optional"/>
<xsd:attribute name="id" type="ShortNameType" use="required"/>
</xsd:complexType>
<xsd:key name="BuildingBlockSetIdKey">
<xsd:selector xpath="./BuildingBlock | ./BuildingBlockSet"/>
<xsd:field xpath="@idref"/>
</xsd:key>
</xsd:element>
top

Global Definitions

Complex Type: BuildingBlockAbstractType

Super-types: None
Sub-types:
Name BuildingBlockAbstractType
Abstract yes
Documentation Main instance of component type. Contains all the hierarchical components of the component instance.
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [0..1]"
type="BuildingBlockTypeType [0..1]"
idref="ShortNameType [0..1]">
<BuildingBlock> ... </BuildingBlock> [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="BuildingBlockAbstractType" abstract="true">
<xsd:sequence>
<xsd:element ref="BuildingBlock" minOccurs="0" maxOccurs="unbounded"/>
<xsd:choice minOccurs="0">
<-- <xsd:element name="Model" type="BuildingBlockModelType" 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="BuildingBlockTypeType" use="optional"/>
<xsd:attribute name="idref" type="ShortNameType" use="optional"/>
</xsd:complexType>
top

Complex Type: BuildingBlockDBEntryType

Super-types: BuildingBlockAbstractType < BuildingBlockDBEntryType (by restriction)
Sub-types: None
Name BuildingBlockDBEntryType
Abstract no
Documentation Main instance of component type. Contains all the hierarchical components of the component instance.
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [1]"
type="BuildingBlockTypeType [1]">
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="BuildingBlockDBEntryType">
<xsd:complexContent>
<xsd:restriction base="BuildingBlockAbstractType">
<xsd:sequence>
<xsd:element ref="BuildingBlock" 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="BuildingBlockTypeType" use="required"/>
<xsd:attribute name="idref" type="ShortNameType" use="prohibited"/>
</xsd:restriction>
</xsd:complexContent>
</xsd:complexType>
top

Complex Type: BuildingBlockModelType

Super-types: None
Sub-types: None
Name BuildingBlockModelType
Abstract no
Documentation Model reference to the model specification in the ModelDB.
XML Instance Representation
<...
idref="ShortNameType [1]"/>
Schema Component Representation
<xsd:complexType name="BuildingBlockModelType">
<xsd:attribute name="idref" type="ShortNameType" use="required"/>
</xsd:complexType>
top

Complex Type: BuildingBlockRefType

Super-types: BuildingBlockAbstractType < BuildingBlockRefType (by restriction)
Sub-types: None
Name BuildingBlockRefType
Abstract no
Documentation Main instance of battery component type referring to the entry in the component database.
XML Instance Representation
<...
idref="ShortNameType [1]">
Model group reference (not shown): ElementInfoGroup [0..1]
</...>
Schema Component Representation
<xsd:complexType name="BuildingBlockRefType">
<xsd:complexContent>
<xsd:restriction base="BuildingBlockAbstractType">
<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="BuildingBlockTypeType" use="prohibited"/>
<xsd:attribute name="idref" type="ShortNameType" use="required"/>
</xsd:restriction>
</xsd:complexContent>
</xsd:complexType>
top

Simple Type: BuildingBlockTypeType

Super-types: ShortTokenType < BuildingBlockTypeType (by restriction)
Sub-types: None
Name BuildingBlockTypeType
Content
  • 'ShortTokenType' super type was not found in this schema. Its facets could not be printed out.
  • value comes from list: {'Current Collector'|'Current Collector Positive'|'Current Collector Negative'|'Current Collector Cathode'|'Current Collector Anode'|'Anode'|'Cathode'|'Active Material'|'Active Material Anode'|'Active Material Cathode'|'Separator'|'Coating'|'Coating Anode'|'Coating Cathode'|'Electrolyte'|'Solvent'|'Salt'|'Additives'|'Binder'|'Binder Anode'|'Binder Cathode'|'Conductivity Aid'|'Conductivity Aid Anode'|'Conductivity Aid Cathode'|'Tape'|'Tab'|'Tab Anode'|'Tab Cathode'|'Insulation'|'Coolant'|'BuildingBlockAssembly'|'Cell'|'BuildingBlockOther'}
Documentation BuildingBlock type battery. Single choice.
Schema Component Representation
<xsd:simpleType name="BuildingBlockTypeType">
<xsd:restriction base="ShortTokenType">
<xsd:enumeration value="Current Collector"/>
<xsd:enumeration value="Current Collector Positive"/>
<xsd:enumeration value="Current Collector Negative"/>
<xsd:enumeration value="Current Collector Cathode"/>
<xsd:enumeration value="Current Collector Anode"/>
<xsd:enumeration value="Anode"/>
<xsd:enumeration value="Cathode"/>
<xsd:enumeration value="Active Material"/>
<xsd:enumeration value="Active Material Anode"/>
<xsd:enumeration value="Active Material Cathode"/>
<xsd:enumeration value="Separator"/>
<xsd:enumeration value="Coating"/>
<xsd:enumeration value="Coating Anode"/>
<xsd:enumeration value="Coating Cathode"/>
<xsd:enumeration value="Electrolyte"/>
<xsd:enumeration value="Solvent"/>
<xsd:enumeration value="Salt"/>
<xsd:enumeration value="Additives"/>
<xsd:enumeration value="Binder"/>
<xsd:enumeration value="Binder Anode"/>
<xsd:enumeration value="Binder Cathode"/>
<xsd:enumeration value="Conductivity Aid"/>
<xsd:enumeration value="Conductivity Aid Anode"/>
<xsd:enumeration value="Conductivity Aid Cathode"/>
<xsd:enumeration value="Tape"/>
<xsd:enumeration value="Tab"/>
<xsd:enumeration value="Tab Anode"/>
<xsd:enumeration value="Tab Cathode"/>
<xsd:enumeration value="Insulation"/>
<xsd:enumeration value="Coolant"/>
<xsd:enumeration value="BuildingBlockAssembly"/>
<xsd:enumeration value="Cell"/>
<xsd:enumeration value="BuildingBlockOther"/>
</xsd:restriction>
</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