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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_03) on Fri Jan 25 23:29:22 CET 2008 -->
<TITLE>
IMapping (JiBX Java data binding to XML - Version 1.0)
</TITLE>
<META NAME="date" CONTENT="2008-01-25">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IMapping (JiBX Java data binding to XML - Version 1.0)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def"><B>PREV CLASS</B></A>
<A HREF="../../../../org/jibx/binding/def/LinkableBase.html" title="class in org.jibx.binding.def"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/jibx/binding/def/IMapping.html" target="_top"><B>FRAMES</B></A>
<A HREF="IMapping.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.jibx.binding.def</FONT>
<BR>
Interface IMapping</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/jibx/binding/def/IComponent.html" title="interface in org.jibx.binding.def">IComponent</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/jibx/binding/def/MappingBase.html" title="class in org.jibx.binding.def">MappingBase</A>, <A HREF="../../../../org/jibx/binding/def/MappingDefinition.html" title="class in org.jibx.binding.def">MappingDefinition</A>, <A HREF="../../../../org/jibx/binding/def/MappingDirect.html" title="class in org.jibx.binding.def">MappingDirect</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>IMapping</B><DT>extends <A HREF="../../../../org/jibx/binding/def/IComponent.html" title="interface in org.jibx.binding.def">IComponent</A></DL>
</PRE>
<P>
Interface for mapping definitions. This defines the additional access methods
used with mappings (beyond those used with ordinary components).
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>1.0</DD>
<DT><B>Author:</B></DT>
<DD>Dennis M. Sosnoski</DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#addExtension(org.jibx.binding.def.MappingDefinition)">addExtension</A></B>(<A HREF="../../../../org/jibx/binding/def/MappingDefinition.html" title="class in org.jibx.binding.def">MappingDefinition</A> mdef)</CODE>
<BR>
Add extension to abstract mapping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#addNamespace(org.jibx.binding.def.NamespaceDefinition)">addNamespace</A></B>(<A HREF="../../../../org/jibx/binding/def/NamespaceDefinition.html" title="class in org.jibx.binding.def">NamespaceDefinition</A> ns)</CODE>
<BR>
Add namespace.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/jibx/binding/def/IComponent.html" title="interface in org.jibx.binding.def">IComponent</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#buildRef(org.jibx.binding.def.IContainer, org.jibx.binding.def.IContextObj, java.lang.String, org.jibx.binding.def.PropertyDefinition)">buildRef</A></B>(<A HREF="../../../../org/jibx/binding/def/IContainer.html" title="interface in org.jibx.binding.def">IContainer</A> parent,
<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A> objc,
java.lang.String type,
<A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html" title="class in org.jibx.binding.def">PropertyDefinition</A> prop)</CODE>
<BR>
Build reference to mapping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#generateCode(boolean)">generateCode</A></B>(boolean force)</CODE>
<BR>
Generate required code for mapping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#getBoundType()">getBoundType</A></B>()</CODE>
<BR>
Get class name handled by mapping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/jibx/binding/def/IComponent.html" title="interface in org.jibx.binding.def">IComponent</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#getImplComponent()">getImplComponent</A></B>()</CODE>
<BR>
Get binding component implementing mapping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#getIndex()">getIndex</A></B>()</CODE>
<BR>
Get mapped class index number.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#getMarshaller()">getMarshaller</A></B>()</CODE>
<BR>
Get marshaller class used for mapping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/jibx/binding/def/NameDefinition.html" title="class in org.jibx.binding.def">NameDefinition</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#getName()">getName</A></B>()</CODE>
<BR>
Get mapped element name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#getReferenceType()">getReferenceType</A></B>()</CODE>
<BR>
Get class name of type to be assumed for references to this mapping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#getTypeName()">getTypeName</A></B>()</CODE>
<BR>
Get type name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#getUnmarshaller()">getUnmarshaller</A></B>()</CODE>
<BR>
Get unmarshaller class used for mapping.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#isAbstract()">isAbstract</A></B>()</CODE>
<BR>
Check if mapping is abstract.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jibx/binding/def/IMapping.html#isBase()">isBase</A></B>()</CODE>
<BR>
Check if mapping has extensions.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.jibx.binding.def.IComponent"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface org.jibx.binding.def.<A HREF="../../../../org/jibx/binding/def/IComponent.html" title="interface in org.jibx.binding.def">IComponent</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/jibx/binding/def/IComponent.html#checkContentSequence(boolean)">checkContentSequence</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#genAttributeMarshal(org.jibx.binding.classes.ContextMethodBuilder)">genAttributeMarshal</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#genAttributeUnmarshal(org.jibx.binding.classes.ContextMethodBuilder)">genAttributeUnmarshal</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#genAttrPresentTest(org.jibx.binding.classes.ContextMethodBuilder)">genAttrPresentTest</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#genContentMarshal(org.jibx.binding.classes.ContextMethodBuilder)">genContentMarshal</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#genContentPresentTest(org.jibx.binding.classes.ContextMethodBuilder)">genContentPresentTest</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#genContentUnmarshal(org.jibx.binding.classes.ContextMethodBuilder)">genContentUnmarshal</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#genLoadId(org.jibx.binding.classes.ContextMethodBuilder)">genLoadId</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#genNewInstance(org.jibx.binding.classes.ContextMethodBuilder)">genNewInstance</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#getType()">getType</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#hasAttribute()">hasAttribute</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#hasContent()">hasContent</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#hasId()">hasId</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#isOptional()">isOptional</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#print(int)">print</A>, <A HREF="../../../../org/jibx/binding/def/IComponent.html#setLinkages()">setLinkages</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getBoundType()"><!-- --></A><H3>
getBoundType</H3>
<PRE>
java.lang.String <B>getBoundType</B>()</PRE>
<DL>
<DD>Get class name handled by mapping.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>name of class bound by mapping</DL>
</DD>
</DL>
<HR>
<A NAME="getReferenceType()"><!-- --></A><H3>
getReferenceType</H3>
<PRE>
java.lang.String <B>getReferenceType</B>()</PRE>
<DL>
<DD>Get class name of type to be assumed for references to this mapping.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>reference type class name name</DL>
</DD>
</DL>
<HR>
<A NAME="getImplComponent()"><!-- --></A><H3>
getImplComponent</H3>
<PRE>
<A HREF="../../../../org/jibx/binding/def/IComponent.html" title="interface in org.jibx.binding.def">IComponent</A> <B>getImplComponent</B>()</PRE>
<DL>
<DD>Get binding component implementing mapping. This call is only valid for
mappings with child components, not for mappings defined using
marshallers or unmarshallers.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>binding component implementing this mapping</DL>
</DD>
</DL>
<HR>
<A NAME="getMarshaller()"><!-- --></A><H3>
getMarshaller</H3>
<PRE>
<A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> <B>getMarshaller</B>()
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Get marshaller class used for mapping.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>marshaller class information
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if error in configuration</DL>
</DD>
</DL>
<HR>
<A NAME="getUnmarshaller()"><!-- --></A><H3>
getUnmarshaller</H3>
<PRE>
<A HREF="../../../../org/jibx/binding/classes/ClassFile.html" title="class in org.jibx.binding.classes">ClassFile</A> <B>getUnmarshaller</B>()
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Get unmarshaller class used for mapping.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>unmarshaller class information
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if error in configuration</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
<A HREF="../../../../org/jibx/binding/def/NameDefinition.html" title="class in org.jibx.binding.def">NameDefinition</A> <B>getName</B>()</PRE>
<DL>
<DD>Get mapped element name.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>mapped element name information (may be <code>null</code> if no
element name defined for mapping)</DL>
</DD>
</DL>
<HR>
<A NAME="getTypeName()"><!-- --></A><H3>
getTypeName</H3>
<PRE>
java.lang.String <B>getTypeName</B>()</PRE>
<DL>
<DD>Get type name.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>type name (<code>null</code> if unnamed)</DL>
</DD>
</DL>
<HR>
<A NAME="getIndex()"><!-- --></A><H3>
getIndex</H3>
<PRE>
int <B>getIndex</B>()</PRE>
<DL>
<DD>Get mapped class index number.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>mapped class index number in context</DL>
</DD>
</DL>
<HR>
<A NAME="addNamespace(org.jibx.binding.def.NamespaceDefinition)"><!-- --></A><H3>
addNamespace</H3>
<PRE>
void <B>addNamespace</B>(<A HREF="../../../../org/jibx/binding/def/NamespaceDefinition.html" title="class in org.jibx.binding.def">NamespaceDefinition</A> ns)
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Add namespace. This adds a namespace definition to those active for the
mapping.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ns</CODE> - namespace definition to be added
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if error in defining namespace</DL>
</DD>
</DL>
<HR>
<A NAME="isAbstract()"><!-- --></A><H3>
isAbstract</H3>
<PRE>
boolean <B>isAbstract</B>()</PRE>
<DL>
<DD>Check if mapping is abstract.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if an abstract mapping, <code>false</code> if
not</DL>
</DD>
</DL>
<HR>
<A NAME="isBase()"><!-- --></A><H3>
isBase</H3>
<PRE>
boolean <B>isBase</B>()</PRE>
<DL>
<DD>Check if mapping has extensions.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if one or more mappings extend this mapping,
<code>false</code> if not</DL>
</DD>
</DL>
<HR>
<A NAME="addExtension(org.jibx.binding.def.MappingDefinition)"><!-- --></A><H3>
addExtension</H3>
<PRE>
void <B>addExtension</B>(<A HREF="../../../../org/jibx/binding/def/MappingDefinition.html" title="class in org.jibx.binding.def">MappingDefinition</A> mdef)
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Add extension to abstract mapping. This call is only valid for abstract
mappings.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mdef</CODE> - extension mapping definition
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if configuration error</DL>
</DD>
</DL>
<HR>
<A NAME="buildRef(org.jibx.binding.def.IContainer, org.jibx.binding.def.IContextObj, java.lang.String, org.jibx.binding.def.PropertyDefinition)"><!-- --></A><H3>
buildRef</H3>
<PRE>
<A HREF="../../../../org/jibx/binding/def/IComponent.html" title="interface in org.jibx.binding.def">IComponent</A> <B>buildRef</B>(<A HREF="../../../../org/jibx/binding/def/IContainer.html" title="interface in org.jibx.binding.def">IContainer</A> parent,
<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def">IContextObj</A> objc,
java.lang.String type,
<A HREF="../../../../org/jibx/binding/def/PropertyDefinition.html" title="class in org.jibx.binding.def">PropertyDefinition</A> prop)
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Build reference to mapping. Constructs and returns the component for
handling the mapping.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - containing binding definition structure<DD><CODE>objc</CODE> - current object context<DD><CODE>type</CODE> - mapped value type<DD><CODE>prop</CODE> - property definition (may be <code>null</code>)
<DT><B>Returns:</B><DD>constructed mapping reference component
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if configuration error</DL>
</DD>
</DL>
<HR>
<A NAME="generateCode(boolean)"><!-- --></A><H3>
generateCode</H3>
<PRE>
void <B>generateCode</B>(boolean force)
throws <A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></PRE>
<DL>
<DD>Generate required code for mapping.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>force</CODE> - add marshaller/unmarshaller classes for abstract non-base
mappings flag (not passed on to children)
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</A></CODE> - if error in transformation</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/jibx/binding/def/IContextObj.html" title="interface in org.jibx.binding.def"><B>PREV CLASS</B></A>
<A HREF="../../../../org/jibx/binding/def/LinkableBase.html" title="class in org.jibx.binding.def"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/jibx/binding/def/IMapping.html" target="_top"><B>FRAMES</B></A>
<A HREF="IMapping.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<table width='80%%'><tr><td width='50%%'><p align='center'><a href='http://www.jibx.org/' target='_top'><font size='3'><b>Project Web Site</b></font></a></td><td width='50%%'><p align='center'></td></tr></table>
</BODY>
</HTML>
|
