File: faq.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 (626 lines) | stat: -rw-r--r-- 25,216 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
    "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <title>JiBX: Frequently asked questions</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>JiBX: Frequently asked questions</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>
                    <span class="menu-selection">FAQ</span>
                  </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="fromschema/index.html">Start from Schema</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/codegen.html">CodeGen</a>
                  </small>
                              <div>
            <small>
                    <a href="fromschema/codegen-types.html">Schema Datatype Handling</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/codegen-examples.html">Example Code</a>
                  </small>
                              <div>
            <small>
                    <a href="fromschema/example-default.html">Default Generation</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/example-custom1.html">Simple Customizations</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/example-custom2.html">More Customizations</a>
                  </small>
                </div>
                                    <div>
            <small>
                    <a href="fromschema/example-modular.html">Modular Generation</a>
                  </small>
                </div>
                      </div>
                                    <div>
            <small>
                    <a href="fromschema/codegen-customs.html">Customizations Reference</a>
                  </small>
                              <div>
            <small>
                    <a href="fromschema/codegen-extends.html">Extensions Reference</a>
                  </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="questions">Questions</a></h3>

<p><a href="#bcel">What does it mean when I get
<code>java.lang.IncompatibleClassChangeError</code> thrown while trying to
compile a binding?</a></p>

<p><a href="#nobind">What does it mean when I get
<code>org.jibx.runtime.JiBXException: Unable to access binding information for
class ...</code> thrown while trying to run my
application with JiBX?</a></p>

<p><a href="#npe">Why do I get a <code>java.lang.NullPointerException</code>
when I try to marshal a document?</a></p>

<p><a href="#package">How can I control the package used for the classes
generated by JiBX (including the binding factory class or classes, and the
<code>JiBX_MungeAdapter.class</code>)?</a></p>

<p><a href="#jdo">Does JiBX work with other bytecode modification techniques,
such as JDO or Hibernate?</a></p>

<p><a href="#jdk">Which JDK versions are supported by JiBX?</a></p>

<p><a href="#schema">Is there a DTD or schema available for the binding definitions?</a></p>

<p><a href="#axis2">I want to use JiBX data binding with Axis2. How can I learn
more about this combination?</a></p>

<p><a href="#example">Where can I find more information or examples?</a></p>

	  </div>
      <div class="h3">
      <h3><a name="answers">Answers</a></h3>

<p><a name="bcel"></a><b>Q. What does it mean when I get
<code>java.lang.IncompatibleClassChangeError</code> thrown while trying to
compile a binding?</b><br/>
<b>A. </b>This is caused by having an older version of the Apache BCEL library somewhere
in your classpath ahead of the JiBX libraries. It usually occurs when using the
Ant binding task, because Ant often includes an XSLT library named
<i>xsltc.jar</i> in the classpath, and this library uses BCEL. It could also
occur outside of Ant if you have <i>xsltc.jar</i> in your Java installation's
<i>/lib/ext</i> directory. <i>xalan.jar</i> can also cause the same problem, and
for the same reason.</p>

<hr/>

<p><a name="nobind"></a><b>Q. What does it mean when I get
<code>org.jibx.runtime.JiBXException: Unable to access binding information for
class ...</code> thrown while trying to run my application with JiBX?</b><br/>
<b>A. </b>This means your class files (or at least the one for the class you asked the
<code>org.jibx.runtime.BindingDirectory</code> to look up) haven't been processed
by the JiBX binding compiler. Check your build process and make sure you're
doing the binding compiler step. This problem has been known to occur in some
IDEs when the IDE uses a different location for compiled class files from what
is used by an Ant build script or manual build process.</p>

<hr/>

<p><a name="npe"></a><b>Q. Why do I get a <code>java.lang.NullPointerException</code>
when I try to marshal a document?</b><br/>
<b>A. </b>The most likely cause is that you've got a <code>null</code> value
for an object that's not marked as optional in the binding definition. JiBX
trusts what you tell it, so if you don't say an object property is optional the
generated code won't check for a <code>null</code>. To isolate the cause of this
type of problem, look through the stack trace (starting at the top) for the
first class name from your code. This will normally be the class that contains
the null property. You can then verify the binding definition for that class. If
it's not obvious which property is causing the problem, add a <b>pre-get</b>
method to that class for debugging purposes which checks if any of the
non-optional object properties used by the binding are <code>null</code>
(throwing an exception when it finds a <code>null</code>, with any added
information you want to see). This will let you find out all the details of the
problem so that you can fix either the code or the binding, whichever is wrong.</p>

<hr/>

<p><a name="package"></a><b>Q. How can I control the package used for the classes
generated by JiBX (including the binding factory class or classes, and the
<code>JiBX_MungeAdapter.class</code>)?</b><br/>
<b>A. </b>You can control the package used for the binding factory class for a
binding by using the <b>package</b> attribute of the <b>binding</b> element. The
<code>JiBX_MungeAdapter.class</code> is only generated if needed. When needed,
it's created in the package of the first <b>mapping</b> class which is both
modifiable (a class defined in its own file, rather than in a jar file) and not
an interface. If you need this to be in a particular package (as may happen when
you're binding classes that have package access), include a <b>mapping</b> for
one of the classes in this package before any other <b>mapping</b>s in the
binding definition, and if you're compiling more than one binding make the one
with this <b>mapping</b> the first one in the list. If necessary, you can
compile bindings in multiple sets to get more than one
<code>JiBX_MungeAdapter.class</code> in different packages. This only works if
you have bindings with no overlapping packages, though - otherwise running the
binding compiler twice with different sets of bindings will cause information
from the first set to be lost.</p>

<hr/>

<p><a name="jdo"></a><b>Q. Does JiBX work with other bytecode modification
techniques, such as JDO or Hibernate?</b><br/>
<b>A. </b>Yes, JiBX works well with other frameworks which build on bytecode
modification. In the case of JDO you'll generally need to run the JiBX binding
compiler before you run the JDO bytecode enhancement, since the latter may need
to intercept field accesses from the JiBX code. In the case of Hibernate this is
not an issue, since Hibernate only uses runtime bytecode enhancements; however,
you will generally need to have JiBX use get/set methods rather than directly
access fields with working with Hibernate.</p>

<hr/>

<p><a name="jdk"></a><b>Q. Which JDK versions are supported by JiBX?</b><br/>
<b>A. </b>The JiBX runtime and binding compiler have been tested on JDK versions
1.3-1.6. There are some minor differences on the <a href="building.html">build</a>
for JDK 1.3, but these differences do not effect the runtime operation. The new
JiBX tools introduced with the 1.2 release () require JDK 1.4.1 or higher.</p>

<hr/>

<p><a name="schema"></a><b>Q. Is there a DTD or schema available for the binding
definitions?</b><br/>
<b>A. </b>The <i>/docs</i> directory of the distribution includes both a DTD
(<i>binding.dtd</i>) and an XML schema (<i>binding.xsd</i>) for the binding
definitions. These will hopefully be kept up to date, but the definitive
reference for the binding definition format is the <a href="binding/binding-overview.html">HTML
documentation</a>.</p>

<hr/>

<p><a name="axis2"></a><b>Q. I want to use JiBX data binding with Axis2. How can
I learn more about this combination?</b><br/>
<b>A. </b>There's an <a href="axis2/index.html">Axis2</a> subproject page on this site which
provides some basic information and links, and that page will be expanded to
include more information for the upcoming JiBX 1.2 beta release. Beyond that, I offer an
<a href="http://www.sosnoski.com/companys/axis2class.html">Apache Axis2 training
class</a> that covers all three major data binding frameworks supported by Axis2,
including JiBX. Depending on your needs, the class can be customized to provide
more in-depth coverage of the JiBX framework, and can also include coverage of the
JiBX/WS web services support. This class can also be combined with my
<a href="http://www.sosnoski.com/companys/soaclass.html">SOA developers training
class</a> for organizations that are moving to a SOA structure and want to use
JiBX in this context.</p>

<hr/>

<p><a name="example"></a><b>Q. Where can I find more information or examples?</b><br/>
<b>A. </b>There are
searchable archives for the JiBX mailing lists, at the Mail Archive (<a
href="http://www.mail-archive.com/jibx-users%40lists.sourceforge.net/">jibx-users</a>
and <a href="http://www.mail-archive.com/jibx-devs%40lists.sourceforge.net/">jibx-devs</a>)
and MARC: Mailing List Archives at AIMS
(<a href="http://marc.theaimsgroup.com/?l=jibx-users&r=1&w=2">jibx-users</a>,
<a href="http://marc.theaimsgroup.com/?l=jibx-devs&r=1&w=2">jibx-devs</a>, and
<a href="http://marc.theaimsgroup.com/?l=jibx-cvs&r=1&w=2">jibx-cvs</a>). You're
welcome to ask questions on the mailing lists (especially the <b>jibx-users</b>
list), but it's always a good idea to check the archives first before asking a
usage question, just in case it's already been discussed. The archives are
public, but you must subscribe to each list before you can post to that list.</p>

      </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>