/usr/share/doc/libjibx1.1-java-doc/details/mapping-element.html is in libjibx1.1-java-doc 1.1.6a-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: <mapping> Element</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: <mapping> Element</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>
<a href="../clean-code.html">Clean code</a>
</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="../sponsors.html">Sponsors</a>
</small>
</div>
<div>
<small>
<a href="../support.html">Support and Training</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 and arrays</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="binding-overview.html">Definition details</a>
</small>
<div>
<small>
<a href="contexts.html">Definition contexts</a>
</small>
</div>
<div>
<small>
<a href="conversions.html">Conversions</a>
</small>
</div>
<div>
<small>
<a href="xml-summary.html">XML summary</a>
</small>
</div>
<div>
<small>
<a href="binding-element.html"><binding> element</a>
</small>
</div>
<div>
<small>
<a href="include-element.html"><include> element</a>
</small>
</div>
<div>
<small>
<a href="format-element.html"><format> element</a>
</small>
</div>
<div>
<small>
<a href="namespace-element.html"><namespace> element</a>
</small>
</div>
<div>
<small>
<span class="menu-selection"><mapping> element</span>
</small>
</div>
<div>
<small>
<a href="value-element.html"><value> element</a>
</small>
</div>
<div>
<small>
<a href="structure-element.html"><structure> element</a>
</small>
</div>
<div>
<small>
<a href="collection-element.html"><collection> element</a>
</small>
</div>
<div>
<small>
<a href="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="../jibxtools/index.html">Generator Tools</a>
</small>
</div>
<div>
<small>
<a href="../axis2/index.html">Axis2 Usage</a>
</small>
</div>
<div>
<small>
<a href="../jibxsoap/index.html">JibxSoap</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="intro"><mapping> Element Definition</a></h3>
<p>The <b>mapping</b> element defines the binding used for an object type
(instances of a particular class) within a context. A normal (or "concrete")
mapping links an object type to a particular XML element. This linkage means
that only one concrete mapping can be active (in context) for a particular Java
class at a time, and the element names used for concrete mappings within a
context must be unique. Only concrete mappings defined as children of the root
<b>binding</b> element can represent the root object for a marshalling or the
root element for an unmarshalling.</p>
<p>An abstract mapping defines a reusable XML representation for an object
type, with the actual element name defined at the point of use. This makes
abstract mappings roughly equivalent to schema named complex types. Unlike
schema complex types, it's also possible to use abstract mappings without an
element name (so that the mapping defines a grouping of attributes and or
elements that are incorporated directly into the structure at the point of
reference). Multiple abstract mappings can be defined for the same object type
within a context, as long as different <b>type-name</b>s are used for the
mappings.</p>
<p>Both abstract and normal mappings can be used as bases for extension
mappings. Extension mappings provide an easy way of handling polymorphism in
your Java code, using the equivalent of schema substitution groups. A base
mapping can be extended by one or more other mappings using the <b>extends</b>
attribute, and the extension mappings can then be used anywhere the base
mapping is referenced within the binding. When marshalling, JiBX interprets the
actual type of the object to find the appropriate extension mapping. When
unmarshalling, JiBX uses the actual element name found to identify the extension
mapping.</p>
<p>Although an abstract mapping can be used as the base for extension mappings,
an abstract mapping can only extend another mapping if the abstract extension is
in turn extended. This restriction is required because element names are used to
identify the particular extension mapping used when unmarshalling, and abstract
mappings have no fixed element name. It means that abstract mappings can never
be the "leaf" mappings in an extension structure.</p>
<p>Mappings may use ordered child definitions (where the XML components
bound to the child definitions occur in a particular sequence) or unordered
definitions (where the XML components can occur in any order), as determined by the <b>ordered</b> attribute of the
<a href="binding-attributes.html#structure">structure attribute group</a>. In
the case of unordered mappings only optional components are allowed as
child definitions.</p>
<p>Mapping definitions can be nested, so that the enclosed mapping definitions
are only effective within the scope of the enclosing definition. This approach
is fine for abstract mappings, but if used for non-abstract mappings it can have
a negative impact on performance. JiBX 2.0 will prohibit nesting of non-abstract
mappings, so it's best to structure your binding definitions with all
non-abstract mappings as direct children of the root element.</p>
<p>The <b>mapping</b> element supports three unique attributes along with
several common attribute groups, listed below.</p>
<h4><a name="Attributes">Attributes</a></h4>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<td>class</td>
<td><p>This required attribute gives the fully qualified class name for the
object type handled by this mapping.</p></td>
</tr>
<tr class="a">
<td>abstract</td>
<td><p>Optional flag for an abstract mapping that can be used directly as a type
mapping. This must be
"true" (abstract mapping) or "false" (normal mapping, the
default if the attribute is not specified).</p></td>
</tr>
<tr class="b">
<td>extends</td>
<td><p>Optional attribute giving the fully qualified class name of a base
mapping for which this mapping can be substituted. Generally this is used with
mappings for classes which are subclasses of the class handled by the base
mapping, but it can be also be used with unrelated classes. The base mapping
may itself extend another mapping, in which case the new extensions also become
substitutes for that "inherited" base mapping. Extension is based on element
names and does not necessarily indicate any kind of inheritance in terms of the
Java class structures (though it is often used for the purpose of representing
in XML a tree of subclasses which can be used as instances of a base type).</p>
</td>
</tr>
<tr class="a">
<td>type-name</td>
<td><p>Optional attribute giving the type name for an abstract mapping. This
allows alternative abstract mappings to be defined for the same class, and
referenced by name with a <b>map-as</b> attribute on a <b>structure</b>
element (or looked up at runtime when <b>force-classes="true"</b> is used on the
<b>binding</b> element). As of JiBX 1.1, the value of this attribute is
interpreted as namespace qualified.</p></td>
</tr>
<tr class="b">
<td><a href="binding-attributes.html#style">style</a></td>
<td><p>A <b>value-style</b> attribute present on the <b>mapping</b> element sets a
default for all contained elements. See the <a
href="binding-attributes.html#style">style attribute group</a> description
for usage details.</p></td>
</tr>
<tr class="a">
<td><a href="binding-attributes.html#name">name</a></td>
<td><p>Attributes from the name group define an element mapped to the object
type handled by this mapping. The name is required on non-abstract mappings
unless a custom marshaller/unmarshaller is supplied (see the <b>object</b>
attribute group, below), in which case it is optional. Abstract mappings should
not define a name, but are currently allowed to do so with a warning for support
of legacy bindings. See the <a href="binding-attributes.html#name">name attribute
group</a> description for name usage details.</p></td>
</tr>
<tr class="b">
<td><a href="binding-attributes.html#object">object</a></td>
<td><p>Attributes from the object group define the way object instances are
created and used in marshalling and unmarshalling. See the <a
href="binding-attributes.html#object">object attribute group</a> description
for usage details.</p></td>
</tr>
<tr class="a">
<td><a href="binding-attributes.html#structure">structure</a></td>
<td><p>Attributes from the structure group define ordering and reuse of
child binding components. See the
<a href="binding-attributes.html#structure">structure attribute group</a>
description for usage details.</p></td>
</tr>
</table>
<p><b>mapping</b> elements are subject to the restriction that multiple mappings
with the same object type cannot be defined in the same context.</p>
</div>
</div>
</div>
</td>
</tr>
</tbody>
</table>
<div id="footer">
<table border="0" cellspacing="0" cellpadding="4">
<tbody>
<tr>
<td> © 2003-2008, 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>
|