/usr/share/doc/libjibx1.1-java-doc/details/collection-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 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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>JiBX: <collection> 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: <collection> 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>
<a href="mapping-element.html"><mapping> element</a>
</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>
<span class="menu-selection"><collection> element</span>
</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"><collection> Element Definition</a></h3>
<p>The <b>collection</b> element defines the binding for a Java collection.
Many variations of list-like collections are supported, including user-defined
collection types. Arrays are also supported. Maps are not supported directly in
JiBX 1.0 (but see the <a href="../extras.html">JiBX extras</a> description for
custom marshaller/unmarshaller classes which can help with this types of
structures).</p>
<p>Collections may consist of a single type of object or multiple types. The simplest
form of collection just uses a single mapped item type. This may either be
defined using the <b>item-type</b> attribute, in which case no child definitions
are necessary, or implied by the absence of child definitions (equivalent to using
<b>item-type="java.lang.Object"</b>).</p>
<p>Collections consisting of multiple types are defined using multiple child
definitions within the <b>collection</b> element. These may be ordered
(where the different types occur in a particular sequence) or unordered (where
all are mixed together), as determined by the <b>ordered</b> attribute of the
<a href="binding-attributes.html#structure">structure attribute group</a>. Child
definitions within collections must define elements rather than text or
attribute values (though the elements defined may themselves have attributes
and/or text values). Child definitions within collections are always treated as
optional, with any number of occurrances of the corresponding element allowed
(zero or more).</p>
<p>The <b>collection</b> element supports several unique attributes along with
several common attribute groups, listed below. The unique attributes are used for
special types of data access to the collection. These are all optional, and have
defaults for common collection types, including <code>java.util.Vector</code> and
<code>java.util.ArrayList</code> (as well as subclasses of these classes) along
with collection classes implementing the <code>java.util.Collection</code>
interface. You can use these attributes to select methods of the containing
object for accessing data within a collection (with no property definition for
the actual collection object).</p>
<p>One potential issue in working with collections is that JiBX generally needs
a way to create an instance of the collection when unmarshalling. If the
collection is defined using an interface such as <code>java.util.List</code>
you'll need to either define a concrete implementation type with a no-argument
constructor to be used for the collection (using the <b>type</b> attribute of
the <a href="binding-attributes.html#property">property attribute group</a>)
or use the <b>factory</b> attribute of the <a
href="binding-attributes.html#object">object attribute group</a> to define a
factory method to call when an instance of the collection is needed. The
<code>org.jibx.runtime.Utility.arrayListFactory</code> is an example of such a
factory method, which can be used directly to supply instances of the
<code>java.util.ArrayList</code> class.</p>
<p>As with all object-valued properties, if the collection property is already
initialized when JiBX begins unmarshalling the existing collection instance will
be used to hold the unmarshalled items of the collection. JiBX does not clear
items from the existing collection before unmarshalling, so if you want to reuse
existing data structures with a collection you should clear the collection
yourself before unmarshalling (one easy way of doing this is with a pre-set
method on the containing object class). This is only necessary when reusing
objects, not when unmarshalling to a new instance of an object (where any
collections created by the object constructor will initially be empty in any
case). If an element name is used with an optional collection, and that name is
missing from an input XML document, the collection property will be set to
<code>null</code>. If you don't want the collection property to ever be set to
<code>null</code>, use a wrapper <b>structure</b> element for the optional
element name around the <b>collection</b> element.</p>
<h4><a name="Attributes">Attributes</a></h4>
<table cellpadding="3" cellspacing="2" border="1" width="100%">
<tr class="b">
<td>load-method</td>
<td><p>This is an indexed load item method for the collection. If used, the value must
be the name of a member method of the collection class taking a single
<code>int</code> argument and returning the indexed item value from the
collection (which must be an instance of <code>java.lang.Object</code> unless
the <b>item-type</b> attribute is used to specify the type of items in the
collection). This attribute is only allowed in combination with
<b>size-method</b>. The generated code will use the specified method for loading
values from the collection when marshalling.</p></td>
</tr>
<tr class="a">
<td>size-method</td>
<td><p>This is an item count method for the collection. If used, the value must
be the name of a no-argument member method of the collection class returning an
<code>int</code> value giving the number of items in the collection. This
attribute is only allowed in combination with <b>load-method</b>. The generated
code will use the specified method for finding the count of items present in the
collection when marshalling.</p></td>
</tr>
<tr class="b">
<td>store-method</td>
<td><p>This is an indexed store item method for the collection. If used, the value must
be the name of a member method of the collection class taking an <code>int</code>
argument and a <code>java.lang.Object</code> argument (or the type given by the
<b>item-type</b> attribute, if present), with no return value. The
generated code will use the specified method for storing values to the collection
when unmarshalling.</b>.</p></td>
</tr>
<tr class="a">
<td>add-method</td>
<td><p>This is an append item method for the collection. If used, the value must
be the name of a member method of the collection class taking a single
<code>java.lang.Object</code> argument (or the type given by the
<b>item-type</b> attribute, if present). Any return value from the method is
ignored. The generated code will use the specified method to append values to
the collection when unmarshalling.</b>.</p></td>
</tr>
<tr class="b">
<td>iter-method</td>
<td><p>This is an iterator method for the collection. If used, the value must
be the name of a member method of the collection class taking no arguments and
returning a <code>java.lang.Iterator</code> or <code>java.lang.Enumeration</code>
object for the items in the collection. The generated code will use the specified
method to iterate through the values in the collection when marshalling.</p></td>
</tr>
<tr class="a">
<td>item-type</td>
<td><p>If this attribute is used it must be the fully-qualified class name for
items contained in the collection. If the specified type is an interface or a
class with subclasses any of the implementations of that type can be
used in the collection. The default is <code>java.lang.Object</code>,
allowing any type of objects to be present in the collection.</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>collection</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 collection
as a whole. The element defined in this way will be a wrapper for the XML
representations of all item values from the collection. The name is optional
unless a marshaller or unmarshaller is defined (see the <b>object</b> attribute
group, below), in which case it's forbidden. See the <a
href="binding-attributes.html#name">name attribute group</a> description
for 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 the collection object is
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#property">property</a></td>
<td><p>Attributes from the property group define a property value, including how
it is accessed and whether it is optional or required. See the <a
href="binding-attributes.html#property">property attribute group description</a>
for usage details.</p></td>
</tr>
<tr class="b">
<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>
</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>
|