File: codegen-extends.html

package info (click to toggle)
libjibx1.2-java 1.2.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 26,260 kB
  • sloc: java: 75,013; xml: 14,068; makefile: 17
file content (738 lines) | stat: -rw-r--r-- 32,031 bytes parent folder | download | duplicates (3)
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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <title>CodeGen Extensions</title>
      <style type="text/css">
        @import url("../style/tigris.css");
        @import url("../style/maven.css");
    .dtd-comment {
      color: #993399;
      font-weight: bold;
      </style>
      <script type="text/javascript">
        if (document.layers) {
          document.writeln('<link rel="stylesheet" type="text/css" href="../style/ns4_only.css" media="screen" /><link rel="stylesheet" type="text/css" href="../style/maven_ns4_only.css" media="screen" />')
        }
      </script>
      <link rel="stylesheet" type="text/css" href="../style/print.css" media="print" />
  <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
</head>
<body class="composite">
<div id="banner">
<table border="0" cellspacing="0" cellpadding="8" width="100%">
  <tbody>
    <tr>
      <td><h1>CodeGen Extensions</h1>
      </td>
      <td>
      <div align="right" id="login"><a href="http://sourceforge.net/projects/jibx"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=69358&type=16" width="150" height="40" border="0" alt="Get JiBX - XML Data Binding for Java at SourceForge.net. Fast, secure and Free Open Source software downloads" /></a></div>
      </td>
    </tr>
  </tbody>
</table>
</div>
<div id="breadcrumbs">
<table border="0" cellspacing="0" cellpadding="4" width="100%">
  <tbody>
    <tr>
      <td>
        <div align="right">
          <a href="../index.html">Home Page</a> |
          <a href="http://www.sourceforge.net/projects/jibx/">SourceForge Page</a> |
          <a href="../mail-lists.html">Mailing Lists</a> |
          <a href="../bugs.html">Bugs</a> |
          <a href="http://sourceforge.net/project/showfiles.php?group_id=69358">Downloads</a>
        </div>
      </td>
    </tr>
  </tbody>
</table>
</div>
<table border="0" cellspacing="0" cellpadding="8" width="100%" id="main">
  <tbody>
	<tr valign="top">
	  <td id="leftcol" width="20%">
		<div id="navcolumn">


                  <div>
            <strong>JiBX Basics</strong>
                              <div>
            <small>
                    <a href="../index.html">Overview</a>
                  </small>
                              <div>
            <small>
                    <a href="../getting-started.html">Getting Started</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../bindcomp.html">Binding Compiler</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../bindonload.html">Binding on Load</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../runtime.html">Runtime</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../extras.html">Extras</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../building.html">Building JiBX</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href=".././jibx-maven-plugin/index.html">Maven</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../contributing.html">Contributing</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../jibx-license.html">License</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="../status.html">News and Status</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../support.html">Support</a>
                  </small>
                              <div>
            <small>
                    <a href="../faq.html">FAQ</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../mail-lists.html">Mailing Lists</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../bugs.html">Bugs</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="../comments.html">User Comments</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../sponsors.html">Sponsors</a>
                  </small>
                </div>
                      </div>
                        <div>
            <strong>Start from Code</strong>
                              <div>
            <small>
                    <a href="../fromcode/index.html">Start from Code</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../fromcode/bindgen.html">BindGen</a>
                  </small>
                              <div>
            <small>
                    <a href="../fromcode/bindgen-examples.html">Example Code</a>
                  </small>
                              <div>
            <small>
                    <a href="../fromcode/bindgen-example1.html">Example 1</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../fromcode/bindgen-example2.html">Example 2</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../fromcode/bindgen-example3.html">Example 3</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../fromcode/bindgen-example4.html">Example 4</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="../fromcode/bindgen-customs.html">Customizations Reference</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="../fromcode/schemagen.html">SchemaGen</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../fromcode/jibx2wsdl.html">Jibx2Wsdl</a>
                  </small>
                              <div>
            <small>
                    <a href="../fromcode/jibx2wsdl-examples.html">Examples</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../fromcode/jibx2wsdl-customs.html">Customizations</a>
                  </small>
                </div>
                      </div>
                      </div>
                        <div>
            <strong>Start from Schema</strong>
                              <div>
            <small>
                    <a href="index.html">Start from Schema</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="codegen.html">CodeGen</a>
                  </small>
                              <div>
            <small>
                    <a href="codegen-types.html">Schema Datatype Handling</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="codegen-examples.html">Example Code</a>
                  </small>
                              <div>
            <small>
                    <a href="example-default.html">Default Generation</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="example-custom1.html">Simple Customizations</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="example-custom2.html">More Customizations</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="example-modular.html">Modular Generation</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="codegen-customs.html">Customizations Reference</a>
                  </small>
                              <div>
            <small>
                    <span class="menu-selection">Extensions Reference</span>
                  </small>
                </div>
                      </div>
                      </div>
                      </div>
                        <div>
            <strong>Binding Definition</strong>
                              <div>
            <small>
                    <a href="../binding/tutorial/binding-tutorial.html">Binding Tutorial</a>
                  </small>
                              <div>
            <small>
                    <a href="../binding/tutorial/binding-start.html">A basic binding</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/tutorial/binding-extras.html">Binding extras</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/tutorial/binding-structures.html">Structure mapping</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/tutorial/binding-collects.html">Collections and arrays</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/tutorial/binding-mappings.html">Using mappings</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/tutorial/binding-advanced.html">Advanced binding</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/tutorial/binding-extend.html">Method hooks</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/tutorial/binding-custom.html">Custom code</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="../binding/precompiled.html">Precompiled Bindings</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/binding-overview.html">Definition details</a>
                  </small>
                              <div>
            <small>
                    <a href="../binding/contexts.html">Definition contexts</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/conversions.html">Conversions</a>
                  </small>
                              <div>
            <small>
                    <a href="../binding/date-time.html">Date/time conversions</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="../binding/xml-summary.html">XML summary</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/binding-element.html">&lt;binding&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/include-element.html">&lt;include&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/format-element.html">&lt;format&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/namespace-element.html">&lt;namespace&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/mapping-element.html">&lt;mapping&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/value-element.html">&lt;value&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/structure-element.html">&lt;structure&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/collection-element.html">&lt;collection&gt; element</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../binding/binding-attributes.html">Attribute groups</a>
                  </small>
                </div>
                      </div>
                      </div>
                        <div>
            <strong>Usage API</strong>
                              <div>
            <small>
                    <a href=".././api/index.html">Runtime JavaDocs</a>
                  </small>
                </div>
                      </div>
                        <div>
            <strong>Subprojects</strong>
                              <div>
            <small>
                    <a href="../eclipse/index.html">Eclipse Plug-in</a>
                  </small>
                              <div>
            <small>
                    <a href="../eclipse/index.html">Introduction</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../eclipse/install.html">Install</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../eclipse/usage.html">Usage</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="../jibxws/index.html">JiBX/WS</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../axis2/index.html">Axis2 Usage</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="../jibxota/index.html">JiBX/OTA</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href=".././schema-library/index.html">Schema Library</a>
                  </small>
                </div>
                      </div>
      

        </div>
      </td>
      <td>


<div id="bodycol">
<div class="app">
<div class="h3">
<h3><a name="intro"></a>CodeGen extensions</h3>

<p>Extension customization elements are used to extend or modify the actual code generation.
CodeGen allows you to apply extensions either to a particular schema or to a set of schemas,
so they fit into the customization document structure as child elements of a <b>schema</b>
or <b>schema-set</b> element. Since they always apply to all the schemas associated with the
parent <b>schema</b> or <b>schema-set</b> element, they must precede any other child
elements. Here's a sample to show how this works, with the extension elements shown in
bold:</p>

<code><pre>&lt;schema-set xmlns:xs="http://www.w3.org/2001/XMLSchema"
    type-substitutions="xs:integer xs:int xs:decimal xs:float">
  <b>&lt;name-converter strip-prefixes="OTA_"
      strip-suffixes="Type AttributeGroup Group Attributes"/>
  &lt;class-decorator class="org.jibx.schema.codegen.extend.CollectionMethodsDecorator"/></b>
  &lt;schema-set package="org.ota.air" names="OTA_Air*.xsd">
    <b>&lt;schema-type type-name="dateTime" java-class="org.joda.time.DateTime"
        format-name="DateTime.zoned"/></b>
    &lt;schema-set generate-all="false" prefer-inline="true"
        names="OTA_AirCommonTypes.xsd OTA_AirPreferences.xsd"/>
    &lt;schema name="OTA_AirAvailRS.xsd">
      &lt;element path="element[@name=OTA_AirAvailRS]/**/element[@name=OriginDestinationOption]"
        ignore="true"/>
    &lt;/schema>
  &lt;/schema-set>
  &lt;schema-set package="org.ota.hotel" names="OTA_Hotel*.xsd">
    &lt;schema-set generate-all="false" prefer-inline="true"
        names="OTA_HotelCommonTypes.xsd OTA_HotelContentDescription.xsd
        OTA_HotelEvent.xsd OTA_HotelPreferences.xsd OTA_HotelReservation.xsd
        OTA_HotelRFP.xsd"/>
  &lt;/schema-set>
  ...</pre></code>

<p>The <b>name-converter</b> (modifying the way names are generated) and
<b>class-decorator</b> (adding collection helper methods to generated classes, in
this case) elements are both children of the root <b>schema-set</b> element, so they
apply to all code generation. The <b>schema-type</b> element (changing the Java type
generated for a schema datatype) is a child of the nested <b>schema-set</b>, so it
only applies to the code generation for schemas included in that set.</p>

</div>
<div class="h3">
<h3><a name="extensible"></a>Extensible extensions</h3>

<p>Some extension elements are designed to support selecting a particular implementation
for an interface used during code generation. These extension elements normally have one
required attribute, the 'class' attribute (though in the case of the <b>name-converter</b>
extension, this attribute has a default value matching a built-in class). This attribute
is used to supply the fully-qualified class name of your implementation class. Besides
this required attribute, you can add other attributes which correspond to properties of
your implementation class. These added attributes will be used to configure an instance of
the class before it is used in code generation, so that you can customize general-purpose
extension classes for each use.</p>

<p>CodeGen uses reflection to match any additional attributes to property or field names in
your class (or in a superclass). First any hyphens in the attribute name are removed,
with the character following any hyphen converted to uppercase. This modified name is
then used to look for a method or field name, in three different forms.</p>

<p>Due to some legacy code handling, the preferred form of match is somewhat unusual -
CodeGen looks for a method name starting with <code>set</code> followed by the attribute
name (with the first letter of the name converted to uppercase)
and ending with <code>Text</code>. The method may have either one or two parameters, with
the first parameter a <code>java.lang.String</code> and the second (if defined) a
<code>org.jibx.runtime.IUnmarshallingContext</code>. This form of match is intended for
when the supplied attribute value needs to use some special conversion. If a match of
this type is found, CodeGen calls the method to set the value, passing the attribute
value text as the first parameter (and the unmarshalling context as the second parameter,
if used).</p>

<p>If the preferred form of match described above is not found, CodeGen next looks for
either a <code>set</code> method matching the attribute name (with the first letter of
the attribute name converted to uppercase) with a single parameter, or a field name
matching the attribute name with <code>m_</code> prefix. The method parameter or field
may be of any of the following types: <code>boolean</code>/<code>java.lang.Boolean</code>;
<code>double</code>/<code>java.lang.Double</code>; <code>float</code>/<code>java.lang.Float</code>;
<code>int</code>/<code>java.lang.Integer</code>; <code>long</code>/<code>java.lang.Long</code>; 
<code>java.lang.String</code>; or <code>java.lang.String[]</code>. CodeGen converts the
supplied attribute value to the appropriate type (in the case of an array of
<code>String</code>, by splitting at each embedded whitespace sequence and trimming all
leading and trailing whitespace from each resulting value) and calls the method or sets
the field value directly.</p>

<p>You can see the source code for the classes mentioned in the remainder of this section
for examples of this correspondence between attribute names and method or field names.</p>


<h4><a name="naming"></a>Controlling name handling</h4>

<p>The <b>name-converter</b> extension element is used to control how XML names are converted
to Java names. It can be used in two ways: To change the behavior of the default name converter
class used by CodeGen (<code>org.jibx.schema.codegen.extend.DefaultNameConverter</code>), or
to completely replace that default name converter class with your own implementation.</p>

<p>When used to change the behavior of the default name converter class used by CodeGen,
the following attributes apply:</p>

<h5>Default name converter customization attributes</h5>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<td><p><a name="field-prefix"></a>field-prefix</p></td>
<td><p>Prefix string to be added at the beginning of generated normal (non-static)
field names. By default, the prefix string is empty.</p></td>
</tr>
<tr class="a">
<td><p><a name="field-suffix"></a>field-suffix</p></td>
<td><p>Suffix string to be added at the end of generated normal (non-static)
field names. By default, the suffix string is empty.</p></td>
</tr>
<tr class="b">
<td><p><a name="static-prefix"></a>static-prefix</p></td>
<td><p>Prefix string to be added at the beginning of generated static
field names. By default, the prefix string is empty.</p></td>
</tr>
<tr class="a">
<td><p><a name="static-suffix"></a>static-suffix</p></td>
<td><p>Suffix string to be added at the end of generated static
field names. By default, the suffix string is empty.</p></td>
</tr>
<tr class="b">
<td><p><a name="strip-prefixes"></a>strip-prefixes</p></td>
<td><p>Prefix strings to be stripped from schema names before converting to Java names.
The value is a list of prefix strings, separated by whitespace characters.</p></td>
</tr>
<tr class="a">
<td><p><a name="strip-suffixes"></a>strip-suffixes</p></td>
<td><p>Suffix strings to be stripped from schema names before converting to Java names.
The value is a list of suffix strings, separated by whitespace characters.</p></td>
</tr>
</table>

<p>When the <b>name-converter</b> element is used to replace the default name converter
class with your own implementation, there's only one fixed attribute: The 'class'
attribute. This attribute gives the fully-qualified name of your name converter
implementation class, which must implement the
<code>org.jibx.schema.codegen.extend.NameConverter</code> interface. You can use other
attributes on the element to configure your name converter instance, as described
<a href="#extensible">above</a>.</p>

<p>If you do take the approach of writing your own name converter implementation you'll
probably want to refer to the default
<code>org.jibx.schema.codegen.extend.DefaultNameConverter</code> implementation and either
use it as the base for your own implementation or just subclass and override methods
selectively.</p>

<h4><a name="extend"></a>Extending code generation</h4>

<p>You can extend Java class generation to add special handling or features to the
generated code, using <b>class-decorator</b> elements. Multiple <b>class-decorator</b>
elements can be used, and by default the decorators are inherited by child <b>schema-set</b>
and <b>schema-set</b> elements within the customizations. You can change this by using the
<a href="codegen-customs.html#inherit-decorators">inherit-decorators</a> customization attribute.</p>

<p>The required 'class' attribute must give the fully-qualified class name of a class
implementing the <code>org.jibx.schema.codegen.extend.ClassDecorator</code> interface.
This interface defines methods called by CodeGen during the process of generating a Java
class. The method parameters give your implementation code ways to hook into the code
generation, which uses the Eclipse Abstract Syntax Tree (AST) model. You can then modify
the AST in various ways to meet your needs.</p>

<p>Several decorators are provided with CodeGen, along with an abstract base class
useful for writing your own decorators. These build-in decorators are described in the
remainder of this section.</p>

<h5>Base class for matching names</h5>

<p><code>org.jibx.schema.codegen.extend.NameMatchDecoratorBase</code> is a convenient
base class to use if you want your decorator to apply only to some of the data model
classes. Decorators based on this class support a 'match-name' attribute on the
<b>class-decorator</b> customization. The value of this optional attribute is a name
pattern, which can include one or more '*' wildcard match characters. Subclasses can
call the base class <code>matchName()</code> method to check if a class name matches
the pattern.</p>

<h5>Adding collection methods</h5>

<p><code>org.jibx.schema.codegen.extend.CollectionMethodsDecorator</code> adds
helper methods for collection values represented by <code>java.util.List</code> instances.
The helper methods are <code>int sizeXXX()</code> to get the number of items in the list,
<code>void addXXX(type)</code> to add an item to the list, <code>type getXXX(int)</code>
to get an item by position, and <code>void clearXXX()</code> to remove all items from
the list (where 'XXX' is the value name). No attributes are used with this decorator.</p>

<h5>Changing the <code>List</code> implementation class</h5>

<p><code>org.jibx.schema.codegen.extend.ListImplementationDecorator</code> lets you
set the implementation class to be used for instances of <code>java.util.List</code> in
the data model. The required 'list-class' attribute must give the fully-qualified class
name of the desired implementation class.</p>

<h5>Extending a base class</h5>

<p><code>org.jibx.schema.codegen.extend.ExtensionDecorator</code> allows you to set
a base class to be extended by your data model classes. This decorator class itself
extends the abstract <code>org.jibx.schema.codegen.extend.NameMatchDecoratorBase</code>
class described above, so you can use a 'match-name' attribute to control the data
model classes which are modified by this decorator (matching on the simple class name,
without package name). The 'base-class' attribute must give the desired base class
name.</p>

<p>You can also use this decorator to customize the JiBX binding for data model classes
to call <a href="../binding/tutorial/binding-extend.html#extmeths">user extension methods</a> implemented by the
base class. Use a 'pre-get-name' attribute to set a method to be called before marshalling
the data class, a 'pre-set-name' attribute to set a method to be called before
unmarshalling to the data class, and a 'post-set-name' attribute to set a method to be
called after unmarshalling the data class. </p>

<h5>Making data model classes serializable</h5>

<p><code>org.jibx.schema.codegen.extend.SerializableDecorator</code> is used to add
the <code>java.io.Serializable</code> interface to generated data model classes. If a
'serial-version' attribute is used with this decorator it will also add a
<code>serialVersionUID</code> value to each generated class, with the specified version
(which must be a long integer value).</p>

</div>
<div class="h3">
<h3><a name="types"></a>Schema datatypes</h3>

<p>You can customize the code generation for schema built-in datatypes using the
<b>schema-type</b> element. Besides determining the Java type to be used for a schema
datatype, this also allows you to define the actual format used to convert instances
of one into the other (see <a href="../binding/tutorial/binding-extend.html#serdeser"></a> and
<a href="../binding/format-element.html">&lt;format> element</a> for dicsussions of these conversions). The
attributes used with the <b>schema-type</b> element are listed in the following table:</p>

<h5><b>schema-type</b> attributes</h5>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<td><p><a name="check-method"></a>check-method</p></td>
<td><p>Fully-qualified class and method name of a static method used to check if a
text string represents a valid instance of the type. The referenced method must take
a <code>String</code> value as its only parameter, and must return type
<code>boolean</code>. This attribute is optional and the supplied method is currently
unused, but will be used in the future to support intelligent handling of <b>xs:union</b>
constructs.</p></td>
</tr>
<tr class="a">
<td><p><a name="deserializer"></a>deserializer</p></td>
<td><p>Fully-qualified class and method name of a static method used to convert a text
string to an instance of the Java type. This attribute is optional, and is not needed if
the Java type defines a constructor taking a parameter of type <code>String</code> as the
only parameter, or if the <a href="#format-name">'format-name'</a> attribute is used.</p></td>
</tr>
<tr class="b">
<td><p><a name="format-name"></a>format-name</p></td>
<td><p>Name of a built-in JiBX format to be used for conversions between a text value
of the schema type and an instance of the Java type. This optional attribute is really only
useful when you want to use the Joda <a href="../binding/date-time.html">Date/time conversions</a>.</p></td>
</tr>
<tr class="a">
<td><p><a name="java-class"></a>java-class</p></td>
<td><p>Java fully-qualified class name. This required attribute gives
the name of the Java type to be used for the schema type.</p></td>
</tr>
<tr class="b">
<td><p><a name="serializer"></a>serializer</p></td>
<td><p>Fully-qualified class and method name of a static method used to convert an instance
of the Java type to a text string. This attribute is optional, and is not needed if
the Java type defines a <code>toString()</code> method compatible with the XML
representation, or if the <a href="#format-name">'format-name'</a> attribute is
used.</p></td>
</tr>
<tr class="a">
<td><p><a name="type-name"></a>type-name</p></td>
<td><p>Schema built-in type name. This required attribute gives the simple (unqualified)
name of the schema type being handled.</p></td>
</tr>
</table>

</div>
</div>
</div>


      </td>
    </tr>
  </tbody>
</table>
<div id="footer">
<table border="0" cellspacing="0" cellpadding="4">
  <tbody>
    <tr>
      <td> &copy; 2003-2011, Dennis M. Sosnoski (<a href="http://www.sosnoski.co.nz">Sosnoski Software Associates Ltd</a>).
      Licensed to the JiBX Project for free distribution and use. </td>
    </tr>
  </tbody>
</table>
</div>
<br>
</body>
</html>