This text file contains sample code fragments from:
Section 13.1 - Reusable Schema Design
Chapter 13 - Advanced XML Schema Part II: Reusability, Relational Design, and Industry Schemas
Book - Web Service Contract Design & Versioning for SOA
Series - The Prentice Hall Service Technology Series from Thomas Erl
Site - www.servicetechbooks.com


<xsd:include schemaLocation=
  "http://actioncon.com/schema/purchasingCommon.xsd"/>

Example 13.1 - The xsd:include statement with a schemaLocation attribute pointing to the schema document to be included.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://actioncon.com/schema/purchasing"
  xmlns="http://actioncon.com/schema/purchasing"
  elementFormDefault="qualified">
  <xsd:include schemaLocation=
    "http://actioncon.com/schema/purchasingCommon.xsd"/>
  ...
</xsd:schema>

Example 13.2 - The xsd:include element positioned as the child element of the xsd:schema element.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://actioncon.com/schema/purchasing"
  xmlns="http://actioncon.com/schema/purchasing"
  elementFormDefault="qualified">
  <xsd:complexType name="PartyType">
    <xsd:sequence>
      <xsd:element name="id" type="xsd:int"/>
      <xsd:element name="partyName" type="xsd:string"
        minOccurs="0"/>
      <xsd:element name="contactName" type="xsd:string"
        minOccurs="0"/>
      <xsd:element name="phone" type="xsd:string"
        minOccurs="0"/>
      <xsd:element name="address" type="AddressType"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="AddressType">
    <xsd:sequence>
      <xsd:element name="line1" type="xsd:string"/>
      <xsd:element name="line2" type="xsd:string"
        minOccurs="0"/>
      <xsd:element name="city" type="xsd:string"/>
      <xsd:element name="state" type="xsd:string"/>
      <xsd:element name="postalCode" type="xsd:string"/>
      <xsd:element name="country" type="xsd:string"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="LineItemsType">
    <xsd:sequence>
      <xsd:element name="lineItem" type="LineItemType"
        maxOccurs="unbounded"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:complexType name="LineItemType">
    <xsd:sequence>
      <xsd:element name="productID" type="ProductIDType"/>
      <xsd:element name="productName" type="xsd:string"/>
      <xsd:element name="quantity" type="xsd:int"/>
      <xsd:element name="price" type="PriceType"/>
    </xsd:sequence>
  </xsd:complexType>
  <xsd:simpleType name="ProductIDType">
    <xsd:restriction base="xsd:string">
      <xsd:pattern value="[A-Z]{2}[0-9]{4}"/>
    </xsd:restriction>
  </xsd:simpleType>
  <xsd:simpleType name="PriceType">
    <xsd:restriction base="xsd:decimal">
      <xsd:totalDigits value="8"/>
      <xsd:fractionDigits value="2"/>
    </xsd:restriction>
  </xsd:simpleType>
</xsd:schema>

Example 13.3 - The new Purchasing Common schema with several common types that can be reused by other schemas.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://actioncon.com/schema/purchasing"
  xmlns="http://actioncon.com/schema/purchasing"
  elementFormDefault="qualified">
  <xsd:include schemaLocation=
    "http://actioncon.com/schema/purchasingCommon.xsd"/>
  <xsd:element name="purchaseOrder" type="PurchaseOrderType"/>
  <xsd:complexType name="PurchaseOrderType">
    <xsd:sequence>
      <xsd:element name="poNumber" type="xsd:int"/>
      <xsd:element name="poDate" type="xsd:date"/>
      <xsd:element name="billToParty" type="PartyType"/>
      <xsd:element name="shipToParty" type="PartyType"/>
      <xsd:element name="lineItems" type="LineItemsType"/>
    </xsd:sequence>
    <xsd:attribute name="version" type="xsd:decimal"/>
  </xsd:complexType>
</xsd:schema>

Example 13.4 - The Purchase Order schema with an xsd:include statement that points to the Purchasing schema.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://actioncon.com/schema/common"
  xmlns="http://actioncon.com/schema/common"
  elementFormDefault="qualified">
  <xsd:simpleType name="ProductIDType">
    <xsd:restriction base="xsd:string">
      <xsd:pattern value="[A-Z]{2}[0-9]{4}"/>
    </xsd:restriction>
  </xsd:simpleType>
  <xsd:simpleType name="PriceType">
    <xsd:restriction base="xsd:decimal">
      <xsd:totalDigits value="8"/>
      <xsd:fractionDigits value="2"/>
    </xsd:restriction>
  </xsd:simpleType>
  <xsd:complexType name="AddressType">
    <xsd:sequence>
      <xsd:element name="line1" type="xsd:string"/>
      <xsd:element name="line2" type="xsd:string"
        minOccurs="0"/>
      <xsd:element name="city" type="xsd:string"/>
      <xsd:element name="state" type="xsd:string"/>
      <xsd:element name="postalCode" type="xsd:string"/>
      <xsd:element name="country" type="xsd:string"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:schema>

Example 13.5 - A common schema comprised of a library of common, reusable types.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns="http://actioncon.com/schema/purchasing"

targetNamespace="http://actioncon.com/schema/purchasing"
  elementFormDefault="qualified">
  <xsd:include schemaLocation=
    "http://actioncon.com/schema/purchasingCommon.xsd"/>
    <xsd:element name="purchaseOrder" type="PurchaseOrderType"/>
    <xsd:complexType name="PurchaseOrderType">
    <xsd:sequence>
      <xsd:element name="poNumber" type="xsd:int"/>
      <xsd:element name="poDate" type="xsd:date"/>
      <xsd:element name="billToParty" type="PartyType"/>
      <xsd:element name="shipToParty" type="PartyType"/>
      <xsd:element name="lineItems" type="LineItemsType"/>
    </xsd:sequence>
    <xsd:attribute name="version" type="xsd:decimal"/>
  </xsd:complexType>
</xsd:schema>

Example 13.6 - The Purchase Order schema reusing three types from the Purchasing Common schema.


<purchaseOrder version="1.0"
  xmlns="http://actioncon.com/schema/purchasing"
  xmlns:common="http://actioncon.com/schema/common">
  <poNumber>12345</poNumber>
  <poDate>2006-10-15</poDate>
  <billToParty>
    <id>444403</id>
    <partyName>Neighborhood Game Stores, Inc.</partyName>
    <contactName>Steve Smith</contactName>
    <phone>231-555-1122</phone>
    <address>
      <common:line1>123 Main St.</common:line1>
      <common:line2>Suite 300</common:line2>
      <common:city>Cleveland</common:city>
      <common:state>OH</common:state>
      <common:postalCode>37311</common:postalCode>
      <common:country>USA</common:country>
    </address>
  </billToParty>
  ...
</purchaseOrder>

Example 13.7 - A message instance containing elements from the common schema. Because these elements originated from a different namespace, they need to be prefixed with common.


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  targetNamespace="http://actioncon.com/schema/purchasing"
  xmlns="http://actioncon.com/schema/purchasing"
  xmlns:common="http://actioncon.com/schema/common"
  elementFormDefault="qualified">
  <xsd:include schemaLocation="
    http://actioncon.com/schema/purchasingCommon.xsd"/>
  <xsd:import
    namespace="http://actioncon.com/schema/common"
    schemaLocation="http://actioncon.com/schema/common.xsd"/>
  <xsd:element name="invoice" type="InvoiceType"/>
  <xsd:complexType name="InvoiceType">
    <xsd:sequence>
      <xsd:element name="invoiceNumber" type="xsd:int"/>
      <xsd:element name="invoiceDate" type="xsd:date"/>
      <xsd:element name="totalAmount"
        type="common:PriceType"/>
      <xsd:element name="poNumber" type="xsd:int"/>
      <xsd:element name="poDate" type="xsd:date"/>
      <xsd:element name="billToParty" type="PartyType"/>
      <xsd:element name="lineItems" type="LineItemsType"/>
    </xsd:sequence>
    <xsd:attribute name="version" type="xsd:decimal"/>
  </xsd:complexType>
</xsd:schema>

Example 13.8 - The Invoice schema including and then reusing the types from the Purchasing schema.