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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Example 3: More extensive customizations</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="%cgexample2%#custom">Example 2 customizations</a> showed some basic
modifications to CodeGen default behavior. The third example goes further, using
<i>custom2.xml</i>:</p>
<div id="source"><pre><schema-set prefer-inline="true" generate-all="false" package="org.ota.air"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
repeated-type="array" enumeration-type="simple"
type-substitutions="xs:integer xs:int xs:decimal xs:float">
<name-converter strip-prefixes="OTA_"
strip-suffixes="Type AttributeGroup Group Attributes"/>
<class-decorator
class="org.jibx.schema.codegen.extend.CollectionMethodsDecorator"/>
<schema-type type-name="dateTime" java-class="org.joda.time.DateTime"
serializer="org.jibx.runtime.JodaConvert.serializeUTCDateTime"
deserializer="org.jibx.runtime.JodaConvert.deserializeUTCDateTime"/>
<schema-type type-name="date" format-name="LocalDate.default"/>
<schema-type type-name="time" format-name="LocalTime.local"/>
<schema name="OTA_AirLowFareSearchRQ.xsd" includes="OTA_AirLowFareSearchRQ">
<element name="OTA_AirLowFareSearchRQ" class-name="LowFareSearchRequest">
<element path="**" name="AlternateLocationInfo" ignore="true"/>
<element path="**" name="SpecificFlightInfo" ignore="true"/>
<element path="**" name="ProcessingInfo" ignore="true"/>
</element>
</schema>
<schema name="OTA_AirLowFareSearchRS.xsd" includes="OTA_AirLowFareSearchRS">
<element name="OTA_AirLowFareSearchRS" class-name="LowFareSearchResponse"/>
</schema>
<schema name="OTA_AirCommonTypes.xsd">
<complexType name="FareType">
<element path="**" name="Taxes" ignore="true"/>
<element path="**" name="Fees" ignore="true"/>
<element path="**" name="FareConstruction" ignore="true"/>
<element path="**" name="UnstructuredFareCalc" ignore="true"/>
</complexType>
<complexType name="FareInfoType">
<element path="**" name="Date" ignore="true"/>
<element path="**" name="FareInfo" ignore="true"/>
</complexType>
<complexType name="PricedItinerariesType">
<attribute path="**" name="OriginDestinationRefNumber"
value-name="refNumber"/>
</complexType>
<complexType name="PricedItineraryType">
<element path="**" name="AirItinerary" ignore="true"/>
<element path="**" name="AirItineraryPricingInfo"
value-name="pricingInfo"/>
<element path="**" name="Notes" ignore="true"/>
<element path="**" name="TicketingInfo" ignore="true"/>
</complexType>
<complexType name="AirItineraryPricingInfoType">
<element path="**" name="PTC_FareBreakdowns" ignore="true"/>
</complexType>
<complexType name="TravelerInformationType">
<element path="**" name="AirTraveler" ignore="true"/>
</complexType>
<complexType name="TravelerInfoSummaryType">
<element path="**" name="PriceRequestInformation" ignore="true"/>
</complexType>
</schema>
<schema name="OTA_AirPreferences.xsd">
<complexType name="AirSearchPrefsType">
<element path="**" name="VendorPref" ignore="true"/>
<element path="**" name="FlightTypePref" ignore="true"/>
<element path="**" name="EquipPref" ignore="true"/>
<element path="**" name="CabinPref" ignore="true"/>
<element path="**" name="TicketDistribPref" ignore="true"/>
</complexType>
</schema>
<schema name="OTA_CommonTypes.xsd" excludes="ConnectionType">
<complexType name="SourceType">
<element path="**" name="Position" ignore="true"/>
<element path="**" name="BookingChannel" ignore="true"/>
</complexType>
</schema>
</schema-set>
</pre></div>
<p>These customizations effect both the form of the generated code and the actual schema
structure used to drive the code and binding generation.</p>
<p>On the root <schema-set> element, the <a href="%cgcustoms%#repeated-type"><code>repeated-type="array"</code></a>
attribute changes the representation of repeated values from the default Java 5 typed lists
(inappropriately called "generics") to arrays, and the <a href="%cgcustoms%#enumeration-type"><code> enumeration-type="simple"</code></a>
attribute changes the representation of enumerations from the default Java 5 <code>enum</code>
format to custom type-safe enumerations. Together these changes make the generated code
compatible with pre-Java 5 JDKs (you could also do this by using <code>repeated-type="list"</code>
in place of <code>repeated-type="array"</code>, generating simple untyped lists).</p>
<p>The <a href="%cgcustoms%#type-substitutions"><code>type-substitutions="xs:integer
xs:int xs:decimal xs:float"</code></a> attribute gives pairs of types, with the second
type in each pair substituted for the first wherever referenced in the schema definitions.
This allows you to easily replace a simple type with an awkward Java representation (such
as <code>xs:integer</code>, which uses <code>java.math.BigInteger</code>) with one which
has a more convenient representation (such as <code>xs:int</code>, represented by an
<code>int</code> primitive for a required value or a <code>java.lang.Integer</code> for
an optional value). Naturally, you need to be careful when using this type of substitution
that you maintain compatibility for the documents you're going to be using.</p>
<p>The first group of child elements within the root <schema-set> element (<name-converter>,
<class-decorator>, and several <schema-type> elements) configures
<a href="%cgextends%">extensions to the standard code generation</a>. The
<a href="%cgextends%#naming"><name-converter> element</a> modifies name handling,
in this case stripping some leading and trailing text from XML names before they're
converted to Java names. The <a href="%cgextends%#extend"><class-decorator> element</a>
adds some useful support methods for each collection value in the generated classes,
using an extension class provided as part of the JiBX distribution. You can also write
and use your own code generation extensions in the same way. Finally, the
<a href="%cgextends%#types"><schema-type> elements</a> change the classes and/or
conversion methods used for built-in schema types. In this case the changes are to
use Joda date/time classes rather than Java standard classes for date/time values, with
the first customization naming specific serializer/deserializer methods and the other two
just referencing <a href="%datetime%">predefined formats</a>.</p>
<p>The rest of the customizations dig down into specific schema definitions and either
eliminate components which are not needed for the sample documents (by specifically
<a href="%cgcustoms%#includes">including</a> or <a href="%cgcustoms%#exclude">excluding</a>
particular type definitions from a schema, or by telling CodeGen to
<a href="%cgcustoms%#ignore">ignore</a> specific elements embedded within a schema
definition) or specify a particular <a href="%cgcustoms%#class-name">Java class name</a> or
<a href="%cgcustoms%#value-name">value name</a> to be used for a component. The ignored
elements will be accepted when unmarshalling XML documents but their content will not
be processed, and they will never be generated when marshalling XML documents.</p>
</div>
<div class="h3">
<a name="code"></a><h3>Generated code</h3>
<p>Run the 'custgen2' target and see the <i>gen/src</i> directory (or use the
'custom2' target to generate and compile the code, run the binding compiler, and finally run
a supplied test program which roundtrips the sample documents from the <i>samples</i>
directory). The number of generated classes is now reduced to just 15 top-level classes
and 35 inner classes, or a total of 50, while still maintaining all the components needed
for the sample documents. The generated class names have also been simplified by
eliminating the repetitive name suffixes used in the schemas, and usage has been improved
by replacing <code>java.math.BigDecimal</code> and <code>java.math.BigInteger</code>
references with <code>java.lang.Float</code> and <code>java.lang.Integer</code> references,
respectively.</p>
<p>Here's a sample of the generated code (reformated for a reasonable page width, and
leaving out the methods), showing the same classes as in the
<a href="%cgexample2%#code">Example 2 generated code</a> (with the significant differences
shown in bold):</p>
<div id="source"><pre>
/**
*
The Low Fare Search Response message contains a number of 'Priced Itinerary'
options. Each includes:
- A set of available flights matching the client's request.
- Pricing information including taxes and full fare breakdown for each passenger
type
- Ticketing information
- Fare Basis Codes and the information necessary to make a rules entry.
This message contains similar information to a standard airline CRS or GDS Low
Fare Search Response message.
*
* Schema fragment(s) for this class:
* <pre>
* &lt;xs:element xmlns:ns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="OTA_AirLowFareSearchRS">
* &lt;xs:complexType>
* &lt;xs:sequence>
* &lt;xs:choice>
* &lt;xs:sequence>
* &lt;xs:element type="ns:SuccessType" name="Success"/>
* &lt;xs:element type="ns:WarningsType" name="Warnings"
minOccurs="0">
* &lt;!-- Reference to inner class Warnings -->
* &lt;/xs:element>
* &lt;xs:element type="ns:PricedItinerariesType"
name="PricedItineraries"/>
* &lt;/xs:sequence>
* &lt;xs:element type="ns:ErrorsType" name="Errors"/>
* &lt;/xs:choice>
* &lt;/xs:sequence>
* &lt;xs:attributeGroup ref="ns:OTA_PayloadStdAttributes"/>
* &lt;/xs:complexType>
* &lt;/xs:element>
*
* &lt;xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="SuccessType"/>
*
* &lt;xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PricedItinerariesType">
* &lt;xs:sequence>
* &lt;xs:element name="PricedItinerary" maxOccurs="unbounded">
* &lt;!-- Reference to inner class PricedItinerary -->
* &lt;/xs:element>
* &lt;/xs:sequence>
* &lt;/xs:complexType>
*
* &lt;xs:complexType xmlns:ns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ErrorsType">
* &lt;xs:sequence>
* &lt;xs:element type="ns:ErrorType" name="Error" maxOccurs="99">
* &lt;!-- Reference to inner class _Error -->
* &lt;/xs:element>
* &lt;/xs:sequence>
* &lt;/xs:complexType>
* </pre>
*/
public class <b>LowFareSearchResponse</b>
{
private int choiceSelect = -1;
private static final int SUCCESS_CHOICE = 0;
private static final int ERRORS_CHOICE = 1;
private Warnings warnings;
private <b>PricedItinerary[] pricedItineraries</b>;
private <b>_Error[] errors</b>;
private <b>PayloadStd payloadStd</b>;
...
/**
* Itinerary with pricing information.
*
* Schema fragment(s) for this class:
* <pre>
* &lt;xs:element xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PricedItinerary"
maxOccurs="unbounded">
* &lt;xs:complexType>
* &lt;xs:complexContent>
* &lt;xs:extension base="PricedItineraryType">
* &lt;xs:attribute type="xs:int" use="optional"
name="OriginDestinationRefNumber"/>
* &lt;/xs:extension>
* &lt;/xs:complexContent>
* &lt;/xs:complexType>
* &lt;/xs:element>
*
* &lt;xs:complexType xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema" name="PricedItineraryType">
* &lt;xs:sequence>
* &lt;xs:element type="AirItineraryPricingInfoType"
name="AirItineraryPricingInfo" minOccurs="0">
* &lt;!-- Reference to inner class PricingInfo -->
* &lt;/xs:element>
* &lt;/xs:sequence>
* &lt;xs:attribute type="xs:string" use="required"
name="SequenceNumber"/>
* &lt;/xs:complexType>
* </pre>
*/
public static class PricedItinerary
{
private <b>PricingInfo pricingInfo</b>;
private String sequenceNumber;
private <b>Integer refNumber</b>;
...
</pre></div>
<p>The differences from the generated code shown for the last example are the names used
for the top-level class and some of the other classes, arrays in place of typed lists,
the names of some of the fields
and the simplified form of the <code>PricedItinerary</code> class (which only includes
three fields rather than six, due to components eliminated by customizations), and the
use of a <code>java.lang.Integer</code> in place of a <code>java.math.BigInteger</code>
for the referemce number within the <code>PricedItinerary</code> class.</p>
<p>Next: <a href="%cgexample4%">Example 4: Modular code generation</a></p>
</div>
</div>
</div>
</body>
</html>
|
