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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>CodeGen Examples</title>
</head>
<body class="composite">
<div id="bodycol">
<div class="app">
<div class="h3">
<h3><a name="start"></a>CodeGen example schema</h3>
<p>The <i>/examples/codegen</i> directory of the JiBX distribution contains some
samples for demonstrating the use of CodeGen. The samples use a subset of schema
definitions from the <a href="http://www.opentravel.org/">OpenTravel Alliance</a>,
an organization developing open standards for use in electronic message exchange.
The OTA definitions consist of hundreds of schemas in total, but the subset used for
these samples includes just seven schemas from the OTA2007A distribution, representing
a request-response pair of messages: OTA_AirLowFareSearchRQ and OTA_AirLowFareSearchRS.
As a sample of the structure, here are simplified listings of these main message
schemas (with most of the annoations and some of the structure detail eliminated):</p>
<div id="source"><pre><xs:schema xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://www.opentravel.org/OTA/2003/05"
elementFormDefault="qualified" version="2.007" id="OTA2007A">
<xs:include schemaLocation="OTA_AirCommonTypes.xsd"/>
<xs:include schemaLocation="OTA_AirPreferences.xsd"/>
<xs:element name="OTA_AirLowFareSearchRQ">
<xs:annotation>
<xs:documentation xml:lang="en">
The Low Fare Search Request message requests priced itinerary options for
flights between specific city pairs on specific dates for specific numbers and
types of passengers. Optional request information can include:
- Time / Time Window
- Connecting cities.
- Client Preferences (airlines, cabin, flight types etc.)
The Low Fare Search request contains similar information to a Low Fare Search
entry on an airline CRS or GDS.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="POS" type="POS_Type">
<xs:annotation>
<xs:documentation xml:lang="en">Point of sale object.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ProcessingInfo" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">A collection of information that
specifies how the message processing should occur or how the data
should be returned.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="AirProcessingInfoGroup"/>
</xs:complexType>
</xs:element>
<xs:element name="OriginDestinationInformation" maxOccurs="10">
<xs:annotation>
<xs:documentation xml:lang="en">Origin and Destination location,
and time information for the Air Low Fare Search request.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:complexContent>
<xs:extension base="OriginDestinationInformationType">
<xs:sequence>
<xs:element name="AlternateLocationInfo" minOccurs="0">
...
<xs:complexType>
<xs:attribute name="OriginLocation"
type="ListOfStringLength1to8" use="optional">
...
</xs:attribute>
<xs:attribute name="DestinationLocation"
type="ListOfStringLength1to8" use="optional">
...
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element ref="TPA_Extensions" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="RPH" type="RPH_Type" use="optional">
...
</xs:attribute>
<xs:attribute name="RefNumber" type="Numeric1to99"
use="optional">
...
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="SpecificFlightInfo" type="SpecificFlightInfoType"
minOccurs="0">
...
</xs:element>
<xs:element name="TravelPreferences" minOccurs="0" maxOccurs="10">
...
<xs:complexType>
<xs:complexContent>
<xs:extension base="AirSearchPrefsType">
<xs:attribute name="FlexDatePref" use="optional">
...
</xs:attribute>
...
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="TravelerInfoSummary">
...
<xs:complexType>
<xs:complexContent>
<xs:extension base="TravelerInfoSummaryType">
<xs:attribute name="TicketingCountryCode" type="ISO3166"
use="optional">
...
</xs:attribute>
<xs:attribute name="SpecificPTC_Indicator" type="xs:boolean"
use="optional">
...
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attributeGroup ref="OTA_PayloadStdAttributes"/>
<xs:attributeGroup ref="MaxResponsesGroup"/>
<xs:attribute name="DirectFlightsOnly" type="xs:boolean" use="optional"
default="false">
...
</xs:attribute>
<xs:attribute name="AvailableFlightsOnly" type="xs:boolean"
use="optional">
...
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:schema>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns="http://www.opentravel.org/OTA/2003/05"
targetNamespace="http://www.opentravel.org/OTA/2003/05"
elementFormDefault="qualified" version="5.000" id="OTA2007A">
<xs:include schemaLocation="OTA_AirCommonTypes.xsd"/>
...
<xs:element name="OTA_AirLowFareSearchRS">
<xs:annotation>
<xs:documentation xml:lang="en">
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.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:sequence>
<xs:element name="Success" type="SuccessType">
<xs:annotation>
<xs:documentation xml:lang="en">Success
Standard way to indicate successful processing of an OTA message. Returning an
empty element of this type indicates success.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Warnings" type="WarningsType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en"> Standard way to indicate
successful processing of an OTA message, but one in which warnings are generated.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PricedItineraries" type="PricedItinerariesType">
<xs:annotation>
<xs:documentation xml:lang="en">Successfull Low Fare priced
itineraries in response to a Low Fare Search request.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:element name="Errors" type="ErrorsType">
<xs:annotation>
<xs:documentation xml:lang="en"> A collection of errors that
occurred during the processing of a message.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
<xs:attributeGroup ref="OTA_PayloadStdAttributes">
<xs:annotation>
<xs:documentation xml:lang="en"> The OTA_PayloadStdAttributes
defines the standard attributes that appear on the root element for all
OTA payloads.</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>
</xs:element>
</xs:schema></pre></div>
</div>
<div class="h3">
<h3><a name="start"></a>Sample documents</h3>
<p>The <i>/examples/codegen/samples</i> directory contains the OTA_AirLowFareSearchRQ
and OTA_AirLowFareSearchRS sample documents from the OTA distribution (two documents of
each type). Here's one of the sample requests, and an edited version of the sample
response:</p>
<div id="source"><pre><OTA_AirLowFareSearchRQ EchoToken="50987" TimeStamp="2003-11-19T19:44:10-05:00"
Target="Production" SequenceNmbr="1"
xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05
OTA_AirLowFareSearchRQ.xsd" Version="2.001">
<POS>
<Source>
<RequestorID Type="13" ID="01235"/>
</Source>
</POS>
<OriginDestinationInformation>
<DepartureDateTime>2004-06-05T10:00:00-05:00</DepartureDateTime>
<OriginLocation LocationCode="IAD"/>
<DestinationLocation LocationCode="FLG"/>
</OriginDestinationInformation>
<OriginDestinationInformation>
<DepartureDateTime>2004-06-27T10:00:00-05:00</DepartureDateTime>
<OriginLocation LocationCode="FLG"/>
<DestinationLocation LocationCode="IAD"/>
</OriginDestinationInformation>
<TravelPreferences>
<FareRestrictPref>
<AdvResTicketing AdvTicketingInd="false">
<AdvTicketing/>
</AdvResTicketing>
<StayRestrictions StayRestrictionsInd="true">
<MinimumStay />
<MaximumStay MaxStay="14" StayUnit="Days"/>
</StayRestrictions>
</FareRestrictPref>
</TravelPreferences>
<TravelerInfoSummary>
<AirTravelerAvail>
<PassengerTypeQuantity Code="ADT" Quantity="1"/>
</AirTravelerAvail>
</TravelerInfoSummary>
</OTA_AirLowFareSearchRQ>
<OTA_AirLowFareSearchRS EchoToken="53468" TimeStamp="2003-11-19T19:44:17-05:00"
Target="Production" SequenceNmbr="1"
xmlns="http://www.opentravel.org/OTA/2003/05"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05
OTA_AirLowFareSearchRS.xsd" Version="2.001">
<Success/>
<PricedItineraries>
<PricedItinerary SequenceNumber="1">
<AirItineraryPricingInfo>
<ItinTotalFare>
<BaseFare Amount="256.75" CurrencyCode="USD"/>
<TotalFare Amount="285.00" CurrencyCode="USD"/>
</ItinTotalFare>
<FareInfos>
<FareInfo>
<FareReference> "K"</FareReference>
<RuleInfo>
<ResTicketingRules>
<AdvResTicketing AdvTicketingInd="true">
<AdvTicketing FromDepartPeriod="21" FromDepartUnit="Days"/>
</AdvResTicketing>
</ResTicketingRules>
<LengthOfStayRules>
<MinimumStay MinStay="14" StayUnit="Days"/>
<MaximumStay ReturnType="C" MaxStay="30" StayUnit="Days"/>
</LengthOfStayRules>
<ChargesRules>
<VoluntaryChanges VolChangeInd="true">
<Penalty Percent="100"/>
</VoluntaryChanges>
</ChargesRules>
</RuleInfo>
<FilingAirline>HP</FilingAirline>
<DepartureAirport LocationCode="IAD"/>
<ArrivalAirport LocationCode="FLG"/>
</FareInfo>
...
</FareInfos>
</AirItineraryPricingInfo>
</PricedItinerary>
<PricedItinerary SequenceNumber="2">
<AirItineraryPricingInfo>
<ItinTotalFare>
<BaseFare Amount="337.46" CurrencyCode="USD" />
<TotalFare Amount="375.00" CurrencyCode="USD" />
</ItinTotalFare>
<FareInfos>
<FareInfo>
<FareReference> "Q"</FareReference>
<RuleInfo>
<ResTicketingRules>
<AdvResTicketing AdvTicketingInd="true">
<AdvTicketing FromDepartPeriod="14" FromDepartUnit="Days"/>
</AdvResTicketing>
</ResTicketingRules>
<LengthOfStayRules>
<MinimumStay MinStay="7" StayUnit="Days"/>
<MaximumStay ReturnType="C" MaxStay="14" StayUnit="Days"/>
</LengthOfStayRules>
<ChargesRules>
<VoluntaryChanges VolChangeInd="true">
<Penalty Percent="50"/>
</VoluntaryChanges>
</ChargesRules>
</RuleInfo>
<FilingAirline>NW</FilingAirline>
<DepartureAirport LocationCode="IAD"/>
<ArrivalAirport LocationCode="FLG"/>
</FareInfo>
...
</FareInfos>
</AirItineraryPricingInfo>
</PricedItinerary>
<PricedItinerary SequenceNumber="3">
<AirItineraryPricingInfo>
<ItinTotalFare>
<BaseFare Amount="681.75" CurrencyCode="USD" />
<TotalFare Amount="757.00" CurrencyCode="USD" />
</ItinTotalFare>
<FareInfos>
<FareInfo>
<FareReference> "Y"</FareReference>
<RuleInfo>
<ResTicketingRules>
<AdvResTicketing AdvTicketingInd="false"/>
</ResTicketingRules>
<ChargesRules>
<VoluntaryChanges VolChangeInd="true"/>
</ChargesRules>
</RuleInfo>
<FilingAirline>UA</FilingAirline>
<DepartureAirport LocationCode="IAD"/>
<ArrivalAirport LocationCode="FLG"/>
</FareInfo>
...
</FareInfos>
</AirItineraryPricingInfo>
</PricedItinerary>
</PricedItineraries>
</OTA_AirLowFareSearchRS></pre></div>
</div>
<div class="h3">
<h3><a name="examples"></a>Examples</h3>
<p>The examples using these schemas and sample documents demonstrate using CodeGen with
increasingly sophisticated levels of customization. One of the common complaints about
code generation from schema is that it results in extremely complex data models with a
large number of classes, so simplifying the data model using customizations is a main
focus of the first three examples (which go from 412 classes in the data model, including
inner classes, down to 50 classes). The final example demonstrates modular code generation
from schemas, where some of the base schemas are initially generated on their own, then
the generated base classes and binding are reused when generating the remaining schemas.</p>
<ul>
<li><a href="%cgexample1%"><b>'codegen' target</b></a> - default generation, including all schema components</li>
<li><a href="%cgexample2%"><b>'custgen1' target</b></a> - generating only selected global definitions to eliminate unneeded classes</li>
<li><a href="%cgexample3%"><b>'custgen2' target</b></a> - customizing names and types, eliminating unused parts of schema definitions</li>
<li><a href="%cgexample4%"><b>'custgen3a/custgen3b' targets</b></a> - modular code generation from schema (base and extension code and bindings)</li>
</ul>
</div>
</div>
</div>
</body>
</html>
|
