XSD 例
このセクションでは、XML Schema の作成方法を説明します。また、スキーマを作成するさまざまな方法についても学習します。
XML ドキュメント
「shiporder.xml」という名前の XML ドキュメントを見てみましょう:
<shiporder orderid="889923"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="shiporder.xsd">
<orderperson>John Smith</orderperson>
<shipto>
<name>Ola Nordmann</name>
<address>Langgt 23</address>
<city>4000 Stavanger</city>
<country>Norway</country>
</shipto>
<item>
<title>Empire Burlesque</title>
<note>Special Edition</note>
<quantity>1</quantity>
<price>10.90</price>
</item>
<item>
<title>Hide your heart</title>
<quantity>1</quantity>
<price>9.90</price>
</item>
</shiporder>
上記の XML ドキュメントには、ルート要素「shiporder」が含まれており、必須の属性「orderid」があります。「shiporder」要素には、「orderperson」、「shipto」、「item」という 3 つの異なる子要素が含まれています。「item」要素は 2 回出現し、1 つの「title」、1 つのオプションの「note」要素、1 つの「quantity」、および 1 つの「price」要素を含みます。
上記の行 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" は、XML パーサーに、このドキュメントを何らかのスキーマに基づいて検証するように指示します。この行 xsi:noNamespaceSchemaLocation="shiporder.xsd" は、スキーマの場所を指定します(ここでは、「shiporder.xml」と同じフォルダーにあります)。
XML Schema を作成する
次に、上記の XML ドキュメント用のスキーマを作成する必要があります。
まず、新しいファイルを開いて、「shiporder.xsd」という名前を付けます。スキーマを作成するには、XML ドキュメント内の構造に従って、見つかった各要素を定義するだけです。最初に、標準の XML 宣言を定義します:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
...
</xs:schema>
上記のスキーマでは、標準の名前空間 (xs) を使用しています。この名前空間に関連付けられた URI は、スキーマ言語定義(Schema language definition)であり、その標準値は http://www.w3.org/2001/XMLSchema です。
次に、「shiporder」要素を定義する必要があります。この要素には属性があり、他の要素も含まれているため、複合型として扱います。「shiporder」要素の子要素は xs:sequence 要素で囲まれており、子要素の順序を定義しています:
<xs:complexType>
<xs:sequence>
...
</xs:sequence>
</xs:complexType>
</xs:element>
次に、「orderperson」要素を単純型として定義する必要があります(これは、属性や他の要素を含まないためです)。型 (xs:string) のプレフィックスは名前空間のプレフィックスによって指定されます。この名前空間は、定義済みのスキーマデータ型を示す XML スキーマに関連付けられています:
次に、2 つの要素「shipto」と「item」を複合型として定義する必要があります。「shipto」要素の定義から始めましょう:
<xs:complexType>
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="address" type="xs:string"/>
<xs:element name="city" type="xs:string"/>
<xs:element name="country" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
スキーマでは、maxOccurs 属性と minOccurs 属性を使用して、要素が出現できる回数を定義できます。maxOccurs は要素の出現回数の最大値を定義し、minOccurs は要素の出現回数の最小値を定義します。maxOccurs と minOccurs のデフォルト値はどちらも 1 です!
次に、「item」要素を定義できます。この要素は「shiporder」要素内で複数回出現できます。これは、「item」要素の maxOccurs 属性の値を「unbounded」に設定することで実現され、「item」要素を創作した人の望む回数だけ出現させることができます。「note」要素はオプションの要素であることに注意してください。この要素の minOccurs 属性は 0 に設定してあります:
<xs:complexType>
<xs:sequence>
<xs:element name="title" type="xs:string"/>
<xs:element name="note" type="xs:string" minOccurs="0"/>
<xs:element name="quantity" type="xs:positiveInteger"/>
<xs:element name="price" type="xs:decimal"/>
</xs:sequence>
</xs:complexType>
</xs:element>
次に、「shiporder」要素の属性を宣言できます。これは必須属性であるため、use="required" と指定します。
注意:この属性の宣言は最後に置かなければなりません:
これは、「shiporder.xsd」という名前のスキーマファイルのドキュメント一覧です:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="shiporder">
<xs:complexType>
<xs:sequence>
<xs:element name="orderperson" type="xs:string"/>
<xs:element name="shipto">
<xs:complexType>
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element name="address" type="xs:string"/>
<xs:element name="city" type="xs:string"/>
<xs:element name="country" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="item" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="title" type="xs:string"/>
<xs:element name="note" type="xs:string" minOccurs="0"/>
<xs:element name="quantity" type="xs:positiveInteger"/>
<xs:element name="price" type="xs:decimal"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="orderid" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
</xs:schema>
Schema の分割
前述の設計方法は非常に簡単ですが、ドキュメントが複雑な場合には読み取りや保守が困難になります。
次に紹介する設計方法は、最初にすべての要素と属性を定義し、その後 ref 属性を使用してそれらを参照するというものです。
これは、新しい方法で設計されたスキーマファイル("shiporder.xsd")です:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- definition of simple elements -->
<xs:element name="orderperson" type="xs:string"/>
<xs:element name="name" type="xs:string"/>
<xs:element name="address" type="xs:string"/>
<xs:element name="city" type="xs:string"/>
<xs:element name="country" type="xs:string"/>
<xs:element name="title" type="xs:string"/>
<xs:element name="note" type="xs:string"/>
<xs:element name="quantity" type="xs:positiveInteger"/>
<xs:element name="price" type="xs:decimal"/>
<!-- definition of attributes -->
<xs:attribute name="orderid" type="xs:string"/>
<!-- definition of complex elements -->
<xs:element name="shipto">
<xs:complexType>
<xs:sequence>
<xs:element ref="name"/>
<xs:element ref="address"/>
<xs:element ref="city"/>
<xs:element ref="country"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="item">
<xs:complexType>
<xs:sequence>
<xs:element ref="title"/>
<xs:element ref="note" minOccurs="0"/>
<xs:element ref="quantity"/>
<xs:element ref="price"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="shiporder">
<xs:complexType>
<xs:sequence>
<xs:element ref="orderperson"/>
<xs:element ref="shipto"/>
<xs:element ref="item" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute ref="orderid" use="required"/>
</xs:complexType>
</xs:element>
</xs:schema>
指定された型(Named Types)の使用
3 番目の設計方法では、クラスまたは型を定義することで、要素の定義を再利用できます。具体的には、最初に単純要素と複合要素に名前を付け、要素の type 属性でそれらを参照します。
これは、3 番目の方法を使用して設計されたスキーマファイル("shiporder.xsd")です:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="stringtype">
<xs:restriction base="xs:string"/>
</xs:simpleType>
<xs:simpleType name="inttype">
<xs:restriction base="xs:positiveInteger"/>
</xs:simpleType>
<xs:simpleType name="dectype">
<xs:restriction base="xs:decimal"/>
</xs:simpleType>
<xs:simpleType name="orderidtype">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{6}"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="shiptotype">
<xs:sequence>
<xs:element name="name" type="stringtype"/>
<xs:element name="address" type="stringtype"/>
<xs:element name="city" type="stringtype"/>
<xs:element name="country" type="stringtype"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="itemtype">
<xs:sequence>
<xs:element name="title" type="stringtype"/>
<xs:element name="note" type="stringtype" minOccurs="0"/>
<xs:element name="quantity" type="inttype"/>
<xs:element name="price" type="dectype"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="shipordertype">
<xs:sequence>
<xs:element name="orderperson" type="stringtype"/>
<xs:element name="shipto" type="shiptotype"/>
<xs:element name="item" maxOccurs="unbounded" type="itemtype"/>
</xs:sequence>
<xs:attribute name="orderid" type="orderidtype" use="required"/>
</xs:complexType>
<xs:element name="shiporder" type="shipordertype"/>
</xs:schema>
restriction 要素は、データ型が W3C XML Schema 名前空間のデータ型に由来することを示しています。したがって、以下のフラグメントは、要素または属性の値が文字列型の値でなければならないことを意味します:
restriction 要素は、要素に制限を課すためによく使用されます。上記のスキーマからの以下のフラグメントを見てください:
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{6}"/>
</xs:restriction>
</xs:simpleType>
このコードは、要素または属性の値が文字列であり、連続する 6 文字でなければならず、かつこれらの文字が 0 から 9 の数字でなければならないことを示しています。
その他の拡張