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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: Clean Code with JiBX</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: Clean Code with JiBX</h1>
</td>
<td>
<div align="right" id="login"><a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=69358&type=5"
width="210" height="62" border="0" alt="SourceForge.net Logo"></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="http://wiki.jibx.org">Wiki</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="flexibility.html">Flexibility</a>
</small>
</div>
<div>
<small>
<a href="performance.html">Performance</a>
</small>
</div>
<div>
<small>
<span class="menu-selection">Clean code</span>
</small>
</div>
</div>
<div>
<small>
<a href="status.html">News and Status</a>
</small>
</div>
<div>
<small>
<a href="comments.html">User Comments</a>
</small>
</div>
<div>
<small>
<a href="bugs.html">Bugs</a>
</small>
</div>
<div>
<small>
<a href="start.html">Getting Started</a>
</small>
<div>
<small>
<a href="tutorial/binding-tutorial.html">Binding Tutorial</a>
</small>
<div>
<small>
<a href="tutorial/binding-start.html">A basic binding</a>
</small>
</div>
<div>
<small>
<a href="tutorial/binding-extras.html">Binding extras</a>
</small>
</div>
<div>
<small>
<a href="tutorial/binding-structures.html">Structure mapping</a>
</small>
</div>
<div>
<small>
<a href="tutorial/binding-collects.html">Collections</a>
</small>
</div>
<div>
<small>
<a href="tutorial/binding-mappings.html">Using mappings</a>
</small>
</div>
<div>
<small>
<a href="tutorial/binding-advanced.html">Advanced binding</a>
</small>
</div>
<div>
<small>
<a href="tutorial/binding-extend.html">Method hooks</a>
</small>
</div>
<div>
<small>
<a href="tutorial/binding-custom.html">Custom code</a>
</small>
</div>
</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">JiBX Extras</a>
</small>
</div>
<div>
<small>
<a href="building.html">Building JiBX</a>
</small>
</div>
</div>
<div>
<small>
<a href="schema.html">Schema Compatibility</a>
</small>
</div>
<div>
<small>
<a href="mail-lists.html">Mailing Lists</a>
</small>
</div>
<div>
<small>
<a href="faq.html">FAQ</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>
<strong>Binding Definition</strong>
<div>
<small>
<a href="details/binding-overview.html">Definition details</a>
</small>
<div>
<small>
<a href="details/contexts.html">Definition contexts</a>
</small>
</div>
<div>
<small>
<a href="details/conversions.html">Conversions</a>
</small>
</div>
<div>
<small>
<a href="details/xml-summary.html">XML summary</a>
</small>
</div>
<div>
<small>
<a href="details/binding-element.html"><binding> element</a>
</small>
</div>
<div>
<small>
<a href="details/include-element.html"><include> element</a>
</small>
</div>
<div>
<small>
<a href="details/format-element.html"><format> element</a>
</small>
</div>
<div>
<small>
<a href="details/namespace-element.html"><namespace> element</a>
</small>
</div>
<div>
<small>
<a href="details/mapping-element.html"><mapping> element</a>
</small>
</div>
<div>
<small>
<a href="details/value-element.html"><value> element</a>
</small>
</div>
<div>
<small>
<a href="details/structure-element.html"><structure> element</a>
</small>
</div>
<div>
<small>
<a href="details/collection-element.html"><collection> element</a>
</small>
</div>
<div>
<small>
<a href="details/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="jibxtools/index.html">Generator Tools</a>
</small>
</div>
<div>
<small>
<a href="jibxsoap/index.html">JibxSoap</a>
</small>
</div>
<div>
<small>
<a href="siteamatic/index.html">SiteAMatic</a>
</small>
</div>
<div>
<small>
<a href="xsd2jibx/index.html">Xsd2Jibx</a>
</small>
</div>
</div>
</div>
</td>
<td>
<div id="bodycol">
<div class="app">
<div class="h3">
<h3><a name="clean">Clean code</a></h3>
<p>Most data binding frameworks are XML-centric. You start with a
grammar for your XML documents (usually in the form of a W3C XML Schema)
and use that to generate a set of classes that match the XML structure.
With some frameworks you can subclass the generated classes, in others
you may be able to implement generated interfaces in your own classes
and use these classes in place of the generated ones. Either way, you
still need to match the class structure expected by the binding
framework.</p>
<p>JiBX is deliberately Java-centric. It does not force a
structure on your Java classes, other than that there be some
reasonable way of linking particular properties of class instances to
components of the XML document. This lets you define classes that match
your needs, not just the (often arbitrary) structure of the XML. It also
lets you refactor your code over time without needing to change the XML
structure each time to match.</p>
<p>This is an especially important feature because it allows you to use true
object-oriented structuring of your code. The frameworks that force you to
work with a generated set of classes generally limit you to using JavaBean-like
objects - basically just collections of fields with get and set methods added,
only cosmetically different from a C-language "struct". True
object-oriented programming requires combining behavior with state (data), and
hiding as much of the internal state as possible from clients of an object.
JiBX is designed to encourage this style of development.</p>
<p>JiBX also avoids cluttering your Java
source files with generated code. Because it uses class file
enhancement rather than source code generation, it can stay out of your
way - you normally won't even see the JiBX code at all unless you use
reflection on the enhanced classes (though it's possible to decompile
the enhanced classes to get source, if that's what you really want).</p>
<p>This doesn't mean that JiBX is ideal for all applications.
Code generation from a schema instance is a great way to get started
quickly on working with a particular type of XML document. Code
generation also helps assure that your code always matches the XML
document structure, and many of the code generation approaches allow
for full validation against the document grammar.</p>
<p>In the future it'd be great to add support for code (and binding definition)
generation to JiBX, and nothing in the design in any way prevents this from
being done (in fact, see the <a href="xsd2jibx/index.html">Xsd2Jibx</a> and
<a href="./jibxtools/index.html">Generator Tools</a> subprojects for the
current work in these areas). We're also planning to support J2SE 5.0 annotations
for embedding simple binding definitions directly in the source code. An
annotation-based approach will not allow the same level of flexibility as
provided by a binding definition file, but will be convenient for users who want
to keep a close correspondence between their Java class structure and the XML
representation.</p>
</div>
</div>
</div>
</td>
</tr>
</tbody>
</table>
<div id="footer">
<table border="0" cellspacing="0" cellpadding="4">
<tbody>
<tr>
<td> © 2003-2005, Dennis M. Sosnoski (<a href="http://www.sosnoski.com">Sosnoski Software Solutions, Inc.</a>).
Licensed to the JiBX Project for free distribution and use. </td>
</tr>
</tbody>
</table>
</div>
<br>
</body>
</html>
|
