XML Schema
Exercise 0: Install SOA plug-in's to
NetBeans IDE 6.7 or 6.7.1 (Skip if you installed GlassFish ESB)
If you are using NetBeans 6.7 or 6.7.1,
you will have to install SOA and XML and WSDL plug-in's yourself as
shown below. If you have installed GlassFish ESB 2.2, skip this
step.
Exercise 1: Create a very simple XML Schema
(1.1)
Create a "BPEL Module" NetBeans
project
0. Start NetBeans IDE.
1. Create SynchronousSample
SOA project.
- Select File->New Project.
- Observe that the New Project
dialog box appears.
- Select SOA under Categories and select BPEL Module under Projects.
- Click Next. (Figure-1.11
below)
Figure-1.11: Create BPEL Module
- Observer that the New BPEL
Module dialog box appears.
- For the Project Name
field, enter SynchronousSample.
- Click Finish.
(Figure-1.12 below)
Figure-1.12: Name and Location
(1.2)
Create XML Schema
1. Create
SynchronousSample.xsd.
- Right click Process Files
and select New->Other.
(Figure-1.21 below) (Or you can
select New->XML Schema if
XML Schema is already in the pop-up menu.)
Figure-1.21: Select Other
- Observe that the Choose File
Type pane appears.
- Select XML
under Categories and XML Schema
under File Types.
- Click Next. (Figure-1.22
below)
Figure-1.22: Create XML Schema
- Observe that the New XML Schema
pane appears.
- For the File Name field,
enter SynchronousSample.
- Click Finish.
(Figure-1.23 below)
Figure-1.23: Name and Location
2. Add a
Complex Type to the
XML schema.
- Select Window->Palette
(if Palette window is not displayed already). (Figure-1.24 below)
If you already have a Palette, you can skip this action.
Figure-1.24: Display Palette (if it has not been displayed)
- Select Design tab
window.
- Drag the Complext Type
from the Palette and drop it
under the Complex Types in the
design
window.
- Set the name of the newly added Complex Type to simpleProcess.
(Figure-1.25 below)
(You can always
change the name of it to something else later on through Name property
under Properties window.)
Figure-1.25: Add a Complex Type to the schema
3. Add a local element to
simpleProcess
complex type
- Drag the Element under XML Component section and drop it
under the simpleProcess complex
type.
- Change the name of the newly added Element to paramA.
(Figure-1.26 below)
Figure-1.26: Add a local element to the complex type
- Select Window->Properties
to display Properties window.
(Needed only when the Properties window is not already displayed.)
Figure-1.27: Display Properties window
- Observe that the Properties dialog box of the paramA is displayed.
- Click ... of the Definition property of the paramA. (Figure-1.28 below)
This is to set
the value of the type attribute
of the paramA element.
Figure-1.28: Select a definition of the element
- Observe that the Element's
definition dialog box appears.
- Expand the Built-in Types.
(Figure-1.29 below)
Figure-1.29: Expand Built-in Types
- Select string.
- Click OK.
(Figure-1.30 below)
Figure-1.30: Select string
- Observe that the paramA element
has string type notation in
the design window. (Figure-1.31 below)
Figure-1.31: paramA has string as a definition
- Click Source tab window
to display the SynchronousSample.xsd
in the source format.
- Study the XML schema. Note the ComplexType whose name is simpleProcess is defined.
(Figure-1.32 below)
Figure-1.32:Display XML schema
4. Add a global element to the schema.
- Drag the Element from
the Palette and drop it to the design area, immediately below the Elements node. (Figure-1.33
below)
Figure-1.33: Add a global element
- Change the name to typeA.
(Figure-1.34
below)
Figure-1.34: typeA global element
- Right click typeA figure
and select Properties.
- click ,,, box the Definition property.
- Observe that the Element's
definition dialog box appears.
- Select simpleProcess under
Complex Types. This
will set the value of the type attribute
of the typeA global element
to simpleProcess.
- Click OK. (Figure-1.35
below)
Figure-1.35: Select simpleProcess as a definition
- Click Close button of the Properties dialog box to close it.
- Observe that the typeA global
element has simpleProcess type
in
the design window. (Figure-1.36 below)
Figure-1.36: typeA global element is type of simpleProcess
complex type
5. Save all the changes.
- Click Save All icon.
(Figure-1.37 below)
Figure-1.37: Save all the changes
6. Display and study the XML schema file.
- Click Source tab
window.
- Make sure the source code looks as in Code-1.38 below.
<?xml version="1.0"
encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://xml.netbeans.org/schema/SynchronousSample"
xmlns:tns="http://xml.netbeans.org/schema/SynchronousSample"
elementFormDefault="qualified">
<xsd:complexType name="simpleProcess">
<xsd:sequence>
<xsd:element name="paramA" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:element
name="typeA" type="tns:simpleProcess"/>
</xsd:schema>
|
Code-1.38: XML schema file
return
to top of the exercise
Exercise 2: Study sample XML
Schema's
(2.1)
Study sample XML schema - PurchaseOrder.xsd
1. Open DummyJavaApp
NetBeans project.
- Select File->Open Project (Ctrl+Shift+O). The Open Project dialog box appears.
- Browse down to <LAB_UNZIPPED_DIRECTORY>/wsschema/samples
directory.
- Windows: If you unzipped the 4342_wsschema.zip
file under
C:\handsonlabs
directory, the directory to which you want
to browse down should be C:\handsonlabs\wsschema\samples
- Solaris/Linux: If you unzipped the 4342_wsschema.zip
file under $HOME/handsonlabs
directory, the directory to which you want
to browse down should be $HOME/handsonlabs/wsschema/samples
- Select DummyJavaApp.
- Click Open Project.
The DummyJavaApp
project node appears under Projects tab
window.
2. Display and study PurchaseOrder.xsd schema in Source mode.
<?xml version="1.0"
encoding="UTF-8"?>
<xsd:schema
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://xml.netbeans.org/examples/PurchaseOrder"
xmlns:tns="http://xml.netbeans.org/examples/PurchaseOrder"
elementFormDefault="qualified">
<xsd:annotation>
<xsd:documentation
xml:lang="en">
Purchase order schema for Example.com.
Copyright 2000 Example.com. All rights reserved.
</xsd:documentation>
</xsd:annotation>
<xsd:element name="purchaseOrder"
type="tns:PurchaseOrderType"/>
<xsd:element name="comment" type="xsd:string"/>
<xsd:complexType name="PurchaseOrderType">
<xsd:sequence>
<xsd:element name="shipTo" type="tns:USAddress"/>
<xsd:element name="billTo" type="tns:USAddress"/>
<xsd:element ref="tns:comment" minOccurs="0"/>
<xsd:element name="items" type="tns:Items"/>
</xsd:sequence>
<xsd:attribute
name="orderDate" type="xsd:date"/>
</xsd:complexType>
<xsd:complexType name="USAddress">
<xsd:sequence>
<xsd:element name="name" type="xsd:string"/>
<xsd:element name="street" type="xsd:string"/>
<xsd:element name="city" type="xsd:string"/>
<xsd:element name="state" type="xsd:string"/>
<xsd:element name="zip" type="xsd:decimal"/>
</xsd:sequence>
<xsd:attribute
name="country" type="xsd:NMTOKEN"
fixed="US"/>
</xsd:complexType>
<xsd:complexType name="Items">
<xsd:sequence>
<xsd:element name="item" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="productName" type="xsd:string"/>
<xsd:element name="quantity">
<xsd:simpleType>
<xsd:restriction base="xsd:positiveInteger">
<xsd:maxExclusive value="100"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="USPrice" type="xsd:decimal"/>
<xsd:element ref="tns:comment" minOccurs="0"/>
<xsd:element name="shipDate" type="xsd:date" minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="partNum" type="tns:SKU" use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- Stock Keeping Unit, a code for identifying
products -->
<xsd:simpleType name="SKU">
<xsd:restriction
base="xsd:string">
<xsd:pattern value="\d{3}-[A-Z]{2}"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:schema>
|
3. Display it in Design mode.
(2.2)
Study another sample XML schema
1. Display and study LoanApplication.xsd schema.
<?xml version="1.0"
encoding="UTF-8"?>
<xs:schema
targetNamespace="http://xml.netbeans.org/examples/LoanApplication"
xmlns="http://xml.netbeans.org/examples/LoanApplication"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xs:element name="autoLoanApplication">
<xs:annotation>
<xs:documentation>A loan application xml
schema</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="loan"
type="LoanType"/>
<xs:element name="term"
type="xs:integer"/>
<xs:element name="amount">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:minInclusive value="5000.00"/>
<xs:maxInclusive value="10000.00"/>
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="application">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="individual"/>
<xs:enumeration value="joint"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="state"
type="StateType"/>
<xs:element name="applicant" type="ApplicantType"
maxOccurs="2"/>
<xs:element name="tradeIn" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="vehicle"
type="CarType"/>
<xs:element name="monthlyPayment">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2"/>
<xs:minInclusive value="0.00"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:simpleType name="LoanType">
<xs:restriction
base="xs:string">
<xs:enumeration value="new"/>
<xs:enumeration value="used dealer"/>
<xs:enumeration value="used private"/>
<xs:enumeration value="refinance"/>
<xs:enumeration value="lease buyout"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="StateType">
<xs:restriction
base="xs:string">
<xs:enumeration value="AZ"/>
<xs:enumeration value="CA"/>
<xs:enumeration value="NY"/>
<xs:enumeration value="TX"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="ApplicantType">
<xs:sequence>
<xs:element name="name">
<xs:complexType>
<xs:sequence>
<xs:element name="first" type="xs:string"/>
<xs:element name="middle" type="xs:string"/>
<xs:element name="last" type="xs:string"/>
<xs:element name="suffix">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Jr"/>
<xs:enumeration value="Sr"/>
<xs:enumeration value="II"/>
<xs:enumeration value="III"/>
<xs:enumeration value="IV"/>
<xs:enumeration value="V"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="SSID">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="\d{3}-\d{2}-\d{4}"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="birthDate" type="xs:date"/>
<xs:element name="homePhone" type="PhoneNumberType"/>
<xs:element name="cellPhone" type="PhoneNumberType"/>
<xs:element name="emailAddress">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:element>
<xs:element name="residence" type="ResidenceType"
maxOccurs="unbounded"/>
<xs:element name="employment">
<xs:complexType>
<xs:sequence>
<xs:element name="status">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="unemployed"/>
<xs:enumeration value="employed"/>
<xs:enumeration value="self employed"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="detail" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="occupation" type="xs:string"/>
<xs:element name="employer">
<xs:complexType>
<xs:sequence>
<xs:element name="name"/>
<xs:element name="address" type="AddressType"/>
<xs:element name="lengthOfEmployment" type="DurationType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="workPhone" type="PhoneNumberType"/>
<xs:element name="grossMonthlyIncome">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:minInclusive value="0.00"/>
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="supplementalIncome">
<xs:complexType>
<xs:sequence>
<xs:element name="source">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="alimony"/>
<xs:enumeration value="child support"/>
<xs:enumeration value="investments"/>
<xs:enumeration value="part time job"/>
<xs:enumeration value="rental property"/>
<xs:enumeration value="retirement income"/>
<xs:enumeration value="social security"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="grossMonthlyIncome">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:minInclusive value="0.00"/>
<xs:fractionDigits value="2"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="AddressType">
<xs:sequence>
<xs:element name="address1"/>
<xs:element name="address2"/>
<xs:element name="city"/>
<xs:element name="state" type="StateType"/>
<xs:element name="zip">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="5"/>
<xs:maxLength value="5"/>
<xs:pattern value="\d{5}"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="PhoneNumberType">
<xs:sequence>
<xs:element name="areaCode"/>
<xs:element name="exchange"/>
<xs:element name="number"/>
<xs:element name="extension" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="OccupancyType">
<xs:sequence>
<xs:element name="type">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="rent"/>
<xs:enumeration value="own"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="movedIn" type="xs:date"/>
<xs:element name="lengthOfOccupancy" type="DurationType"/>
<xs:element name="payment">
<xs:simpleType>
<xs:restriction base="xs:decimal">
<xs:fractionDigits value="2"/>
<xs:minInclusive value="0.00"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ResidenceType">
<xs:sequence>
<xs:element name="address" type="AddressType"/>
<xs:element name="occupancy" type="OccupancyType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="CarType">
<xs:sequence>
<xs:element name="year" type="xs:gYear"/>
<xs:element name="make" type="xs:string"/>
<xs:element name="model" type="xs:string"/>
<xs:element name="VIN" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="DurationType">
<xs:sequence>
<xs:element name="years" type="xs:positiveInteger"/>
<xs:element name="months">
<xs:simpleType>
<xs:restriction base="xs:positiveInteger">
<xs:minInclusive value="1"/>
<xs:maxInclusive value="12"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:schema>
|
Homework
Exercise (for people
who
are taking Sang Shin's "Web Services Programming online course")
1. The homework is to create a XML
schema and a XML document that is an instance of the schema as
following. The schema needs to be validated. It is recommended
you use NetBeans to create XML schema and document.
- Define PurchaseOrderType as
a complex type as following
- Sequence of the following elements
- shipTo element which
is Address type
- billTo element which
is Address type
- items element which
is items type
- orderDate attribute
whose type is xsd:date type
- Define Address as a
complex type as following
- Sequence of the following elements
- streetname whose
type is xsd:string
- streetnumber whose
type is xsd:int
- city whose type is xsd:string
- zip whose type is a listOfMyIntType
- country attribute
whose type is enumeration of US,
Korea, Egypt.
- Define items as a
complex type as following
- Sequence of the following elements
- name whose type is xsd:string
- quantity whose type
is xsd:long
- price whose type is xsd:int
- availability attribute
whose type is enumeration of Yes, No.
- Define listOfMyIntType as
following
- Declare the following two global elements
- purchaseOrder whose
type is PurchaseOrderType
- comment whose type is xsd:string
- XML schema file you created
- XML document you created
