XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://www.activecomponents.org/jadex-application
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
  • This schema includes components from the following schema document(s), where some of the components have been redefined:
    • http://www.activecomponents.org/jadex-component-base-${jadex_build_version}.xsd
    See Redefined Schema Components section.

Declared Namespaces

Prefix Namespace
Default namespace http://www.activecomponents.org/jadex-application
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema targetNamespace="http://www.activecomponents.org/jadex-application" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:redefine schemaLocation="http://www.activecomponents.org/jadex-component-base-${jadex_build_version}.xsd"/>
...
</xs:schema>
top

Redefined Schema Components

Global Declarations

Element: applicationtype

Name applicationtype
Type Locally-defined complex type
Nillable no
Abstract no
Documentation An application type specifies the structure and content of an active component application.
XML Instance Representation
<applicationtype
name=" xs:string [1]"
package=" xs:string [0..1]">
<!--
Key Constraint - app_argument_name
Selector - arguments/argument
Field(s) - @name
-->
<!--
Key Constraint - app_component_name
Selector - componenttypes/componenttype
Field(s) - @name
-->
<!--
Key Constraint - app_providedservice_key
Selector - services/providedservice
Field(s) - @name|@class
-->
<!--
Uniqueness Constraint - app_providedservice_name
Selector - services/providedservice
Field(s) - @name
-->
<!--
Key Constraint - app_requiredservice_name
Selector - services/requiredservice
Field(s) - @name
-->
<!--
Key Constraint - app_property_name
Selector - properties/property
Field(s) - @name
-->
<!--
Key Reference Constraint - app_argument_reference
Selector - configurations/configuration/arguments/argument
Field(s) - @name
Refers to - app_argument_name
-->
<!--
Key Reference Constraint - app_component_reference
Selector - configurations/configuration/components/component
Field(s) - @type
Refers to - app_component_name
-->
<!--
Key Reference Constraint - app_providedservice_reference
Selector - configurations/configuration/services/providedservice
Field(s) - @name|@class
Refers to - app_providedservice_key
-->
<!--
Key Reference Constraint - app_requiredservice_reference
Selector - configurations/configuration/services/requiredservice
Field(s) - @name
Refers to - app_requiredservice_name
-->

<!-- ' startabletype ' super type was not found in this schema. Some elements and attributes may be missing. -->
Start All [1]
<imports> imports </imports> [0..1]
<arguments> arguments </arguments> [0..1]
<componenttypes> componenttypes </componenttypes> [0..1]
<services> services </services> [0..1]
<properties> properties </properties> [0..1]
<nfproperties> nfproperties </nfproperties> [0..1]
<configurations> appconfigurations </configurations> [0..1]
<extensiontypes> extensiontypes </extensiontypes> [0..1]
End All
</applicationtype>
Schema Component Representation
<xs:element name="applicationtype">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" startabletype ">
<xs:all>
<xs:element name="imports" type=" imports " minOccurs="0"/>
<xs:element name="arguments" type=" arguments " minOccurs="0"/>
<xs:element name="componenttypes" type=" componenttypes " minOccurs="0"/>
<xs:element name="services" type=" services " minOccurs="0"/>
<xs:element name="properties" type=" properties " minOccurs="0"/>
<xs:element name="nfproperties" type=" nfproperties " minOccurs="0"/>
<xs:element name="configurations" type=" appconfigurations " minOccurs="0"/>
<xs:element name="extensiontypes" type=" extensiontypes " minOccurs="0"/>
</xs:all>
<xs:attribute name="name" type=" xs:string " use="required"/>
<xs:attribute name="package" type=" xs:string " use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<-- constraints copied from jadex-component.xsd, prefixed names with 'app_' as duplicates are not allowed. -->
<-- keys on type level -->
<xs:key name="app_argument_name">
<xs:selector xpath="arguments/argument"/>
<xs:field xpath="@name"/>
</xs:key>
<xs:key name="app_component_name">
<xs:selector xpath="componenttypes/componenttype"/>
<xs:field xpath="@name"/>
</xs:key>
<xs:key name="app_providedservice_key">
<xs:selector xpath="services/providedservice"/>
<xs:field xpath="@name|@class"/>
</xs:key>
<xs:unique name="app_providedservice_name">
<xs:selector xpath="services/providedservice"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:key name="app_requiredservice_name">
<xs:selector xpath="services/requiredservice"/>
<xs:field xpath="@name"/>
</xs:key>
<xs:key name="app_property_name">
<xs:selector xpath="properties/property"/>
<xs:field xpath="@name"/>
</xs:key>
<-- key references in configurations -->
<xs:keyref name="app_argument_reference" refer=" app_argument_name ">
<xs:selector xpath="configurations/configuration/arguments/argument"/>
<xs:field xpath="@name"/>
</xs:keyref>
<xs:keyref name="app_component_reference" refer=" app_component_name ">
<xs:selector xpath="configurations/configuration/components/component"/>
<xs:field xpath="@type"/>
</xs:keyref>
<xs:keyref name="app_providedservice_reference" refer=" app_providedservice_key ">
<xs:selector xpath="configurations/configuration/services/providedservice"/>
<xs:field xpath="@name|@class"/>
</xs:keyref>
<xs:keyref name="app_requiredservice_reference" refer=" app_requiredservice_name ">
<xs:selector xpath="configurations/configuration/services/requiredservice"/>
<xs:field xpath="@name"/>
</xs:keyref>
</xs:element>
top

Global Definitions

Complex Type: appconfiguration

Super-types: startabletype < appconfiguration (by extension)
Sub-types: None
Name appconfiguration
Abstract no
Documentation A predefined application configuration.
XML Instance Representation
<...
name=" xs:string [1]">
<!-- ' startabletype ' super type was not found in this schema. Some elements and attributes may be missing. -->
Start All [1]
<arguments> configarguments </arguments> [0..1]
<components> configcomponents </components> [0..1]
<services> configservices </services> [0..1]
<extensions> extensions </extensions> [0..1]
<steps> configsteps </steps> [0..1]
End All
</...>
Schema Component Representation
<xs:complexType name="appconfiguration">
<xs:complexContent>
<xs:extension base=" startabletype ">
<xs:all>
<xs:element name="arguments" type=" configarguments " minOccurs="0"/>
<xs:element name="components" type=" configcomponents " minOccurs="0"/>
<xs:element name="services" type=" configservices " minOccurs="0"/>
<xs:element name="extensions" type=" extensions " minOccurs="0"/>
<xs:element name="steps" type=" configsteps " minOccurs="0"/>
</xs:all>
<xs:attribute name="name" type=" xs:string " use="required"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: appconfigurations

Super-types: None
Sub-types: None
Name appconfigurations
Abstract no
Documentation In the configurations section, predefined component configurations (i.e. component instances) can be defined.
XML Instance Representation
<...>
<configuration> appconfiguration
<!--
Key Constraint - config_argument_name2
Selector - arguments/argument
Field(s) - @name
-->
<!--
Key Constraint - config_providedservice_key2
Selector - services/providedservice
Field(s) - @name|@class
-->
<!--
Uniqueness Constraint - config_providedservice_name2
Selector - services/providedservice
Field(s) - @name
-->
<!--
Key Constraint - config_requiredservice_name2
Selector - services/requiredservice
Field(s) - @name
-->
</configuration> [0..*] ?
</...>
Schema Component Representation
<xs:complexType name="appconfigurations">
<xs:sequence>
<xs:element name="configuration" type=" appconfiguration " minOccurs="0" maxOccurs="unbounded">
<xs:key name="config_argument_name2">
<xs:selector xpath="arguments/argument"/>
<xs:field xpath="@name"/>
</xs:key>
<xs:key name="config_providedservice_key2">
<xs:selector xpath="services/providedservice"/>
<xs:field xpath="@name|@class"/>
</xs:key>
<xs:unique name="config_providedservice_name2">
<xs:selector xpath="services/providedservice"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:key name="config_requiredservice_name2">
<xs:selector xpath="services/requiredservice"/>
<xs:field xpath="@name"/>
</xs:key>
<-- Configuration unique constraints defined here, because elements need only be unique inside one config. -->
</xs:element>
</xs:sequence>
</xs:complexType>
top

Complex Type: extensions

Super-types: None
Sub-types: None
Name extensions
Abstract no
Documentation In this section, specifications for extensions as required by some specific factory component extension service (e.g. EnvSupport) can be placed.
XML Instance Representation
<...>
Allow any elements from any namespace (strict validation). [0..*]
</...>
Schema Component Representation
<xs:complexType name="extensions">
<xs:sequence>
<xs:any minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: extensiontypes

Super-types: None
Sub-types: None
Name extensiontypes
Abstract no
Documentation In this section, specifications for extensions as required by some specific factory component extension service (e.g. EnvSupport) can be placed.
XML Instance Representation
<...>
Allow any elements from any namespace (strict validation). [0..*]
</...>
Schema Component Representation
<xs:complexType name="extensiontypes">
<xs:sequence>
<xs:any minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
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

Generated by xs3p (old link) . Last modified: