1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Example 3: More nesting, customizing namespaces, element vs. attribute</title>
</head>
<body class="composite">
<div id="bodycol">
<div class="app">
<div class="h3">
<a name="custom"></a><h3>Going further with customizations</h3>
<p>The <a href="%bgexample2%#custom">Example 2 customizations</a> showed some basic
modifications to BindGen default behavior. Now it's time to go a couple of steps
further, using <i>custom2.xml</i>:</p>
<div id="source"><pre><custom namespace-style="fixed" namespace="http://www.jibx.org/starters/fromcode"
property-access="true">
<package name="org.jibx.starter1">
<class name="Address" includes="street1 city state postCode country"
requireds="street1 city"/>
<class name="Customer" requireds="lastName firstName /customerNumber"/>
<class name="Item" excludes="description" requireds="@id @quantity price"/>
<class name="Order" requireds="orderNumber customer billTo shipping orderDate"/>
</package>
</custom>
</pre></div>
<p>The <code>namespace-style="fixed"</code> attribute on the root 'custom' element
tells BindGen to use fixed namespaces, rather than deriving namespaces from package
names. The <code>namespace="http://www.jibx.org/starters/fromcode"</code> attribute
then defines the namespace to be used. If you want a single, fixed, namespace for all
your XML definitions you need to use both of these attributes together - if you use
the 'namespace' attribute by itself, the namespace you specify will still be modified
for each nested package.</p>
<p>There are three other differences in this customization file, as compared to
the <a href="%bgexample2%#custom">Example 2 customizations</a>. The 'package' element
is a convenient wrapper for the 'class' elements, allowing simple class names to be
used on the 'class' elements instead of fully-qualified class names. You can also add
any nesting customization attributes to the 'package' element. So for example, the
'namespace-style', 'namespace', and 'property-access' attributes could all be moved
from the 'custom' element to the 'package' element.</p>
<p>The other differences are in the 'requireds' value lists for the 'Customer' and
'Item' classes. In this version of the customizations, the list of 'requireds' value
names for the 'Customer' class is in a different order and the 'customerNumber' value
name is prefixed with a slash character ('/'), and the 'id' and 'quantity' value names
in the 'requireds' list for the 'Item' class are prefixed with an at-sign character.
These prefix characters tell BindGen to use a specific representation for the values -
a slash character for an element, an at-sign character for an attribute. The prefix
characters can be used for all the attributes which take value name lists: 'includes',
'optionals', and 'requireds' (they're ignored in the case of 'excludes'). Values names
without one of these indicator prefix characters just use the default representation.</p>
</div>
<div class="h3">
<a name="schema"></a><h3>Generated schema</h3>
<p>You can try out the above customization by again using the Ant 'compile' target to
compile the sample code, followed by the 'custgen2' target to run BindGen using the
above customizations. Here's the resulting schema (again with the longer lines split):</p>
<div id="source"><pre><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://www.jibx.org/starters/fromcode" elementFormDefault="qualified"
<b>targetNamespace="http://www.jibx.org/starters/fromcode"</b>>
<xs:complexType name="address">
<xs:annotation>
<xs:documentation>Address information.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element type="xs:string" name="street1"/>
<xs:element type="xs:string" name="city"/>
<xs:element type="xs:string" name="state" minOccurs="0"/>
<xs:element type="xs:string" name="postCode" minOccurs="0"/>
<xs:element type="xs:string" name="country" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:element type="tns:order" name="order"/>
<xs:complexType name="order">
<xs:annotation>
<xs:documentation>Order information.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="customer">
<xs:complexType>
<xs:sequence>
<b><xs:element type="xs:string" name="lastName"/>
<xs:element type="xs:string" name="firstName"/>
<xs:element type="xs:long" name="customerNumber"/></b>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element type="tns:address" name="billTo"/>
<xs:element name="shipping">
<xs:simpleType>
<xs:annotation>
<xs:documentation>Supported shipment methods. The "INTERNATIONAL" shipment methods
can only be used for orders with shipping addresses outside the U.S., and one of these
methods is required in this case.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="STANDARD_MAIL"/>
<xs:enumeration value="PRIORITY_MAIL"/>
<xs:enumeration value="INTERNATIONAL_MAIL"/>
<xs:enumeration value="DOMESTIC_EXPRESS"/>
<xs:enumeration value="INTERNATIONAL_EXPRESS"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element type="tns:address" name="shipTo" minOccurs="0"/>
<xs:element name="item" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence/>
<b><xs:attribute type="xs:string" use="required" name="id"/></b>
<xs:attribute type="xs:int" use="required" name="quantity"/>
<xs:attribute type="xs:float" use="required" name="price"/>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute type="xs:long" use="required" name="orderNumber"/>
<xs:attribute type="xs:date" use="required" name="orderDate"/>
<xs:attribute type="xs:date" name="shipDate"/>
<xs:attribute type="xs:float" name="total"/>
</xs:complexType>
</xs:schema></pre></div>
<p>Comparing this to the <a href="%bgexample2%#schema">Example 2 schema</a> shows that
the schema target namespace has been changed to that specified by the customizations,
the child elements of 'customer' have been reordered, the 'customerNumber' value is now
an element rather than an attribute, and the 'id' value is now an attribute rather than
an element (all changes shown in bold type in the listing). There's no change to the
'quantity' value representation, since that was already an attribute in the original
schema.</p>
</div>
<div class="h3">
<a name="testing"></a><h3>Testing the binding</h3>
<p>Since the actual XML structure has changed with the customizations used for this
example, testing it requires a different document. The <i>data2.xml</i> document in
the <i>examples/bindgen</i> directory uses the same data as <i>data1.xml</i>, but is
restructured to match the schema changes. Here's the document:</p>
<div id="source"><pre><order orderNumber="12345678" orderDate="2008-10-18" shipDate="2008-10-22"
xmlns="http://www.jibx.org/starters/fromcode">
<customer>
<lastName>Smith</lastName>
<firstName>John</firstName>
<customerNumber>5678</customerNumber>
</customer>
<billTo>
<street1>12345 Happy Lane</street1>
<city>Plunk</city>
<state>WA</state>
<postCode>98059</postCode>
<country>USA</country>
</billTo>
<shipping>PRIORITY_MAIL</shipping>
<shipTo>
<street1>333 River Avenue</street1>
<city>Kirkland</city>
<state>WA</state>
<postCode>98034</postCode>
</shipTo>
<item quantity="1" price="5.99" id="FA9498349851"/>
<item quantity="2" price="9.50" id="GC1234905049"/>
<item quantity="1" price="8.95" id="AX9300048820"/>
</order></pre></div>
<p>You can compare this to the <a href="%bgexample1%#testing"><i>data1.xml</i></a>
listing to see the changes.</p>
<p>Once you've run the Ant 'compile', 'custgen2', and 'bind' targets you can test the
generated binding using 'run-alt' (which runs the same test program as used by the prior
examples, but with <i>data2.xml</i> as input and <i>out2.xml</i> as output). You can
also try out the full 'compile', 'custgen2', 'bind', and 'run-alt' sequence by using
the Ant target 'custom2'.</p>
</div>
</div>
</div>
</body>
</html>
|
