ServiceImplementation/hibernate-mapping-3.0.dtd

   1 <!-- Hibernate Mapping DTD.
   2
   3 <!DOCTYPE hibernate-mapping PUBLIC
   4     "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
   5     "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
   6
   7 An instance of this XML document may contain mappings for an arbitrary
   8 number of classes. The class mappings may contain associations to classes
   9 mapped in the same document or in another document. No class may be
  10 mapped more than once. Each document may also contain definitions of an
  11 arbitrary number of queries, and import declarations of arbitrary classes.
  12
  13 -->
  14
  15 <!--
  16         The document root.
  17  -->
  18
  19 <!ELEMENT hibernate-mapping (
  20         meta*,
  21         typedef*,
  22         import*,
  23         (class|subclass|joined-subclass|union-subclass)*,
  24     resultset*,
  25         (query|sql-query)*,
  26         filter-def*,
  27     database-object*
  28 )>
  29         <!ATTLIST hibernate-mapping schema CDATA #IMPLIED>                                                                      <!-- default: none -->
  30         <!ATTLIST hibernate-mapping catalog CDATA #IMPLIED>                                                                     <!-- default: none -->
  31         <!ATTLIST hibernate-mapping default-cascade CDATA "none">
  32         <!ATTLIST hibernate-mapping default-access CDATA "property">
  33         <!ATTLIST hibernate-mapping default-lazy (true|false) "true">
  34         <!ATTLIST hibernate-mapping auto-import (true|false) "true">
  35         <!ATTLIST hibernate-mapping package CDATA #IMPLIED>                                                                     <!-- default: none -->
  36
  37 <!--
  38         META element definition; used to assign meta-level attributes to a class
  39         or property.  Is currently used by codegenerator as a placeholder for
  40         values that is not directly related to OR mappings.
  41 -->
  42 <!ELEMENT meta (#PCDATA)>
  43         <!ATTLIST meta attribute CDATA #REQUIRED>
  44         <!ATTLIST meta inherit (true|false) "true">
  45
  46 <!--
  47         TYPEDEF element definition; defines a new name for a Hibernate type. May
  48         contain parameters for parameterizable types.
  49 -->
  50 <!ELEMENT typedef (param*)>
  51         <!ATTLIST typedef class CDATA #REQUIRED>
  52         <!ATTLIST typedef name CDATA #REQUIRED>
  53
  54 <!--
  55         IMPORT element definition; an explicit query language "import"
  56 -->
  57 <!ELEMENT import EMPTY>
  58         <!ATTLIST import class CDATA #REQUIRED>
  59         <!ATTLIST import rename CDATA #IMPLIED> <!-- default: unqualified class name -->
  60
  61 <!--
  62         Root entity mapping.  Poorly named as entities do not have to be represented by
  63         classes at all.  Mapped entities may be represented via different methodologies
  64         (POJO, Map, Dom4j).
  65 -->
  66 <!ELEMENT class (
  67         meta*,
  68         subselect?,
  69         cache?,
  70         synchronize*,
  71         comment?,
  72     tuplizer*,
  73         (id|composite-id),
  74         discriminator?,
  75         natural-id?,
  76         (version|timestamp)?,
  77         (property|many-to-one|one-to-one|component|dynamic-component|properties|any|map|set|list|bag|idbag|array|primitive-array)*,
  78         ((join*,subclass*)|joined-subclass*|union-subclass*),
  79         loader?,sql-insert?,sql-update?,sql-delete?,
  80         filter*,
  81     resultset*,
  82         (query|sql-query)*
  83 )>
  84         <!ATTLIST class entity-name CDATA #IMPLIED>
  85         <!ATTLIST class name CDATA #IMPLIED>                            <!-- this is the class name -->
  86         <!ATTLIST class proxy CDATA #IMPLIED>                                                   <!-- default: no proxy interface -->
  87         <!ATTLIST class lazy (true|false) #IMPLIED>
  88         <!ATTLIST class table CDATA #IMPLIED>                                                   <!-- default: unqualified classname -->
  89         <!ATTLIST class schema CDATA #IMPLIED>                                                  <!-- default: none -->
  90         <!ATTLIST class catalog CDATA #IMPLIED>                                                 <!-- default: none -->
  91         <!ATTLIST class subselect CDATA #IMPLIED>
  92         <!ATTLIST class discriminator-value CDATA #IMPLIED>                             <!-- default: unqualified class name | none -->
  93         <!ATTLIST class mutable (true|false) "true">
  94         <!ATTLIST class abstract (true|false) #IMPLIED>
  95         <!ATTLIST class polymorphism (implicit|explicit) "implicit">
  96         <!ATTLIST class where CDATA #IMPLIED>                                                   <!-- default: none -->
  97         <!ATTLIST class persister CDATA #IMPLIED>
  98         <!ATTLIST class dynamic-update (true|false) "false">
  99         <!ATTLIST class dynamic-insert (true|false) "false">
 100         <!ATTLIST class batch-size CDATA #IMPLIED>
 101         <!ATTLIST class select-before-update (true|false) "false">
 102         <!ATTLIST class optimistic-lock (none|version|dirty|all) "version">
 103         <!ATTLIST class check CDATA #IMPLIED>                                                   <!-- default: none -->
 104         <!ATTLIST class rowid CDATA #IMPLIED>
 105         <!ATTLIST class node CDATA #IMPLIED>
 106
 107 <!--
 108     TUPLIZER element; defines tuplizer to use for a component/entity for a given entity-mode
 109 -->
 110 <!ELEMENT tuplizer EMPTY>
 111     <!ATTLIST tuplizer entity-mode (pojo|dom4j|dynamic-map) #IMPLIED>   <!-- entity mode for which tuplizer is in effect -->
 112     <!ATTLIST tuplizer class CDATA #REQUIRED>                           <!-- the tuplizer class to use -->
 113
 114 <!--
 115         FILTER-DEF element; top-level filter definition.
 116 -->
 117 <!ELEMENT filter-def (#PCDATA|filter-param)*>
 118         <!ATTLIST filter-def name CDATA #REQUIRED> <!-- The filter name -->
 119         <!ATTLIST filter-def condition CDATA #IMPLIED>
 120
 121 <!--
 122         FILTER-PARAM element; qualifies parameters found within a FILTER-DEF
 123         condition.
 124 -->
 125 <!ELEMENT filter-param EMPTY>
 126         <!ATTLIST filter-param name CDATA #REQUIRED> <!-- The parameter name -->
 127         <!ATTLIST filter-param type CDATA #REQUIRED> <!-- The parameter type -->
 128
 129 <!--
 130         FILTER element; used to apply a filter.
 131 -->
 132 <!ELEMENT filter (#PCDATA)>
 133         <!ATTLIST filter name CDATA #REQUIRED>
 134         <!ATTLIST filter condition CDATA #IMPLIED>
 135
 136
 137 <!-- A join allows some properties of a class to be persisted to a second table -->
 138
 139 <!ELEMENT join (
 140         subselect?,
 141         comment?,
 142         key,
 143         (property|many-to-one|component|dynamic-component|any)*,
 144         sql-insert?,sql-update?,sql-delete?
 145 )>
 146         <!ATTLIST join table CDATA #REQUIRED>
 147         <!ATTLIST join schema CDATA #IMPLIED>                                           <!-- default: none -->
 148         <!ATTLIST join catalog CDATA #IMPLIED>                                          <!-- default: none -->
 149         <!ATTLIST join subselect CDATA #IMPLIED>
 150         <!ATTLIST join fetch (join|select) "join">
 151         <!ATTLIST join inverse (true|false) "false">
 152         <!ATTLIST join optional (true|false) "false">
 153
 154 <!-- A natural-id element allows declaration of the unique business key -->
 155
 156 <!ELEMENT natural-id ( (property|many-to-one|component|dynamic-component|any)* )>
 157         <!ATTLIST natural-id mutable (true|false) "false">
 158
 159 <!-- Declares the id type, column and generation algorithm for an entity class.
 160 If a name attribut is given, the id is exposed to the application through the
 161 named property of the class. If not, the id is only exposed to the application
 162 via Session.getIdentifier() -->
 163
 164 <!ELEMENT id (meta*,column*,type?,generator?)>
 165         <!ATTLIST id name CDATA #IMPLIED>
 166         <!ATTLIST id node CDATA #IMPLIED>
 167         <!ATTLIST id access CDATA #IMPLIED>
 168         <!ATTLIST id column CDATA #IMPLIED>
 169         <!ATTLIST id type CDATA #IMPLIED>
 170         <!ATTLIST id length CDATA #IMPLIED>
 171         <!ATTLIST id unsaved-value CDATA #IMPLIED>                                      <!-- any|none|null|undefined|0|-1|... -->
 172
 173 <!-- A composite key may be modelled by a java class with a property for each
 174 key column. The class must implement java.io.Serializable and reimplement equals()
 175 and hashCode(). -->
 176
 177 <!ELEMENT composite-id ( meta*, (key-property|key-many-to-one)+ )>
 178         <!ATTLIST composite-id class CDATA #IMPLIED>
 179         <!ATTLIST composite-id mapped (true|false) "false">
 180         <!ATTLIST composite-id name CDATA #IMPLIED>
 181         <!ATTLIST composite-id node CDATA #IMPLIED>
 182         <!ATTLIST composite-id access CDATA #IMPLIED>
 183         <!ATTLIST composite-id unsaved-value (undefined|any|none) "undefined">
 184
 185 <!-- Polymorphic data requires a column holding a class discriminator value. This
 186 value is not directly exposed to the application. -->
 187
 188 <!ELEMENT discriminator ((column|formula)?)>
 189         <!ATTLIST discriminator column CDATA #IMPLIED>                          <!-- default: "class"|none -->
 190         <!ATTLIST discriminator formula CDATA #IMPLIED>
 191         <!ATTLIST discriminator type CDATA "string">
 192         <!ATTLIST discriminator not-null (true|false) "true">
 193         <!ATTLIST discriminator length CDATA #IMPLIED>
 194         <!ATTLIST discriminator force (true|false) "false">
 195         <!ATTLIST discriminator insert (true|false) "true">
 196
 197 <!-- Versioned data requires a column holding a version number. This is exposed to the
 198 application through a property of the Java class. -->
 199
 200 <!ELEMENT version (meta*,column*)>
 201         <!ATTLIST version name CDATA #REQUIRED>
 202         <!ATTLIST version node CDATA #IMPLIED>
 203         <!ATTLIST version access CDATA #IMPLIED>
 204         <!ATTLIST version column CDATA #IMPLIED>
 205         <!ATTLIST version type CDATA "integer">
 206         <!ATTLIST version unsaved-value (null|negative|undefined) "undefined">
 207     <!ATTLIST version generated (never|always) "never">
 208     <!ATTLIST version insert (true|false) #IMPLIED>
 209
 210 <!ELEMENT timestamp (meta*)>
 211         <!ATTLIST timestamp name CDATA #REQUIRED>
 212         <!ATTLIST timestamp node CDATA #IMPLIED>
 213         <!ATTLIST timestamp column CDATA #IMPLIED>
 214         <!ATTLIST timestamp access CDATA #IMPLIED>
 215         <!ATTLIST timestamp unsaved-value (null|undefined) "null">
 216     <!ATTLIST timestamp source (vm|db) "vm">
 217     <!ATTLIST timestamp generated (never|always) "never">
 218
 219
 220 <!--
 221         Subclass declarations are nested beneath the root class declaration to achieve
 222         polymorphic persistence with the table-per-hierarchy mapping strategy.
 223
 224         See the note on the class element regarding <pojo/> vs. @name usage...
 225 -->
 226 <!ELEMENT subclass (
 227         meta*,
 228     tuplizer*,
 229         synchronize*,
 230         (property|many-to-one|one-to-one|component|dynamic-component|any|map|set|list|bag|idbag|array|primitive-array)*,
 231         join*,
 232         subclass*,
 233         loader?,sql-insert?,sql-update?,sql-delete?,
 234     resultset*,
 235         (query|sql-query)*
 236 )>
 237         <!ATTLIST subclass entity-name CDATA #IMPLIED>
 238         <!ATTLIST subclass name CDATA #IMPLIED>
 239         <!ATTLIST subclass proxy CDATA #IMPLIED>                                                        <!-- default: no proxy interface -->
 240         <!ATTLIST subclass discriminator-value CDATA #IMPLIED>                          <!-- default: unqualified class name | none -->
 241         <!ATTLIST subclass dynamic-update (true|false) "false">
 242         <!ATTLIST subclass dynamic-insert (true|false) "false">
 243         <!ATTLIST subclass select-before-update (true|false) "false">
 244         <!ATTLIST subclass extends CDATA #IMPLIED>                                                      <!-- default: empty when a toplevel, otherwise the nearest class definition -->
 245         <!ATTLIST subclass lazy (true|false) #IMPLIED>
 246         <!ATTLIST subclass abstract (true|false) #IMPLIED>
 247         <!ATTLIST subclass persister CDATA #IMPLIED>
 248         <!ATTLIST subclass batch-size CDATA #IMPLIED>
 249         <!ATTLIST subclass node CDATA #IMPLIED>
 250
 251 <!--
 252         Joined subclasses are used for the normalized table-per-subclass mapping strategy
 253
 254         See the note on the class element regarding <pojo/> vs. @name usage...
 255 -->
 256 <!ELEMENT joined-subclass (
 257         meta*,
 258         subselect?,
 259         synchronize*,
 260         comment?,
 261     tuplizer*,
 262         key,
 263         (property|many-to-one|one-to-one|component|dynamic-component|properties|any|map|set|list|bag|idbag|array|primitive-array)*,
 264         joined-subclass*,
 265         loader?,sql-insert?,sql-update?,sql-delete?,
 266     resultset*,
 267         (query|sql-query)*
 268 )>
 269         <!ATTLIST joined-subclass entity-name CDATA #IMPLIED>
 270         <!ATTLIST joined-subclass name CDATA #IMPLIED>
 271         <!ATTLIST joined-subclass proxy CDATA #IMPLIED>                                         <!-- default: no proxy interface -->
 272         <!ATTLIST joined-subclass table CDATA #IMPLIED>                                         <!-- default: unqualified class name -->
 273         <!ATTLIST joined-subclass schema CDATA #IMPLIED>
 274         <!ATTLIST joined-subclass catalog CDATA #IMPLIED>
 275         <!ATTLIST joined-subclass subselect CDATA #IMPLIED>
 276         <!ATTLIST joined-subclass dynamic-update (true|false) "false">
 277         <!ATTLIST joined-subclass dynamic-insert (true|false) "false">
 278         <!ATTLIST joined-subclass select-before-update (true|false) "false">
 279         <!ATTLIST joined-subclass extends CDATA #IMPLIED>                                       <!-- default: none when toplevel, otherwise the nearest class definition -->
 280         <!ATTLIST joined-subclass lazy (true|false) #IMPLIED>
 281         <!ATTLIST joined-subclass abstract (true|false) #IMPLIED>
 282         <!ATTLIST joined-subclass persister CDATA #IMPLIED>
 283         <!ATTLIST joined-subclass check CDATA #IMPLIED>                                         <!-- default: none -->
 284         <!ATTLIST joined-subclass batch-size CDATA #IMPLIED>
 285         <!ATTLIST joined-subclass node CDATA #IMPLIED>
 286
 287 <!--
 288         Union subclasses are used for the table-per-concrete-class mapping strategy
 289
 290         See the note on the class element regarding <pojo/> vs. @name usage...
 291 -->
 292 <!ELEMENT union-subclass (
 293         meta*,
 294         subselect?,
 295         synchronize*,
 296         comment?,
 297     tuplizer*,
 298         (property|many-to-one|one-to-one|component|dynamic-component|properties|any|map|set|list|bag|idbag|array|primitive-array)*,
 299         union-subclass*,
 300         loader?,sql-insert?,sql-update?,sql-delete?,
 301     resultset*,
 302         (query|sql-query)*
 303 )>
 304         <!ATTLIST union-subclass entity-name CDATA #IMPLIED>
 305         <!ATTLIST union-subclass name CDATA #IMPLIED>
 306         <!ATTLIST union-subclass proxy CDATA #IMPLIED>                                          <!-- default: no proxy interface -->
 307         <!ATTLIST union-subclass table CDATA #IMPLIED>                                          <!-- default: unqualified class name -->
 308         <!ATTLIST union-subclass schema CDATA #IMPLIED>
 309         <!ATTLIST union-subclass catalog CDATA #IMPLIED>
 310         <!ATTLIST union-subclass subselect CDATA #IMPLIED>
 311         <!ATTLIST union-subclass dynamic-update (true|false) "false">
 312         <!ATTLIST union-subclass dynamic-insert (true|false) "false">
 313         <!ATTLIST union-subclass select-before-update (true|false) "false">
 314         <!ATTLIST union-subclass extends CDATA #IMPLIED>                                        <!-- default: none when toplevel, otherwise the nearest class definition -->
 315         <!ATTLIST union-subclass lazy (true|false) #IMPLIED>
 316         <!ATTLIST union-subclass abstract (true|false) #IMPLIED>
 317         <!ATTLIST union-subclass persister CDATA #IMPLIED>
 318         <!ATTLIST union-subclass check CDATA #IMPLIED>                                          <!-- default: none -->
 319         <!ATTLIST union-subclass batch-size CDATA #IMPLIED>
 320         <!ATTLIST union-subclass node CDATA #IMPLIED>
 321
 322 <!-- Property of an entity class or component, component-element, composite-id, etc.
 323 JavaBeans style properties are mapped to table columns. -->
 324
 325 <!ELEMENT property (meta*,(column|formula)*,type?)>
 326         <!ATTLIST property name CDATA #REQUIRED>
 327         <!ATTLIST property node CDATA #IMPLIED>
 328         <!ATTLIST property access CDATA #IMPLIED>
 329         <!ATTLIST property type CDATA #IMPLIED>
 330         <!ATTLIST property column CDATA #IMPLIED>
 331         <!ATTLIST property length CDATA #IMPLIED>
 332         <!ATTLIST property precision CDATA #IMPLIED>
 333         <!ATTLIST property scale CDATA #IMPLIED>
 334         <!ATTLIST property not-null (true|false) #IMPLIED>
 335         <!ATTLIST property unique (true|false) "false">
 336         <!ATTLIST property unique-key CDATA #IMPLIED>
 337         <!ATTLIST property index CDATA #IMPLIED>                                <!-- include the columns spanned by this property in an index -->
 338         <!ATTLIST property update (true|false) #IMPLIED>
 339         <!ATTLIST property insert (true|false) #IMPLIED>
 340         <!ATTLIST property optimistic-lock (true|false) "true"> <!-- only supported for properties of a class (not component) -->
 341         <!ATTLIST property formula CDATA #IMPLIED>
 342         <!ATTLIST property lazy (true|false) "false">
 343     <!ATTLIST property generated (never|insert|always) "never">
 344
 345 <!-- Declares the type of the containing property (overrides an eventually existing type
 346 attribute of the property). May contain param elements to customize a ParametrizableType. -->
 347 <!ELEMENT type (param*)>
 348         <!ATTLIST type name CDATA #REQUIRED>
 349
 350 <!-- Declares an association between two entities (Or from a component, component element,
 351 etc. to an entity). -->
 352
 353 <!ELEMENT many-to-one (meta*,(column|formula)*)>
 354         <!ATTLIST many-to-one name CDATA #REQUIRED>
 355         <!ATTLIST many-to-one access CDATA #IMPLIED>
 356         <!ATTLIST many-to-one class CDATA #IMPLIED>
 357         <!ATTLIST many-to-one entity-name CDATA #IMPLIED>
 358         <!ATTLIST many-to-one column CDATA #IMPLIED>
 359         <!ATTLIST many-to-one not-null (true|false) #IMPLIED>
 360         <!ATTLIST many-to-one unique (true|false) "false">
 361         <!ATTLIST many-to-one unique-key CDATA #IMPLIED>
 362         <!ATTLIST many-to-one index CDATA #IMPLIED>
 363         <!ATTLIST many-to-one cascade CDATA #IMPLIED>
 364         <!ATTLIST many-to-one outer-join (true|false|auto) #IMPLIED>
 365         <!ATTLIST many-to-one fetch (join|select) #IMPLIED>
 366         <!ATTLIST many-to-one update (true|false) "true">
 367         <!ATTLIST many-to-one insert (true|false) "true">
 368         <!ATTLIST many-to-one optimistic-lock (true|false) "true">      <!-- only supported for properties of a class (not component) -->
 369         <!ATTLIST many-to-one foreign-key CDATA #IMPLIED>
 370         <!ATTLIST many-to-one property-ref CDATA #IMPLIED>
 371         <!ATTLIST many-to-one formula CDATA #IMPLIED>
 372         <!ATTLIST many-to-one lazy (false|proxy|no-proxy) #IMPLIED>
 373         <!ATTLIST many-to-one not-found (exception|ignore) "exception">
 374         <!ATTLIST many-to-one node CDATA #IMPLIED>
 375         <!ATTLIST many-to-one embed-xml (true|false) "true">
 376
 377 <!-- Declares a one-to-one association between two entities (Or from a component,
 378 component element, etc. to an entity). -->
 379
 380 <!ELEMENT one-to-one (meta*|formula*)>
 381         <!ATTLIST one-to-one name CDATA #REQUIRED>
 382         <!ATTLIST one-to-one formula CDATA #IMPLIED>
 383         <!ATTLIST one-to-one access CDATA #IMPLIED>
 384         <!ATTLIST one-to-one class CDATA #IMPLIED>
 385         <!ATTLIST one-to-one entity-name CDATA #IMPLIED>
 386         <!ATTLIST one-to-one cascade CDATA #IMPLIED>
 387         <!ATTLIST one-to-one outer-join (true|false|auto) #IMPLIED>
 388         <!ATTLIST one-to-one fetch (join|select) #IMPLIED>
 389         <!ATTLIST one-to-one constrained (true|false) "false">
 390         <!ATTLIST one-to-one foreign-key CDATA #IMPLIED>
 391         <!ATTLIST one-to-one property-ref CDATA #IMPLIED>
 392         <!ATTLIST one-to-one lazy (false|proxy|no-proxy) #IMPLIED>
 393         <!ATTLIST one-to-one node CDATA #IMPLIED>
 394         <!ATTLIST one-to-one embed-xml (true|false) "true">
 395
 396 <!-- A property embedded in a composite identifier or map index (always not-null). -->
 397
 398 <!ELEMENT key-property (meta*,column*,type?)>
 399         <!ATTLIST key-property name CDATA #REQUIRED>
 400         <!ATTLIST key-property access CDATA #IMPLIED>
 401         <!ATTLIST key-property type CDATA #IMPLIED>
 402         <!ATTLIST key-property column CDATA #IMPLIED>
 403         <!ATTLIST key-property length CDATA #IMPLIED>
 404         <!ATTLIST key-property node CDATA #IMPLIED>
 405
 406 <!-- A many-to-one association embedded in a composite identifier or map index
 407 (always not-null, never cascade). -->
 408
 409 <!ELEMENT key-many-to-one (meta*,column*)>
 410         <!ATTLIST key-many-to-one name CDATA #REQUIRED>
 411         <!ATTLIST key-many-to-one access CDATA #IMPLIED>
 412         <!ATTLIST key-many-to-one class CDATA #IMPLIED>
 413         <!ATTLIST key-many-to-one entity-name CDATA #IMPLIED>
 414         <!ATTLIST key-many-to-one column CDATA #IMPLIED>
 415         <!ATTLIST key-many-to-one foreign-key CDATA #IMPLIED>
 416         <!ATTLIST key-many-to-one lazy (false|proxy) #IMPLIED>
 417
 418 <!-- An "any" association is a polymorphic association to any table with
 419 the given identifier type. The first listed column is a VARCHAR column
 420 holding the name of the class (for that row). -->
 421
 422 <!ELEMENT any (meta*,meta-value*,column,column+)>
 423         <!ATTLIST any id-type CDATA #REQUIRED>
 424         <!ATTLIST any meta-type CDATA #IMPLIED>                         <!--- default: Hibernate.STRING -->
 425         <!ATTLIST any name CDATA #REQUIRED>
 426         <!ATTLIST any access CDATA #IMPLIED>
 427         <!ATTLIST any insert (true|false) "true">
 428         <!ATTLIST any update (true|false) "true">
 429         <!ATTLIST any cascade CDATA #IMPLIED>
 430         <!ATTLIST any index CDATA #IMPLIED>                                     <!-- include the columns spanned by this association in an index -->
 431         <!ATTLIST any optimistic-lock (true|false) "true">      <!-- only supported for properties of a class (not component) -->
 432         <!ATTLIST any lazy (true|false) "false">
 433         <!ATTLIST any node CDATA #IMPLIED>
 434
 435 <!ELEMENT meta-value EMPTY>
 436         <!ATTLIST meta-value value CDATA #REQUIRED>
 437         <!ATTLIST meta-value class CDATA #REQUIRED>
 438
 439 <!-- A component is a user-defined class, persisted along with its containing entity
 440 to the table of the entity class. JavaBeans style properties of the component are
 441 mapped to columns of the table of the containing entity. A null component reference
 442 is mapped to null values in all columns and vice versa. Components do not support
 443 shared reference semantics. -->
 444
 445 <!ELEMENT component (
 446         meta*,
 447     tuplizer*,
 448         parent?,
 449         (property|many-to-one|one-to-one|component|dynamic-component|any|map|set|list|bag|array|primitive-array)*
 450 )>
 451         <!ATTLIST component class CDATA #IMPLIED>
 452         <!ATTLIST component name CDATA #REQUIRED>
 453         <!ATTLIST component access CDATA #IMPLIED>
 454         <!ATTLIST component unique (true|false) "false">
 455         <!ATTLIST component update (true|false) "true">
 456         <!ATTLIST component insert (true|false) "true">
 457         <!ATTLIST component lazy (true|false) "false">
 458         <!ATTLIST component optimistic-lock (true|false) "true">
 459         <!ATTLIST component node CDATA #IMPLIED>
 460
 461 <!-- A dynamic-component maps columns of the database entity to a java.util.Map
 462 at the Java level -->
 463
 464 <!ELEMENT dynamic-component (
 465         (property|many-to-one|one-to-one|component|dynamic-component|any|map|set|list|bag|array|primitive-array)*
 466 )>
 467         <!ATTLIST dynamic-component name CDATA #REQUIRED>
 468         <!ATTLIST dynamic-component access CDATA #IMPLIED>
 469         <!ATTLIST dynamic-component unique (true|false) "false">
 470         <!ATTLIST dynamic-component update (true|false) "true">
 471         <!ATTLIST dynamic-component insert (true|false) "true">
 472         <!ATTLIST dynamic-component optimistic-lock (true|false) "true">
 473         <!ATTLIST dynamic-component node CDATA #IMPLIED>
 474
 475 <!-- properties declares that the contained properties form an alternate key. The name
 476 attribute allows an alternate key to be used as the target of a property-ref. -->
 477
 478 <!ELEMENT properties (
 479         (property|many-to-one|component|dynamic-component)*
 480 )>
 481         <!ATTLIST properties name CDATA #REQUIRED>
 482         <!ATTLIST properties unique (true|false) "false">
 483         <!ATTLIST properties insert (true|false) "true">
 484         <!ATTLIST properties update (true|false) "true">
 485         <!ATTLIST properties optimistic-lock (true|false) "true">
 486         <!ATTLIST properties node CDATA #IMPLIED>
 487
 488 <!-- The parent element maps a property of the component class as a pointer back to
 489 the owning entity. -->
 490
 491 <!ELEMENT parent EMPTY>
 492         <!ATTLIST parent name CDATA #REQUIRED>
 493
 494 <!-- Collection declarations nested inside a class declaration indicate a foreign key
 495 relationship from the collection table to the enclosing class. -->
 496
 497 <!ELEMENT map (
 498         meta*,
 499         subselect?,
 500         cache?,
 501         synchronize*,
 502         comment?,
 503         key,
 504         (map-key|composite-map-key|map-key-many-to-many|index|composite-index|index-many-to-many|index-many-to-any),
 505         (element|one-to-many|many-to-many|composite-element|many-to-any),
 506         loader?,sql-insert?,sql-update?,sql-delete?,sql-delete-all?,
 507         filter*
 508 )>
 509         <!ATTLIST map name CDATA #REQUIRED>
 510         <!ATTLIST map access CDATA #IMPLIED>
 511         <!ATTLIST map table CDATA #IMPLIED>                                                                                                                             <!-- default: name -->
 512         <!ATTLIST map schema CDATA #IMPLIED>                                                                                                                    <!-- default: none -->
 513         <!ATTLIST map subselect CDATA #IMPLIED>
 514         <!ATTLIST map catalog CDATA #IMPLIED>                                                                                                                   <!-- default: none -->
 515         <!ATTLIST map lazy (true|false|extra) #IMPLIED>
 516         <!ATTLIST map mutable (true|false) "true">
 517         <!ATTLIST map inverse (true|false) "false">
 518         <!ATTLIST map sort CDATA "unsorted">                                                                                                                    <!-- unsorted|natural|"comparator class", default: unsorted -->
 519         <!ATTLIST map cascade CDATA #IMPLIED>
 520         <!ATTLIST map order-by CDATA #IMPLIED>                                                                                                                  <!-- default: none -->
 521         <!ATTLIST map where CDATA #IMPLIED>                                                                                                                             <!-- default: none -->
 522         <!ATTLIST map batch-size CDATA #IMPLIED>
 523         <!ATTLIST map outer-join (true|false|auto) #IMPLIED>
 524         <!ATTLIST map fetch (join|select|subselect) #IMPLIED>
 525         <!ATTLIST map check CDATA #IMPLIED>                                                                                                                             <!-- default: none -->
 526         <!ATTLIST map persister CDATA #IMPLIED>
 527         <!ATTLIST map collection-type CDATA #IMPLIED>
 528         <!ATTLIST map optimistic-lock (true|false) "true">              <!-- only supported for properties of a class (not component) -->
 529         <!ATTLIST map node CDATA #IMPLIED>
 530         <!ATTLIST map embed-xml (true|false) "true">
 531
 532 <!ELEMENT set (
 533         meta*,
 534         subselect?,
 535         cache?,
 536         synchronize*,
 537         comment?,
 538         key,
 539         (element|one-to-many|many-to-many|composite-element|many-to-any),
 540         loader?,sql-insert?,sql-update?,sql-delete?,sql-delete-all?,
 541         filter*
 542 )>
 543         <!ATTLIST set name CDATA #REQUIRED>
 544         <!ATTLIST set access CDATA #IMPLIED>
 545         <!ATTLIST set table CDATA #IMPLIED>                                                                                                                             <!-- default: name -->
 546         <!ATTLIST set schema CDATA #IMPLIED>                                                                                                                    <!-- default: none -->
 547         <!ATTLIST set catalog CDATA #IMPLIED>                                                                                                                   <!-- default: none -->
 548         <!ATTLIST set subselect CDATA #IMPLIED>
 549         <!ATTLIST set lazy (true|false|extra) #IMPLIED>
 550         <!ATTLIST set sort CDATA "unsorted">                                                                                                                    <!-- unsorted|natural|"comparator class" -->
 551         <!ATTLIST set inverse (true|false) "false">
 552         <!ATTLIST set mutable (true|false) "true">
 553         <!ATTLIST set cascade CDATA #IMPLIED>
 554         <!ATTLIST set order-by CDATA #IMPLIED>                                                                                                                  <!-- default: none -->
 555         <!ATTLIST set where CDATA #IMPLIED>                                                                                                                             <!-- default: none -->
 556         <!ATTLIST set batch-size CDATA #IMPLIED>
 557         <!ATTLIST set outer-join (true|false|auto) #IMPLIED>
 558         <!ATTLIST set fetch (join|select|subselect) #IMPLIED>
 559         <!ATTLIST set persister CDATA #IMPLIED>
 560         <!ATTLIST set collection-type CDATA #IMPLIED>
 561         <!ATTLIST set check CDATA #IMPLIED>                                                                                                                             <!-- default: none -->
 562         <!ATTLIST set optimistic-lock (true|false) "true">              <!-- only supported for properties of a class (not component) -->
 563         <!ATTLIST set node CDATA #IMPLIED>
 564         <!ATTLIST set embed-xml (true|false) "true">
 565
 566 <!ELEMENT bag (
 567         meta*,
 568         subselect?,
 569         cache?,
 570         synchronize*,
 571         comment?,
 572         key,
 573         (element|one-to-many|many-to-many|composite-element|many-to-any),
 574         loader?,sql-insert?,sql-update?,sql-delete?,sql-delete-all?,
 575         filter*
 576 )>
 577         <!ATTLIST bag name CDATA #REQUIRED>
 578         <!ATTLIST bag access CDATA #IMPLIED>
 579         <!ATTLIST bag table CDATA #IMPLIED>                                                                                                                             <!-- default: name -->
 580         <!ATTLIST bag schema CDATA #IMPLIED>                                                                                                                    <!-- default: none -->
 581         <!ATTLIST bag catalog CDATA #IMPLIED>                                                                                                                   <!-- default: none -->
 582         <!ATTLIST bag subselect CDATA #IMPLIED>
 583         <!ATTLIST bag lazy (true|false|extra) #IMPLIED>
 584         <!ATTLIST bag inverse (true|false) "false">
 585         <!ATTLIST bag mutable (true|false) "true">
 586         <!ATTLIST bag cascade CDATA #IMPLIED>
 587         <!ATTLIST bag order-by CDATA #IMPLIED>                                                                                                                  <!-- default: none -->
 588         <!ATTLIST bag where CDATA #IMPLIED>                                                                                                                             <!-- default: none -->
 589         <!ATTLIST bag batch-size CDATA #IMPLIED>
 590         <!ATTLIST bag outer-join (true|false|auto) #IMPLIED>
 591         <!ATTLIST bag fetch (join|select|subselect) #IMPLIED>
 592         <!ATTLIST bag persister CDATA #IMPLIED>
 593         <!ATTLIST bag collection-type CDATA #IMPLIED>
 594         <!ATTLIST bag check CDATA #IMPLIED>                                                                                                                             <!-- default: none -->
 595         <!ATTLIST bag optimistic-lock (true|false) "true">              <!-- only supported for properties of a class (not component) -->
 596         <!ATTLIST bag node CDATA #IMPLIED>
 597         <!ATTLIST bag embed-xml (true|false) "true">
 598
 599 <!ELEMENT idbag (
 600         meta*,
 601         subselect?,
 602         cache?,
 603         synchronize*,
 604         comment?,
 605         collection-id,
 606         key,
 607         (element|many-to-many|composite-element|many-to-any),
 608         loader?,sql-insert?,sql-update?,sql-delete?,sql-delete-all?,
 609         filter*
 610 )>
 611         <!ATTLIST idbag name CDATA #REQUIRED>
 612         <!ATTLIST idbag access CDATA #IMPLIED>
 613         <!ATTLIST idbag table CDATA #IMPLIED>                                                                                                                   <!-- default: name -->
 614         <!ATTLIST idbag schema CDATA #IMPLIED>                                                                                                                  <!-- default: none -->
 615         <!ATTLIST idbag catalog CDATA #IMPLIED>                                                                                                                 <!-- default: none -->
 616         <!ATTLIST idbag subselect CDATA #IMPLIED>
 617         <!ATTLIST idbag lazy (true|false|extra) #IMPLIED>
 618         <!ATTLIST idbag mutable (true|false) "true">
 619         <!ATTLIST idbag cascade CDATA #IMPLIED>
 620         <!ATTLIST idbag order-by CDATA #IMPLIED>                                                                                                                <!-- default: none -->
 621         <!ATTLIST idbag where CDATA #IMPLIED>                                                                                                                   <!-- default: none -->
 622         <!ATTLIST idbag batch-size CDATA #IMPLIED>
 623         <!ATTLIST idbag outer-join (true|false|auto) #IMPLIED>
 624         <!ATTLIST idbag fetch (join|select|subselect) #IMPLIED>
 625         <!ATTLIST idbag persister CDATA #IMPLIED>
 626         <!ATTLIST idbag collection-type CDATA #IMPLIED>
 627         <!ATTLIST idbag check CDATA #IMPLIED>                                                                                                                   <!-- default: none -->
 628         <!ATTLIST idbag optimistic-lock (true|false) "true">    <!-- only supported for properties of a class (not component) -->
 629         <!ATTLIST idbag node CDATA #IMPLIED>
 630         <!ATTLIST idbag embed-xml (true|false) "true">
 631
 632 <!ELEMENT list (
 633         meta*,
 634         subselect?,
 635         cache?,
 636         synchronize*,
 637         comment?,
 638         key,
 639         (index|list-index),
 640         (element|one-to-many|many-to-many|composite-element|many-to-any),
 641         loader?,sql-insert?,sql-update?,sql-delete?,sql-delete-all?,
 642         filter*
 643 )>
 644         <!ATTLIST list name CDATA #REQUIRED>
 645         <!ATTLIST list access CDATA #IMPLIED>
 646         <!ATTLIST list table CDATA #IMPLIED>                                                                                                                    <!-- default: name -->
 647         <!ATTLIST list schema CDATA #IMPLIED>                                                                                                                   <!-- default: none -->
 648         <!ATTLIST list catalog CDATA #IMPLIED>                                                                                                                  <!-- default: none -->
 649         <!ATTLIST list subselect CDATA #IMPLIED>
 650         <!ATTLIST list lazy (true|false|extra) #IMPLIED>
 651         <!ATTLIST list inverse (true|false) "false">
 652         <!ATTLIST list mutable (true|false) "true">
 653         <!ATTLIST list cascade CDATA #IMPLIED>
 654         <!ATTLIST list where CDATA #IMPLIED>                                                                                                                    <!-- default: none -->
 655         <!ATTLIST list batch-size CDATA #IMPLIED>
 656         <!ATTLIST list outer-join (true|false|auto) #IMPLIED>
 657         <!ATTLIST list fetch (join|select|subselect) #IMPLIED>
 658         <!ATTLIST list persister CDATA #IMPLIED>
 659         <!ATTLIST list collection-type CDATA #IMPLIED>
 660         <!ATTLIST list check CDATA #IMPLIED>                                                                                                                    <!-- default: none -->
 661         <!ATTLIST list optimistic-lock (true|false) "true">             <!-- only supported for properties of a class (not component) -->
 662         <!ATTLIST list node CDATA #IMPLIED>
 663         <!ATTLIST list embed-xml (true|false) "true">
 664
 665 <!ELEMENT array (
 666         meta*,
 667         subselect?,
 668         cache?,
 669         synchronize*,
 670         comment?,
 671         key,
 672         (index|list-index),
 673         (element|one-to-many|many-to-many|composite-element|many-to-any),
 674         loader?,sql-insert?,sql-update?,sql-delete?,sql-delete-all?
 675 )>
 676         <!ATTLIST array name CDATA #REQUIRED>
 677         <!ATTLIST array access CDATA #IMPLIED>
 678         <!ATTLIST array table CDATA #IMPLIED>                                                                                                                   <!-- default: name -->
 679         <!ATTLIST array schema CDATA #IMPLIED>                                                                                                                  <!-- default: none -->
 680         <!ATTLIST array catalog CDATA #IMPLIED>                                                                                                                 <!-- default: none -->
 681         <!ATTLIST array subselect CDATA #IMPLIED>
 682         <!ATTLIST array inverse (true|false) "false">
 683         <!ATTLIST array mutable (true|false) "true">
 684         <!ATTLIST array element-class CDATA #IMPLIED>
 685         <!ATTLIST array cascade CDATA #IMPLIED>
 686         <!ATTLIST array where CDATA #IMPLIED>                                                                                                                   <!-- default: none -->
 687         <!ATTLIST array batch-size CDATA #IMPLIED>
 688         <!ATTLIST array outer-join (true|false|auto) #IMPLIED>
 689         <!ATTLIST array fetch (join|select|subselect) #IMPLIED>
 690         <!ATTLIST array persister CDATA #IMPLIED>
 691         <!ATTLIST array collection-type CDATA #IMPLIED>
 692         <!ATTLIST array check CDATA #IMPLIED>                                                                                                                   <!-- default: none -->
 693         <!ATTLIST array optimistic-lock (true|false) "true">    <!-- only supported for properties of a class (not component) -->
 694         <!ATTLIST array node CDATA #IMPLIED>
 695         <!ATTLIST array embed-xml (true|false) "true">
 696
 697 <!ELEMENT primitive-array (
 698         meta*,
 699         subselect?,
 700         cache?,
 701         synchronize*,
 702         comment?,
 703         key,
 704         (index|list-index),
 705         element,
 706         loader?,sql-insert?,sql-update?,sql-delete?,sql-delete-all?
 707 )>
 708         <!ATTLIST primitive-array name CDATA #REQUIRED>
 709         <!ATTLIST primitive-array access CDATA #IMPLIED>
 710         <!ATTLIST primitive-array table CDATA #IMPLIED>                                                                 <!-- default: name -->
 711         <!ATTLIST primitive-array schema CDATA #IMPLIED>                                                                <!-- default: none -->
 712         <!ATTLIST primitive-array catalog CDATA #IMPLIED>                                                               <!-- default: none -->
 713         <!ATTLIST primitive-array subselect CDATA #IMPLIED>
 714         <!ATTLIST primitive-array mutable (true|false) "true">
 715         <!ATTLIST primitive-array where CDATA #IMPLIED>                                                                 <!-- default: none -->
 716         <!ATTLIST primitive-array batch-size CDATA #IMPLIED>
 717         <!ATTLIST primitive-array outer-join (true|false|auto) #IMPLIED>
 718         <!ATTLIST primitive-array fetch (join|select|subselect) #IMPLIED>
 719         <!ATTLIST primitive-array persister CDATA #IMPLIED>
 720         <!ATTLIST primitive-array collection-type CDATA #IMPLIED>
 721         <!ATTLIST primitive-array check CDATA #IMPLIED>                                                                 <!-- default: none -->
 722         <!ATTLIST primitive-array optimistic-lock (true|false) "true">          <!-- only supported for properties of a class (not component) -->
 723         <!ATTLIST primitive-array node CDATA #IMPLIED>
 724         <!ATTLIST primitive-array embed-xml (true|false) "true">
 725
 726 <!-- Declares the element type of a collection of basic type -->
 727
 728 <!ELEMENT element (column|formula)*>
 729         <!ATTLIST element column CDATA #IMPLIED>
 730         <!ATTLIST element node CDATA #IMPLIED>
 731         <!ATTLIST element formula CDATA #IMPLIED>
 732         <!ATTLIST element type CDATA #REQUIRED>
 733         <!ATTLIST element length CDATA #IMPLIED>
 734         <!ATTLIST element precision CDATA #IMPLIED>
 735         <!ATTLIST element scale CDATA #IMPLIED>
 736         <!ATTLIST element not-null (true|false) "false">
 737         <!ATTLIST element unique (true|false) "false">
 738
 739 <!-- One to many association. This tag declares the entity-class
 740 element type of a collection and specifies a one-to-many relational model -->
 741
 742 <!ELEMENT one-to-many EMPTY>
 743         <!ATTLIST one-to-many class CDATA #IMPLIED>
 744         <!ATTLIST one-to-many not-found (exception|ignore) "exception">
 745         <!ATTLIST one-to-many node CDATA #IMPLIED>
 746         <!ATTLIST one-to-many embed-xml (true|false) "true">
 747         <!ATTLIST one-to-many entity-name CDATA #IMPLIED>
 748         <!-- No column declaration attributes required in this case. The primary
 749         key column of the associated class is already mapped elsewhere.-->
 750
 751 <!-- Many to many association. This tag declares the entity-class
 752 element type of a collection and specifies a many-to-many relational model -->
 753
 754 <!ELEMENT many-to-many (meta*,(column|formula)*,filter*)>
 755         <!ATTLIST many-to-many class CDATA #IMPLIED>
 756         <!ATTLIST many-to-many node CDATA #IMPLIED>
 757         <!ATTLIST many-to-many embed-xml (true|false) "true">
 758         <!ATTLIST many-to-many entity-name CDATA #IMPLIED>
 759         <!ATTLIST many-to-many column CDATA #IMPLIED>
 760         <!ATTLIST many-to-many formula CDATA #IMPLIED>
 761         <!ATTLIST many-to-many not-found (exception|ignore) "exception">
 762         <!ATTLIST many-to-many outer-join (true|false|auto) #IMPLIED>
 763         <!ATTLIST many-to-many fetch (join|select) #IMPLIED>
 764         <!ATTLIST many-to-many lazy (false|proxy) #IMPLIED>
 765         <!ATTLIST many-to-many foreign-key CDATA #IMPLIED>
 766         <!ATTLIST many-to-many unique (true|false) "false">
 767         <!ATTLIST many-to-many where CDATA #IMPLIED>
 768         <!ATTLIST many-to-many property-ref CDATA #IMPLIED>
 769
 770 <!-- A composite element allows a collection to hold instances of an arbitrary
 771 class, without the requirement of joining to an entity table. Composite elements
 772 have component semantics - no shared references and ad hoc null value semantics.
 773 Composite elements may not hold nested collections. -->
 774
 775 <!ELEMENT composite-element (
 776         (meta*),
 777         parent?,
 778         (property|many-to-one|any|nested-composite-element)*
 779 )>
 780         <!ATTLIST composite-element class CDATA #REQUIRED>
 781         <!ATTLIST composite-element node CDATA #IMPLIED>
 782
 783 <!ELEMENT nested-composite-element (
 784         parent?,
 785         (property|many-to-one|any|nested-composite-element)*
 786 )>
 787         <!ATTLIST nested-composite-element class CDATA #REQUIRED>
 788         <!ATTLIST nested-composite-element name CDATA #REQUIRED>
 789         <!ATTLIST nested-composite-element access CDATA #IMPLIED>
 790         <!ATTLIST nested-composite-element node CDATA #IMPLIED>
 791
 792 <!-- Declares the column name of a foreign key. -->
 793
 794 <!ELEMENT key (column*)>
 795         <!ATTLIST key column CDATA #IMPLIED>
 796         <!ATTLIST key property-ref CDATA #IMPLIED>
 797         <!ATTLIST key foreign-key CDATA #IMPLIED>
 798         <!ATTLIST key on-delete (cascade|noaction) "noaction">
 799         <!ATTLIST key not-null (true|false) #IMPLIED>
 800         <!ATTLIST key update (true|false) #IMPLIED>
 801         <!ATTLIST key unique (true|false) #IMPLIED>
 802
 803 <!-- Declares the type and column mapping for a collection index (array or
 804 list index, or key of a map). -->
 805
 806 <!ELEMENT list-index (column?)>
 807         <!ATTLIST list-index column CDATA #IMPLIED>
 808         <!ATTLIST list-index base CDATA "0">
 809
 810 <!ELEMENT map-key ((column|formula)*)>
 811         <!ATTLIST map-key column CDATA #IMPLIED>
 812         <!ATTLIST map-key formula CDATA #IMPLIED>
 813         <!ATTLIST map-key type CDATA #REQUIRED>
 814         <!ATTLIST map-key length CDATA #IMPLIED>
 815         <!ATTLIST map-key node CDATA #IMPLIED>
 816
 817 <!ELEMENT index (column*)>
 818         <!ATTLIST index column CDATA #IMPLIED>
 819         <!ATTLIST index type CDATA #IMPLIED>                    <!-- required for maps -->
 820         <!ATTLIST index length CDATA #IMPLIED>
 821
 822 <!-- Many to many association mapped to the key of a map. ie. a map keyed
 823 on entities. -->
 824
 825 <!ELEMENT map-key-many-to-many ((column|formula)*)>
 826         <!ATTLIST map-key-many-to-many class CDATA #IMPLIED>
 827         <!ATTLIST map-key-many-to-many entity-name CDATA #IMPLIED>
 828         <!ATTLIST map-key-many-to-many column CDATA #IMPLIED>
 829         <!ATTLIST map-key-many-to-many formula CDATA #IMPLIED>
 830         <!ATTLIST map-key-many-to-many foreign-key CDATA #IMPLIED>
 831
 832 <!ELEMENT index-many-to-many (column*)>
 833         <!ATTLIST index-many-to-many class CDATA #REQUIRED>
 834         <!ATTLIST index-many-to-many entity-name CDATA #IMPLIED>
 835         <!ATTLIST index-many-to-many column CDATA #IMPLIED>
 836         <!ATTLIST index-many-to-many foreign-key CDATA #IMPLIED>
 837
 838 <!-- Composite index of a map ie. a map keyed on components. -->
 839
 840 <!ELEMENT composite-map-key ( (key-property|key-many-to-one)+ )>
 841         <!ATTLIST composite-map-key class CDATA #REQUIRED>
 842
 843 <!ELEMENT composite-index ( (key-property|key-many-to-one)+ )>
 844         <!ATTLIST composite-index class CDATA #REQUIRED>
 845
 846 <!-- A "many to any" defines a polymorphic association to any table
 847 with the given identifier type. The first listed column is a VARCHAR column
 848 holding the name of the class (for that row). -->
 849
 850 <!ELEMENT many-to-any (meta-value*,column, column+)>
 851         <!ATTLIST many-to-any id-type CDATA #REQUIRED>
 852         <!ATTLIST many-to-any meta-type CDATA #IMPLIED>                 <!--- default: Hibernate.CLASS -->
 853
 854 <!ELEMENT index-many-to-any (column, column+)>
 855         <!ATTLIST index-many-to-any id-type CDATA #REQUIRED>
 856         <!ATTLIST index-many-to-any meta-type CDATA #IMPLIED>   <!--- default: Hibernate.CLASS -->
 857
 858 <!ELEMENT collection-id (meta*, column*, generator)>
 859         <!ATTLIST collection-id column CDATA #REQUIRED>
 860         <!ATTLIST collection-id type CDATA #REQUIRED>
 861         <!ATTLIST collection-id length CDATA #IMPLIED>
 862
 863 <!-- Generators generate unique identifiers. The class attribute specifies a Java
 864 class implementing an id generation algorithm. -->
 865
 866 <!ELEMENT generator (param*)>
 867         <!ATTLIST generator class CDATA #REQUIRED>
 868 <!ELEMENT param (#PCDATA)>
 869         <!ATTLIST param name CDATA #REQUIRED>
 870
 871 <!-- The column element is an alternative to column attributes and required for
 872 mapping associations to classes with composite ids. -->
 873
 874 <!ELEMENT column (comment?)>
 875         <!ATTLIST column name CDATA #REQUIRED>
 876         <!ATTLIST column length CDATA #IMPLIED>                                         <!-- default: 255 -->
 877         <!ATTLIST column precision CDATA #IMPLIED>
 878         <!ATTLIST column scale CDATA #IMPLIED>
 879         <!ATTLIST column not-null (true|false) #IMPLIED>                        <!-- default: false (except for id properties) -->
 880         <!ATTLIST column unique (true|false) #IMPLIED>                          <!-- default: false (except for id properties) -->
 881         <!ATTLIST column unique-key CDATA #IMPLIED>                                     <!-- default: no unique key -->
 882         <!ATTLIST column sql-type CDATA #IMPLIED>                                       <!-- override default column type for hibernate type -->
 883         <!ATTLIST column index CDATA #IMPLIED>
 884         <!ATTLIST column check CDATA #IMPLIED>                                          <!-- default: no check constraint -->
 885     <!ATTLIST column default CDATA #IMPLIED>                    <!-- default: no default value -->
 886
 887 <!-- The formula and subselect elements allow us to map derived properties and
 888 entities. -->
 889
 890 <!ELEMENT formula (#PCDATA)>
 891 <!ELEMENT subselect (#PCDATA)>
 892
 893 <!-- The cache element enables caching of an entity class. -->
 894 <!ELEMENT cache EMPTY>
 895         <!ATTLIST cache usage (read-only|read-write|nonstrict-read-write|transactional) #REQUIRED>
 896         <!ATTLIST cache region CDATA #IMPLIED>                                          <!-- default: class or collection role name -->
 897         <!ATTLIST cache include (all|non-lazy) "all">
 898
 899 <!-- The comment element allows definition of a database table or column comment. -->
 900
 901 <!ELEMENT comment (#PCDATA)>
 902
 903 <!-- The loader element allows specification of a named query to be used for fetching
 904 an entity or collection -->
 905
 906 <!ELEMENT loader EMPTY>
 907         <!ATTLIST loader query-ref CDATA #REQUIRED>
 908
 909 <!-- The query element declares a named Hibernate query string -->
 910
 911 <!ELEMENT query (#PCDATA|query-param)*>
 912         <!ATTLIST query name CDATA #REQUIRED>
 913         <!ATTLIST query flush-mode (auto|never|always) #IMPLIED>
 914         <!ATTLIST query cacheable (true|false) "false">
 915         <!ATTLIST query cache-region CDATA #IMPLIED>
 916         <!ATTLIST query fetch-size CDATA #IMPLIED>
 917         <!ATTLIST query timeout CDATA #IMPLIED>
 918         <!ATTLIST query cache-mode (get|ignore|normal|put|refresh) #IMPLIED>
 919     <!ATTLIST query read-only (true|false) #IMPLIED>
 920     <!ATTLIST query comment CDATA #IMPLIED>
 921
 922 <!-- The sql-query element declares a named SQL query string -->
 923
 924 <!ELEMENT sql-query (#PCDATA|return-scalar|return|return-join|load-collection|synchronize|query-param)*>
 925         <!ATTLIST sql-query name CDATA #REQUIRED>
 926     <!ATTLIST sql-query resultset-ref CDATA #IMPLIED>
 927         <!ATTLIST sql-query flush-mode (auto|never|always) #IMPLIED>
 928         <!ATTLIST sql-query cacheable (true|false) "false">
 929         <!ATTLIST sql-query cache-region CDATA #IMPLIED>
 930         <!ATTLIST sql-query fetch-size CDATA #IMPLIED>
 931         <!ATTLIST sql-query timeout CDATA #IMPLIED>
 932         <!ATTLIST sql-query cache-mode (get|ignore|normal|put|refresh) #IMPLIED>
 933     <!ATTLIST sql-query read-only (true|false) #IMPLIED>
 934     <!ATTLIST sql-query comment CDATA #IMPLIED>
 935         <!ATTLIST sql-query callable (true|false) "false">
 936
 937 <!-- The query-param element is used only by tools that generate
 938 finder methods for named queries -->
 939
 940 <!ELEMENT query-param EMPTY>
 941         <!ATTLIST query-param name CDATA #REQUIRED>
 942         <!ATTLIST query-param type CDATA #REQUIRED>
 943
 944 <!-- The resultset element declares a named resultset mapping definition for SQL queries -->
 945 <!ELEMENT resultset (return-scalar|return|return-join|load-collection)*>
 946         <!ATTLIST resultset name CDATA #REQUIRED>
 947
 948 <!--
 949         Defines a return component for a sql-query.  Alias refers to the alias
 950         used in the actual sql query; lock-mode specifies the locking to be applied
 951         when the query is executed.  The class, collection, and role attributes are mutually exclusive;
 952         class refers to the class name of a "root entity" in the object result; collection refers
 953         to a collection of a given class and is used to define custom sql to load that owned collection
 954         and takes the form "ClassName.propertyName"; role refers to the property path for an eager fetch
 955         and takes the form "owningAlias.propertyName"
 956 -->
 957 <!ELEMENT return (return-discriminator?,return-property)*>
 958         <!ATTLIST return alias CDATA #IMPLIED>
 959         <!ATTLIST return entity-name CDATA #IMPLIED>
 960         <!ATTLIST return class CDATA #IMPLIED>
 961         <!ATTLIST return lock-mode (none|read|upgrade|upgrade-nowait|write) "read">
 962
 963 <!ELEMENT return-property (return-column*)>
 964         <!ATTLIST return-property name CDATA #REQUIRED>
 965         <!ATTLIST return-property column CDATA #IMPLIED>
 966
 967 <!ELEMENT return-column EMPTY>
 968         <!ATTLIST return-column name CDATA #REQUIRED>
 969
 970 <!ELEMENT return-discriminator EMPTY>
 971         <!ATTLIST return-discriminator column CDATA #REQUIRED>
 972
 973 <!ELEMENT return-join (return-property)*>
 974         <!ATTLIST return-join alias CDATA #REQUIRED>
 975         <!ATTLIST return-join property CDATA #REQUIRED>
 976         <!ATTLIST return-join lock-mode (none|read|upgrade|upgrade-nowait|write) "read">
 977
 978 <!ELEMENT load-collection (return-property)*>
 979         <!ATTLIST load-collection alias CDATA #REQUIRED>
 980         <!ATTLIST load-collection role CDATA #REQUIRED>
 981         <!ATTLIST load-collection lock-mode (none|read|upgrade|upgrade-nowait|write) "read">
 982
 983 <!ELEMENT return-scalar EMPTY>
 984         <!ATTLIST return-scalar column CDATA #REQUIRED>
 985         <!ATTLIST return-scalar type CDATA #IMPLIED>
 986
 987 <!ELEMENT synchronize EMPTY>
 988         <!ATTLIST synchronize table CDATA #REQUIRED>
 989
 990 <!-- custom sql operations -->
 991 <!ELEMENT sql-insert (#PCDATA)>
 992         <!ATTLIST sql-insert callable (true|false) "false">
 993
 994 <!ELEMENT sql-update (#PCDATA)>
 995         <!ATTLIST sql-update callable (true|false) "false">
 996
 997 <!ELEMENT sql-delete (#PCDATA)>
 998         <!ATTLIST sql-delete callable (true|false) "false">
 999
1000 <!ELEMENT sql-delete-all (#PCDATA)>
1001         <!ATTLIST sql-delete-all callable (true|false) "false">
1002
1003 <!--
1004     Element for defining "auxiliary" database objects.  Must be one of two forms:
1005
1006     #1 :
1007         <database-object>
1008             <definition class="CustomClassExtendingAuxiliaryObject"/>
1009         </database-object>
1010
1011     #2 :
1012         <database-object>
1013             <create>CREATE OR REPLACE ....</create>
1014             <drop>DROP ....</drop>
1015         </database-object>
1016 -->
1017 <!ELEMENT database-object ( (definition|(create,drop)), dialect-scope* )>
1018
1019 <!ELEMENT definition EMPTY>
1020     <!ATTLIST definition class CDATA #REQUIRED>
1021
1022 <!ELEMENT create (#PCDATA)>
1023 <!ELEMENT drop (#PCDATA)>
1024
1025 <!--
1026     dialect-scope element allows scoping auxiliary-objects to a particular
1027     Hibernate dialect implementation.
1028 -->
1029 <!ELEMENT dialect-scope (#PCDATA)>
1030     <!ATTLIST dialect-scope name CDATA #REQUIRED>
1031