XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace None
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
xml http://www.w3.org/XML/1998/namespace
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema elementFormDefault="qualified" attributeFormDefault="unqualified">
...
</xsd:schema>
top

Global Declarations

Element: assert

Name assert
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Definition of assert/exception element used for mapping to assert objects of test framework
XML Instance Representation
<assert
id=" xsd:string [1]"
type=" xsd:string [1]"
hint=" hintType [0..1]"
keytype=" xsd:string [0..1]"
valuetype=" xsd:string [0..1]"
method=" xsd:string [0..1]"
refid=" xsd:string [0..1]"
calltype=" xsd:string [0..1]"
dateformat=" xsd:string [0..1]"
locale=" xsd:string [0..1]"
action=" objectAssertType [1]">
<!-- Mixed content -->
Start Sequence [0..*]
Allow any elements from any namespace (skip validation). [1]
End Sequence
</assert>
Schema Component Representation
<xsd:element name="assert">
<xsd:complexType mixed="true">
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:any namespace="##any" processContents="skip"/>
</xsd:sequence>
<xsd:attributeGroup ref=" assertAttributes "/>
</xsd:complexType>
</xsd:element>
top

Element: cluster

Name cluster
Type Locally-defined complex type
Nillable no
Abstract no
XML Instance Representation
<cluster
id=" xsd:string [1]">
<description> ... </description> [0..1]
<objs> objSetType </objs> [0..1]
Start Sequence [0..*]
<group
id=" xsd:string [1]"> [1]
Start Sequence [0..*]
<test> ... </test> [1]
End Sequence
</group>
End Sequence
</cluster>
Schema Component Representation
<xsd:element name="cluster">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" description " minOccurs="0" maxOccurs="1"/>
<xsd:element name="objs" type=" objSetType " minOccurs="0" maxOccurs="1"/>
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:element name="group">
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base=" groupType ">
<xsd:attribute name="id" type=" xsd:string " use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:sequence>
<xsd:attribute name="id" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
top

Element: ddtunit

Name ddtunit
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Schema for DDTUnit test data
XML Instance Representation
<ddtunit>
<resources> objSetType </resources> [0..1]
Start Sequence [1..*]
<cluster> ... </cluster> [1]
End Sequence
</ddtunit>
Schema Component Representation
<xsd:element name="ddtunit">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="resources" type=" objSetType " minOccurs="0" maxOccurs="1"/>
<xsd:sequence minOccurs="1" maxOccurs="unbounded">
<xsd:element ref=" cluster "/>
</xsd:sequence>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: description

Name description
Type xsd:string
Nillable no
Abstract no
XML Instance Representation
<description> xsd:string </description>
Schema Component Representation
<xsd:element name="description" type=" xsd:string "/>
top

Element: exception

Name exception
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Definition of exception element used for mapping to assert objects on expected exceptions of test framework
XML Instance Representation
<exception
id=" xsd:string [1]"
type=" xsd:string [1]"
hint=" hintType [0..1]"
keytype=" xsd:string [0..1]"
valuetype=" xsd:string [0..1]"
method=" xsd:string [0..1]"
refid=" xsd:string [0..1]"
calltype=" xsd:string [0..1]"
dateformat=" xsd:string [0..1]"
locale=" xsd:string [0..1]"
action=" exceptionAssertType [1]">
<!-- Mixed content -->
Start Sequence [0..*]
Allow any elements from any namespace (skip validation). [1]
End Sequence
</exception>
Schema Component Representation
<xsd:element name="exception">
<xsd:complexType mixed="true">
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:any namespace="##any" processContents="skip"/>
</xsd:sequence>
<xsd:attributeGroup ref=" exceptionAttributes "/>
</xsd:complexType>
</xsd:element>
top

Element: obj

Name obj
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Definition of object element used for mapping to objects of test framework
XML Instance Representation
<obj
id=" xsd:string [1]"
type=" xsd:string [1]"
hint=" hintType [0..1]"
keytype=" xsd:string [0..1]"
valuetype=" xsd:string [0..1]"
method=" xsd:string [0..1]"
refid=" xsd:string [0..1]"
calltype=" xsd:string [0..1]"
dateformat=" xsd:string [0..1]"
locale=" xsd:string [0..1]">
<!-- Mixed content -->
Start Sequence [0..*]
Allow any elements from any namespace (skip validation). [1]
End Sequence
</obj>
Schema Component Representation
<xsd:element name="obj">
<xsd:complexType mixed="true">
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:any namespace="##any" processContents="skip"/>
</xsd:sequence>
<xsd:attributeGroup ref=" objAttributes "/>
</xsd:complexType>
</xsd:element>
top

Element: test

Name test
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Definition of object element used for mapping to objects of test framework
XML Instance Representation
<test
id=" xsd:string [1]">
<objs> objSetType </objs> [0..1]
<asserts> assertSetType </asserts> [0..1]
</test>
Schema Component Representation
<xsd:element name="test">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="objs" type=" objSetType " minOccurs="0"/>
<xsd:element name="asserts" type=" assertSetType " minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="id" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
top

Global Definitions

Attribute Group: assertAttributes

Name assertAttributes
XML Instance Representation

id=" xsd:string [1]"
type=" xsd:string [1]"
hint=" hintType [0..1]"
keytype=" xsd:string [0..1]"
valuetype=" xsd:string [0..1]"
method=" xsd:string [0..1]"
refid=" xsd:string [0..1]"
calltype=" xsd:string [0..1]"
dateformat=" xsd:string [0..1]"
locale=" xsd:string [0..1]"
action=" objectAssertType [1]"
Schema Component Representation
<xsd:attributeGroup name="assertAttributes">
<xsd:attributeGroup ref=" objAttributes "/>
<xsd:attribute name="action" type=" objectAssertType " use="required"/>
</xsd:attributeGroup>
top

Attribute Group: exceptionAttributes

Name exceptionAttributes
XML Instance Representation

id=" xsd:string [1]"
type=" xsd:string [1]"
hint=" hintType [0..1]"
keytype=" xsd:string [0..1]"
valuetype=" xsd:string [0..1]"
method=" xsd:string [0..1]"
refid=" xsd:string [0..1]"
calltype=" xsd:string [0..1]"
dateformat=" xsd:string [0..1]"
locale=" xsd:string [0..1]"
action=" exceptionAssertType [1]"
Schema Component Representation
<xsd:attributeGroup name="exceptionAttributes">
<xsd:attributeGroup ref=" objAttributes "/>
<xsd:attribute name="action" type=" exceptionAssertType " use="required"/>
</xsd:attributeGroup>
top

Attribute Group: objAttributes

Name objAttributes
XML Instance Representation
id=" xsd:string [1]"
type=" xsd:string [1]"
hint=" hintType [0..1]"
keytype=" xsd:string [0..1]"
valuetype=" xsd:string [0..1]"
method=" xsd:string [0..1]"
refid=" xsd:string [0..1]"
calltype=" xsd:string [0..1]"
dateformat=" xsd:string [0..1]"
locale=" xsd:string [0..1]"
Schema Component Representation
<xsd:attributeGroup name="objAttributes">
<xsd:attribute name="id" type=" xsd:string " use="required"/>
<xsd:attribute name="type" type=" xsd:string " use="required"/>
<xsd:attribute name="hint" type=" hintType " use="optional" default="fields"/>
<xsd:attribute name="keytype" type=" xsd:string " use="optional" default="string"/>
<xsd:attribute name="valuetype" type=" xsd:string " use="optional" default="string"/>
<xsd:attribute name="method" type=" xsd:string " use="optional" default="constructor"/>
<xsd:attribute name="refid" type=" xsd:string " use="optional"/>
<xsd:attribute name="calltype" type=" xsd:string " use="optional"/>
<xsd:attribute name="dateformat" type=" xsd:string "/>
<xsd:attribute name="locale" type=" xsd:string "/>
</xsd:attributeGroup>
top

Complex Type: anyType

Super-types: None
Sub-types: None
Name anyType
Abstract no
XML Instance Representation
<...>
Start Sequence [0..*]
Allow any elements from any namespace (skip validation). [1]
End Sequence
</...>
Schema Component Representation
<xsd:complexType name="anyType">
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:any namespace="##any" processContents="skip"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: assertSetType

Super-types: None
Sub-types: None
Name assertSetType
Abstract no
Documentation Definition of assert element used for Java objects containing all information about asserts to process
XML Instance Representation
<...>
Start Sequence [0..*]
<assert> ... </assert> [0..1]
<exception> ... </exception> [0..1]
End Sequence
</...>
Schema Component Representation
<xsd:complexType name="assertSetType">
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:sequence>
<xsd:element ref=" assert " minOccurs="0"/>
<xsd:element ref=" exception " minOccurs="0"/>
</xsd:sequence>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: groupType

Super-types: None
Sub-types: None
Name groupType
Abstract no
Documentation group containing multiple test definitions
XML Instance Representation
<...>
Start Sequence [0..*]
<test> ... </test> [1]
End Sequence
</...>
Schema Component Representation
<xsd:complexType name="groupType">
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:element ref=" test "/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: objSetType

Super-types: None
Sub-types: None
Name objSetType
Abstract no
Documentation Definition of set of object elements used for mapping to Java Object instance
XML Instance Representation
<...>
Start Sequence [0..*]
<obj> ... </obj> [1]
End Sequence
</...>
Schema Component Representation
<xsd:complexType name="objSetType">
<xsd:sequence minOccurs="0" maxOccurs="unbounded">
<xsd:element ref=" obj "/>
</xsd:sequence>
</xsd:complexType>
top

Simple Type: exceptionAssertType

Super-types: xsd:string < exceptionAssertType (by restriction)
Sub-types: None
Name exceptionAssertType
Content
  • Base XSD Type: string
  • value comes from list: {'isEqual'|'isSimilar'|'isInstanceOf'}
Schema Component Representation
<xsd:simpleType name="exceptionAssertType">
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="isEqual"/>
<xsd:enumeration value="isSimilar"/>
<xsd:enumeration value="isInstanceOf"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: hintType

Super-types: xsd:string < hintType (by restriction)
Sub-types: None
Name hintType
Content
  • Base XSD Type: string
  • value comes from list: {'fields'|'collection'|'map'|'constant'|'constructor'|'call'|'date'|'bean'|'array'}
Schema Component Representation
<xsd:simpleType name="hintType">
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="fields"/>
<xsd:enumeration value="collection"/>
<xsd:enumeration value="map"/>
<xsd:enumeration value="constant"/>
<xsd:enumeration value="constructor"/>
<xsd:enumeration value="call"/>
<xsd:enumeration value="date"/>
<xsd:enumeration value="bean"/>
<xsd:enumeration value="array"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: objectAssertType

Super-types: xsd:string < objectAssertType (by restriction)
Sub-types: None
Name objectAssertType
Content
  • Base XSD Type: string
  • value comes from list: {'isTrue'|'isFalse'|'isEqual'|'isNotEqual'|'isSame'|'isNotSame'|'isNull'|'isNotNull'|'isGT'|'isNotGT'|'isLT'|'isNotLT'|'isInRange'|'isNotInRange'|'isContainedIn'|'isNotContainedIn'}
Schema Component Representation
<xsd:simpleType name="objectAssertType">
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="isTrue"/>
<xsd:enumeration value="isFalse"/>
<xsd:enumeration value="isEqual"/>
<xsd:enumeration value="isNotEqual"/>
<xsd:enumeration value="isSame"/>
<xsd:enumeration value="isNotSame"/>
<xsd:enumeration value="isNull"/>
<xsd:enumeration value="isNotNull"/>
<xsd:enumeration value="isGT"/>
<xsd:enumeration value="isNotGT"/>
<xsd:enumeration value="isLT"/>
<xsd:enumeration value="isNotLT"/>
<xsd:enumeration value="isInRange"/>
<xsd:enumeration value="isNotInRange"/>
<xsd:enumeration value="isContainedIn"/>
<xsd:enumeration value="isNotContainedIn"/>
</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
<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