diff options
author | tle | 2011-12-27 21:53:10 +0000 |
---|---|---|
committer | tle | 2011-12-27 21:53:10 +0000 |
commit | f084e6d5c6e20a08394679e05e9f44bd9c4dc508 (patch) | |
tree | a8b9102dad3a657a3624cd9e999b6cef9d3102e5 /common | |
parent | c87441f72f658b6b819b7fbe082ae8cc282ef076 (diff) | |
download | webtools.dali-f084e6d5c6e20a08394679e05e9f44bd9c4dc508.tar.gz webtools.dali-f084e6d5c6e20a08394679e05e9f44bd9c4dc508.tar.xz webtools.dali-f084e6d5c6e20a08394679e05e9f44bd9c4dc508.zip |
350615 - [EclipseLink] Point to latest XSD's in shipped EL bundles in XML Catalog
Diffstat (limited to 'common')
6 files changed, 14 insertions, 16204 deletions
diff --git a/common/plugins/org.eclipse.jpt.common.eclipselink.core/plugin.xml b/common/plugins/org.eclipse.jpt.common.eclipselink.core/plugin.xml index 2865fa5a5f..c03f9269c5 100644 --- a/common/plugins/org.eclipse.jpt.common.eclipselink.core/plugin.xml +++ b/common/plugins/org.eclipse.jpt.common.eclipselink.core/plugin.xml @@ -51,11 +51,7 @@ point="org.eclipse.wst.xml.core.catalogContributions"> <catalogContribution id="default"> - - <public - publicId="http://www.eclipse.org/eclipselink/xsds/persistence/orm" - uri="schemas/eclipselink_orm_2_4.xsd"/> - + <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_orm_1_0.xsd" uri="schemas/eclipselink_orm_1_0.xsd"/> @@ -79,19 +75,15 @@ <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_orm_2_2.xsd" uri="schemas/eclipselink_orm_2_2.xsd"/> - + <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_orm_2_3.xsd" uri="schemas/eclipselink_orm_2_3.xsd"/> - + <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_orm_2_4.xsd" - uri="schemas/eclipselink_orm_2_4.xsd"/> - - <public - publicId="http://www.eclipse.org/eclipselink/xsds/persistence/oxm" - uri="schemas/eclipselink_oxm_2_4.xsd"/> - + uri="platform:/plugin/org.eclipse.persistence.jpa/org/eclipse/persistence/jpa/eclipselink_orm_2_4.xsd"/> + <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_oxm_2_0.xsd" uri="schemas/eclipselink_oxm_2_0.xsd"/> @@ -103,22 +95,18 @@ <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_oxm_2_2.xsd" uri="schemas/eclipselink_oxm_2_2.xsd"/> - + <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_oxm_2_3.xsd" uri="schemas/eclipselink_oxm_2_3.xsd"/> - + <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_oxm_2_4.xsd" - uri="schemas/eclipselink_oxm_2_4.xsd"/> - - <public - publicId="http://www.eclipse.org/eclipselink/xsds/persistence" - uri="schemas/eclipselink_persistence_map_2.3.xsd"/> - + uri="platform:/plugin/org.eclipse.persistence.moxy/org/eclipse/persistence/jaxb/eclipselink_oxm_2_4.xsd"/> + <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_persistence_map_1.0.xsd" - uri="schemas/eclipselink_persistence_map_1.0.xsd"/> + uri="platform:/plugin/org.eclipse.persistence.core/org/eclipse/persistence/eclipselink_persistence_map_1.0.xsd"/> <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_persistence_map_1.1.xsd" @@ -131,10 +119,10 @@ <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_persistence_map_2.0.xsd" uri="schemas/eclipselink_persistence_map_2.0.xsd"/> - + <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_persistence_map_2.3.xsd" - uri="schemas/eclipselink_persistence_map_2.3.xsd"/> + uri="platform:/plugin/org.eclipse.persistence.core/org/eclipse/persistence/eclipselink_persistence_map_2.3.xsd"/> <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_sessions_1.0.xsd" @@ -151,10 +139,10 @@ <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_sessions_2.0.xsd" uri="schemas/eclipselink_sessions_2.0.xsd"/> - + <uri name="http://www.eclipse.org/eclipselink/xsds/eclipselink_sessions_2.1.xsd" - uri="schemas/eclipselink_sessions_2.1.xsd"/> + uri="platform:/plugin/org.eclipse.persistence.core/org/eclipse/persistence/eclipselink_sessions_2.1.xsd"/> </catalogContribution> diff --git a/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_orm_2_4.xsd b/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_orm_2_4.xsd deleted file mode 100644 index 774c5f6d2a..0000000000 --- a/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_orm_2_4.xsd +++ /dev/null @@ -1,5575 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> - -<!-- ******************************************************************************************************************************* --> -<!-- Copyright (c) 1998, 2010 Oracle. All rights reserved. --> -<!-- This program and the accompanying materials are made available under the --> -<!-- terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 --> -<!-- which accompanies this distribution. --> -<!-- The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html --> -<!-- and the Eclipse Distribution License is available at --> -<!-- http://www.eclipse.org/org/documents/edl-v10.php. --> -<!-- --> -<!-- Contributors: --> -<!-- Oracle - initial API and implementation from Oracle TopLink --> -<!-- tware - update version number to 2.0 --> -<!-- 12/2/2009-2.1 Guy Pelletier --> -<!-- - 296289: Add current annotation metadata support on mapped superclasses to EclipseLink-ORM.XML Schema --> -<!-- - 296612: Add current annotation only metadata support of return insert/update to the EclipseLink-ORM.XML Schema --> -<!-- - formatted to match orm_2_0.xsd so that users can easily compare the two schemas --> -<!-- 5/4/2010-2.1 Guy Pelletier --> -<!-- - 227219: Expand EclipseLink-ORM.XML schema functionality for 2.1 release (update version to 2.1) --> -<!-- 6/14/2010-2.2 Guy Pelletier --> -<!-- - 247078: eclipselink-orm.xml schema should allow lob and enumerated on version and id mappings (update version to 2.2) --> -<!-- 10/15/2010-2.2 Guy Pelletier --> -<!-- - 322008: Improve usability of additional criteria applied to queries at the session/EM --> -<!-- 03/23/2011-2.3 Guy Pelletier --> -<!-- - 337323: Multi-tenant with shared schema support (part 1) --> -<!-- ******************************************************************************************************************************* --> - -<!-- Java Persistence API object-relational mapping file schema --> -<xsd:schema targetNamespace="http://www.eclipse.org/eclipselink/xsds/persistence/orm" - xmlns:orm="http://www.eclipse.org/eclipselink/xsds/persistence/orm" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" - elementFormDefault="qualified" - attributeFormDefault="unqualified" - version="2.4"> - - <xsd:annotation> - <xsd:documentation> - @(#)eclipselink_orm_2_4.xsd 2.4 June 28 2011 - </xsd:documentation> - </xsd:annotation> - - <xsd:annotation> - <xsd:documentation><![CDATA[ - - This is the XML Schema for the native Eclipselink XML mapping file - The file may be named "META-INF/eclipselink-orm.xml" in the persistence - archive or it may be named some other name which would be - used to locate the file as resource on the classpath. - Object/relational mapping files must indicate the object/relational - mapping file schema by using the persistence namespace: - - http://www.eclipse.org/eclipselink/xsds/persistence/orm - - and indicate the version of the schema by using the version element as shown below: - - <entity-mappings xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/orm" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://www.eclipse.org/eclipselink/xsds/persistence/orm - eclipselink_orm_2_4.xsd - version="2.4"> - ... - </entity-mappings> - - ]]></xsd:documentation> - </xsd:annotation> - - <!-- **************************************************** --> - - <xsd:complexType name="emptyType"/> - - <xsd:simpleType name="versionType"> - <xsd:restriction base="xsd:token"> - <xsd:pattern value="[0-9]+(\.[0-9]+)*"/> - </xsd:restriction> - </xsd:simpleType> - - <xsd:simpleType name="supported-versions-type"> - <xsd:restriction base="orm:versionType"> - <xsd:enumeration value="2.0"/> - <xsd:enumeration value="2.1"/> - <xsd:enumeration value="2.2"/> - <xsd:enumeration value="2.3"/> - <xsd:enumeration value="2.4"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="access-methods"> - <xsd:annotation> - <xsd:documentation> - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="get-method" type="xsd:string" use="required"/> - <xsd:attribute name="set-method" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="additional-criteria"> - <xsd:annotation> - <xsd:documentation> - - /** - * An additional criteria can be specified at the Entity or MappedSuperclass - * level. When specified at the mapped superclass level, it applies to all - * inheriting entities unless those entities define their own additional - * criteria, at which point the additional criteria from the mapped superclass - * is ignored. - * - * The additional criteria supports any valid JPQL string and must use 'this' - * as an alias to form your additional criteria. E.G., - * - * @Entity - * @AdditionalCriteria("this.nut.size = :NUT_SIZE and this.nut.color = :NUT_COLOR") - * public class Bolt {...} - * - * Additional criteria parameters are also accepted and are set through - * properties on the entity manager factory, or on an entity manager. When set - * on the entity manager, the properties must be set before any query execution - * and should not be changed for the life span of that entity manager. - * - * Properties set on the entity manager will override those similarly named - * properties set on the entity manager factory. - * - * Additional criteria is not supported with any native queries. - * - * @author Guy Pelletier - * @since EclipseLink 2.2 - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface AdditionalCriteria { - /** - * (Required) The JPQL fragment to use as the additional criteria. - */ - String value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="criteria" type="xsd:string"/> - </xsd:sequence> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="cache"> - <xsd:annotation> - <xsd:documentation> - - /** - * The Cache annotation is used to set an - * org.eclipse.persistence.descriptors.invalidation.CacheInvalidationPolicy - * which sets objects in EclipseLink's identity maps to be invalid - * following given rules. By default in EclipseLink, objects do not - * expire in the cache. Several different policies are available to - * allow objects to expire. - * - * @see org.eclipse.persistence.annotations.CacheType - * - * A Cache anotation may be defined on an Entity or MappedSuperclass. - * In the case of inheritance, a Cache annotation should only be defined - * on the root of the inheritance hierarchy. - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface Cache { - /** - * (Optional) The type of cache to use. - */ - CacheType type() default SOFT_WEAK; - - /** - * (Optional) The size of cache to use. - */ - int size() default 100; - - /** - * (Optional) Cached instances in the shared cache, - * or only a per EntityManager isolated cache. - * The default is shared. - * @deprecated As of Eclipselink 2.2. See the attribute 'isolation' - */ - @Deprecated - boolean shared() default true; - - /** - * (Optional) Controls the level of caching this Entity will use. - * The default is CacheIsolationType.SHARED which has EclipseLink - * Caching all Entities in the Shared Cache. - * @see org.eclipse.persistence.config.CacheIsolationType - */ - CacheIsolationType isolation() default SHARED; - - /** - * (Optional) Expire cached instance after a fix period of time (ms). - * Queries executed against the cache after this will be forced back - * to the database for a refreshed copy - */ - int expiry() default -1; // minus one is no expiry. - - /** - * (Optional) Expire cached instance a specific time of day. Queries - * executed against the cache after this will be forced back to the - * database for a refreshed copy - */ - TimeOfDay expiryTimeOfDay() default @TimeOfDay(specified=false); - - /** - * (Optional) Force all queries that go to the database to always - * refresh the cache. - */ - boolean alwaysRefresh() default false; - - /** - * (Optional) For all queries that go to the database, refresh the - * cache only if the data received from the database by a query is - * newer than the data in the cache (as determined by the optimistic - * locking field) - */ - boolean refreshOnlyIfNewer() default false; - - /** - * (Optional) Setting to true will force all queries to bypass the - * cache for hits but still resolve against the cache for identity. - * This forces all queries to hit the database. - */ - boolean disableHits() default false; - - /** - * (Optional) The cache coordination mode. - */ - CacheCoordinationType coordinationType() default SEND_OBJECT_CHANGES; - - /** - * (Optional) The database change notification mode. - * Note that database event listener must also be configured for the persistence unit/session. - */ - DatabaseChangeNotificationType databaseChangeNotificationType() default DatabaseChangeNotificationType.INVALIDATE; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:choice> - <xsd:element name="expiry" type="xsd:integer" minOccurs="0"/> - <xsd:element name="expiry-time-of-day" type="orm:time-of-day" minOccurs="0"/> - </xsd:choice> - <xsd:attribute name="size" type="xsd:integer"/> - <xsd:attribute name="shared" type="xsd:boolean"/> - <xsd:attribute name="isolation" type="orm:cache-isolation-type"/> - <xsd:attribute name="type" type="orm:cache-type"/> - <xsd:attribute name="always-refresh" type="xsd:boolean"/> - <xsd:attribute name="refresh-only-if-newer" type="xsd:boolean"/> - <xsd:attribute name="disable-hits" type="xsd:boolean"/> - <xsd:attribute name="coordination-type" type="orm:cache-coordination-type"/> - <xsd:attribute name="database-change-notification-type" type="orm:database-change-notification-type"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="cache-interceptor"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface CacheInterceptor { - Class value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="class" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="cache-type"> - <xsd:annotation> - <xsd:documentation> - - /** - * The CacheType enum is used with the Cache annotation for a - * persistent class. It defines the type of IdentityMap/Cache used for - * the class. By default the SOFT_WEAK cache type is used. - * - * @see org.eclipse.persistence.annotations.Cache - */ - public enum CacheType { - /** - * Provides full caching and guaranteed identity. Caches all objects - * and does not remove them. - * WARNING: This method may be memory intensive when many objects are - * read. - */ - FULL, - - /** - * Similar to the FULL identity map except that the map holds the - * objects using weak references. This method allows full garbage - * collection and provides full caching and guaranteed identity. - */ - WEAK, - - /** - * Similar to the FULL identity map except that the map holds the - * objects using soft references. This method allows full garbage - * collection when memory is low and provides full caching and - * guaranteed identity. - */ - SOFT, - - /** - * Similar to the WEAK identity map except that it maintains a - * most-frequently-used sub-cache. The size of the sub-cache is - * proportional to the size of the identity map as specified by - * descriptor's setIdentityMapSize() method. The sub-cache - * uses soft references to ensure that these objects are - * garbage-collected only if the system is low on memory. - */ - SOFT_WEAK, - - /** - * Identical to the soft cache weak (SOFT_WEAK) identity map except - * that it uses hard references in the sub-cache. Use this identity - * map if soft references do not behave properly on your platform. - */ - HARD_WEAK, - - /** - * A cache identity map maintains a fixed number of objects - * specified by the application. Objects are removed from the cache - * on a least-recently-used basis. This method allows object - * identity for the most commonly used objects. - * WARNING: Furnishes caching and identity, but does not guarantee - * identity. - */ - CACHE, - - /** - * WARNING: Does not preserve object identity and does not cache - * objects. - */ - NONE - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="FULL"/> - <xsd:enumeration value="WEAK"/> - <xsd:enumeration value="SOFT"/> - <xsd:enumeration value="SOFT_WEAK"/> - <xsd:enumeration value="HARD_WEAK"/> - <xsd:enumeration value="CACHE"/> - <xsd:enumeration value="NONE"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:simpleType name="cache-isolation-type"> - <xsd:annotation> - <xsd:documentation> - /** - * Options for how Entity instances should be shared within an EclipseLink Persistence Unit / ServerSession - * @see ClassDescriptor#setCacheIsolationType(CacheIsolationType) - * @author Gordon Yorke - * @since EclipseLink 2.2 - */ - public enum CacheIsolationType { - - /** - * Entity instances will be cached within the EntityManagerFactory/ServerSession level. - * Any user queries for shared cache instances (ie Read-Only query hint) will return an Entity - * instance that may be shared by multiple clients. - * - * This setting is the default isolation level. - */ - SHARED, - - /** - * Entity state information will be cached in the shared cache but Entity - * instances will not be shared. Any user queries for shared cache instances - * (ie Read-Only query hint) will return a new Entity instance with the cached state. - * This will ensure the instance is <i>protected</i> from any concurrent - * state change. - */ - PROTECTED, - - /** - * The Entity and its data is not stored in the shared cache but is - * <i>isolated</i> to the Persistence Context/UnitOfWork or - * IsolatedClientSession. This setting effectively disables second level - * caching for this entity and should be used when users do not want caching for - * a particular Entity. - */ - ISOLATED; - - } - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="SHARED"/> - <xsd:enumeration value="PROTECTED"/> - <xsd:enumeration value="ISOLATED"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:simpleType name="cache-coordination-type"> - <xsd:annotation> - <xsd:documentation> - - /** - * An enum that is used within the Cache annotation. - * - * @see org.eclipse.persistence.annotations.Cache - */ - public enum CacheCoordinationType { - /** - * Sends a list of changed objects including data about the changes. - * This data is merged into the receiving cache. - */ - SEND_OBJECT_CHANGES, - - /** - * Sends a list of the identities of the objects that have changed. - * The receiving cache invalidates the objects (rather than changing - * any of the data) - */ - INVALIDATE_CHANGED_OBJECTS, - - /** - * Same as SEND_OBJECT_CHANGES except it also includes any newly - * created objects from the transaction. - */ - SEND_NEW_OBJECTS_WITH_CHANGES, - - /** - * Does no cache coordination. - */ - NONE - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="SEND_OBJECT_CHANGES"/> - <xsd:enumeration value="INVALIDATE_CHANGED_OBJECTS"/> - <xsd:enumeration value="SEND_NEW_OBJECTS_WITH_CHANGES"/> - <xsd:enumeration value="NONE"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:simpleType name="database-change-notification-type"> - <xsd:annotation> - <xsd:documentation> - - /** - * Configures what type of database change notification an entity/descriptor should use. - * This is only relevant if the persistence unit/session has been configured with a DatabaseEventListener, - * such as the OracleChangeNotificationListener that receives database change events. - * This allows for the EclipseLink cache to be invalidated or updated from database changes. - * - * @see Cache#databaseChangeNotificationType() - * @see org.eclipse.persistence.descriptors.CachePolicy#setDatabaseChangeNotificationType(DatabaseChangeNotificationType) - * @author James Sutherland - * @since EclipseLink 2.4 - */ - public enum DatabaseChangeNotificationType { - /** - * No database change events will be processed. - */ - NONE, - - /** - * Invalidates the EclipseLink cache when a database change event is received for an object. - * This requires a DatabaseEventListener to be configured with the persistence unit or session. - * This requires that the database change can be determine to affect the object, some database change events, - * such as the OracleChangeNotificationListener (Oracle DCN/QCN) only give the ROWID, so changes to secondary - * table or relationships may not be able to be determined to affect and object unless its version is also changed. - */ - INVALIDATE - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="NONE"/> - <xsd:enumeration value="INVALIDATE"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="change-tracking"> - <xsd:annotation> - <xsd:documentation> - - /** - * The ChangeTracking annotation is used to specify the - * org.eclipse.persistence.descriptors.changetracking.ObjectChangePolicy - * which computes changes sets for EclipseLink's UnitOfWork commit - * process. An ObjectChangePolicy is stored on an Entity's descriptor. - * - * A ChangeTracking annotation may be specified on an Entity, - * MappedSuperclass or Embeddable. - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface ChangeTracking { - /** - * (Optional) The type of change tracking to use. - */ - ChangeTrackingType value() default AUTO; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="type" type="orm:change-tracking-type"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="change-tracking-type"> - <xsd:annotation> - <xsd:documentation> - - /** - * An enum that is used within the ChangeTracking annotation. - */ - public enum ChangeTrackingType { - /** - * An ATTRIBUTE change tracking type allows change tracking at the - * attribute level of an object. Objects with changed attributes will - * be processed in the commit process to include any changes in the - * results of the commit. Unchanged objects will be ignored. - */ - ATTRIBUTE, - - /** - * An OBJECT change tracking policy allows an object to calculate for - * itself whether it has changed. Changed objects will be processed in - * the commit process to include any changes in the results of the - * commit. Unchanged objects will be ignored. - */ - OBJECT, - - /** - * A DEFERRED change tracking policy defers all change detection to - * the UnitOfWork's change detection process. Essentially, the - * calculateChanges() method will run for all objects in a UnitOfWork. - * This is the default ObjectChangePolicy - */ - DEFERRED, - - /** - * Will not set any change tracking policy. - */ - AUTO - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="ATTRIBUTE"/> - <xsd:enumeration value="OBJECT"/> - <xsd:enumeration value="DEFERRED"/> - <xsd:enumeration value="AUTO"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="customizer"> - <xsd:annotation> - <xsd:documentation> - - /** - * The Customizer annotation is used to specify a class that implements - * the org.eclipse.persistence.config.DescriptorCustomizer - * interface and is to run against an enetity's class descriptor after all - * metadata processing has been completed. - * - * The Customizer annotation may be defined on an Entity, MappedSuperclass - * or Embeddable class. In the case of inheritance, a Customizer is not - * inherited from its parent classes. - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface Customizer { - /** - * (Required) Defines the name of the descriptor customizer class that - * should be applied for the related entity or embeddable class. - */ - Class value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="class" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="direction-type"> - <xsd:annotation> - <xsd:documentation> - - /** - * An enum that is used within the StoredProcedureParameter annotation. - * It is used to specify the direction of the stored procedure - * parameters of a named stored procedure query. - */ - public enum Direction { - /** - * Input parameter - */ - IN, - - /** - * Output parameter - */ - OUT, - - /** - * Input and output parameter - */ - IN_OUT, - - /** - * Output cursor - */ - OUT_CURSOR - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="IN"/> - <xsd:enumeration value="OUT"/> - <xsd:enumeration value="IN_OUT"/> - <xsd:enumeration value="OUT_CURSOR"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:element name="entity-mappings"> - <xsd:complexType> - <xsd:annotation> - <xsd:documentation> - - The entity-mappings element is the root element of a mapping - file. It contains the following four types of elements: - - 1. The persistence-unit-metadata element contains metadata - for the entire persistence unit. It is undefined if this element - occurs in multiple mapping files within the same persistence unit. - - 2. The package, schema, catalog and access elements apply to all of - the entity, mapped-superclass and embeddable elements defined in - the same file in which they occur. - - 3. The sequence-generator, table-generator, named-query, - named-native-query and sql-result-set-mapping elements are global - to the persistence unit. It is undefined to have more than one - sequence-generator or table-generator of the same name in the same - or different mapping files in a persistence unit. It is also - undefined to have more than one named-query, named-native-query, or - result-set-mapping of the same name in the same or different mapping - files in a persistence unit. - - 4. The entity, mapped-superclass and embeddable elements each define - the mapping information for a managed persistent class. The mapping - information contained in these elements may be complete or it may - be partial. - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" - minOccurs="0"/> - <xsd:element name="persistence-unit-metadata" - type="orm:persistence-unit-metadata" - minOccurs="0"/> - <xsd:element name="package" type="xsd:string" - minOccurs="0"/> - <xsd:element name="schema" type="xsd:string" - minOccurs="0"/> - <xsd:element name="catalog" type="xsd:string" - minOccurs="0"/> - <xsd:element name="access" type="orm:access-type" - minOccurs="0"/> - <xsd:element name="access-methods" type="orm:access-methods" - minOccurs="0"/> - <xsd:element name="tenant-discriminator-column" type="orm:tenant-discriminator-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="converter" type="orm:converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="type-converter" type="orm:type-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="struct-converter" type="orm:struct-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="sequence-generator" type="orm:sequence-generator" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="table-generator" type="orm:table-generator" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="partitioning" type="orm:partitioning" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="replication-partitioning" type="orm:replication-partitioning" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="round-robin-partitioning" type="orm:round-robin-partitioning" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="pinned-partitioning" type="orm:pinned-partitioning" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="range-partitioning" type="orm:range-partitioning" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="value-partitioning" type="orm:value-partitioning" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="hash-partitioning" type="orm:hash-partitioning" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="union-partitioning" type="orm:union-partitioning" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-query" type="orm:named-query" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-native-query" type="orm:named-native-query" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-stored-procedure-query" type="orm:named-stored-procedure-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-stored-function-query" type="orm:named-stored-function-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-plsql-stored-procedure-query" type="orm:named-plsql-stored-procedure-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-plsql-stored-function-query" type="orm:named-plsql-stored-function-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="plsql-record" type="orm:plsql-record" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="plsql-table" type="orm:plsql-table" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="sql-result-set-mapping" - type="orm:sql-result-set-mapping" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="mapped-superclass" type="orm:mapped-superclass" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="entity" type="orm:entity" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="embeddable" type="orm:embeddable" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="version" type="orm:supported-versions-type" - default="2.3" use="optional"/> - </xsd:complexType> - </xsd:element> - - <!-- **************************************************** --> - - <xsd:simpleType name="existence-type"> - <xsd:annotation> - <xsd:documentation> - /** - * The ExistenceChecking annotation is used to specify the type of - * checking EclipseLink should use when updating entities. - * - * An existence-checking specification is supported on an Entity or - * MappedSuperclass annotation. - */ - public @interface ExistenceChecking { - - /** - * (Optional) Set the existence check for determining - * if an insert or update should occur for an object. - */ - ExistenceType value() default CHECK_CACHE; - } - - /** - * Assume that if the objects primary key does not include null and - * it is in the cache, then it must exist. - */ - CHECK_CACHE, - - /** - * Perform does exist check on the database. - */ - CHECK_DATABASE, - - /** - * Assume that if the objects primary key does not include null then - * it must exist. This may be used if the application guarantees or - * does not care about the existence check. - */ - ASSUME_EXISTENCE, - - /** - * Assume that the object does not exist. This may be used if the - * application guarantees or does not care about the existence check. - * This will always force an insert to be called. - */ - ASSUME_NON_EXISTENCE - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="CHECK_CACHE"/> - <xsd:enumeration value="CHECK_DATABASE"/> - <xsd:enumeration value="ASSUME_EXISTENCE"/> - <xsd:enumeration value="ASSUME_NON_EXISTENCE"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="persistence-unit-metadata"> - <xsd:annotation> - <xsd:documentation> - - Metadata that applies to the persistence unit and not just to - the mapping file in which it is contained. - - If the xml-mapping-metadata-complete element is specified, - the complete set of mapping metadata for the persistence unit - is contained in the XML mapping files for the persistence unit. - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="xml-mapping-metadata-complete" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="exclude-default-mappings" type="orm:emptyType" minOccurs="0"/> - <xsd:element name="persistence-unit-defaults" - type="orm:persistence-unit-defaults" - minOccurs="0"/> - </xsd:sequence> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="persistence-unit-defaults"> - <xsd:annotation> - <xsd:documentation> - - These defaults are applied to the persistence unit as a whole - unless they are overridden by local annotation or XML - element settings. - - schema - Used as the schema for all tables, secondary tables, join - tables, collection tables, sequence generators, and table - generators that apply to the persistence unit - catalog - Used as the catalog for all tables, secondary tables, join - tables, collection tables, sequence generators, and table - generators that apply to the persistence unit - delimited-identifiers - Used to treat database identifiers as - delimited identifiers. - access - Used as the access type for all managed classes in - the persistence unit - cascade-persist - Adds cascade-persist to the set of cascade options - in all entity relationships of the persistence unit - entity-listeners - List of default entity listeners to be invoked - on each entity in the persistence unit. - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="schema" type="xsd:string" - minOccurs="0"/> - <xsd:element name="catalog" type="xsd:string" - minOccurs="0"/> - <xsd:element name="delimited-identifiers" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="access" type="orm:access-type" - minOccurs="0"/> - <xsd:element name="access-methods" type="orm:access-methods" - minOccurs="0"/> - <xsd:element name="cascade-persist" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="tenant-discriminator-column" type="orm:tenant-discriminator-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="entity-listeners" type="orm:entity-listeners" - minOccurs="0"/> - </xsd:sequence> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="entity"> - <xsd:annotation> - <xsd:documentation> - - Defines the settings and mappings for an entity. Is allowed to be - sparsely populated and used in conjunction with the annotations. - Alternatively, the metadata-complete attribute can be used to - indicate that no annotations on the entity class (and its fields - or properties) are to be processed. If this is the case then - the defaulting rules for the entity and its subelements will - be recursively applied. - - @Target(TYPE) @Retention(RUNTIME) - public @interface Entity { - String name() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="multitenant" type="orm:multitenant" minOccurs="0"/> - <xsd:element name="additional-criteria" type="orm:additional-criteria" minOccurs="0"/> - <xsd:element name="customizer" type="orm:customizer" minOccurs="0"/> - <xsd:element name="change-tracking" type="orm:change-tracking" minOccurs="0"/> - <xsd:element name="table" type="orm:table" minOccurs="0"/> - <xsd:element name="secondary-table" type="orm:secondary-table" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="struct" type="orm:struct" minOccurs="0"/> - <xsd:element name="primary-key-join-column" - type="orm:primary-key-join-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="cascade-on-delete" type="xsd:boolean" minOccurs="0"/> - <xsd:element name="index" type="orm:index" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="id-class" type="orm:id-class" minOccurs="0"/> - <xsd:element name="primary-key" type="orm:primary-key" minOccurs="0"/> - <xsd:element name="inheritance" type="orm:inheritance" minOccurs="0"/> - <xsd:choice> - <xsd:sequence> - <xsd:element name="discriminator-value" type="orm:discriminator-value" minOccurs="0"/> - <xsd:element name="discriminator-column" type="orm:discriminator-column" minOccurs="0"/> - </xsd:sequence> - <xsd:element name="class-extractor" type="orm:class-extractor" minOccurs="0"/> - </xsd:choice> - <xsd:element name="optimistic-locking" type="orm:optimistic-locking" minOccurs="0"/> - <xsd:element name="cache" type="orm:cache" minOccurs="0"/> - <xsd:element name="cache-interceptor" type="orm:cache-interceptor" minOccurs="0" maxOccurs="1"/> - <xsd:element name="cache-index" type="orm:cache-index" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="fetch-group" type="orm:fetch-group" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="converter" type="orm:converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="type-converter" type="orm:type-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="struct-converter" type="orm:struct-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="copy-policy" type="orm:copy-policy" minOccurs="0" maxOccurs="1"/> - <xsd:element name="instantiation-copy-policy" type="orm:instantiation-copy-policy" minOccurs="0" maxOccurs="1"/> - <xsd:element name="clone-copy-policy" type="orm:clone-copy-policy" minOccurs="0" maxOccurs="1"/> - <xsd:element name="sequence-generator" type="orm:sequence-generator" - minOccurs="0"/> - <xsd:element name="table-generator" type="orm:table-generator" - minOccurs="0"/> - <xsd:group ref="orm:partitioning-group"/> - <xsd:element name="named-query" type="orm:named-query" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-native-query" type="orm:named-native-query" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-stored-procedure-query" type="orm:named-stored-procedure-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-stored-function-query" type="orm:named-stored-function-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-plsql-stored-procedure-query" type="orm:named-plsql-stored-procedure-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-plsql-stored-function-query" type="orm:named-plsql-stored-function-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="plsql-record" type="orm:plsql-record" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="plsql-table" type="orm:plsql-table" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="sql-result-set-mapping" - type="orm:sql-result-set-mapping" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="query-redirectors" type="orm:query-redirectors" minOccurs="0" maxOccurs="1"/> - <xsd:element name="exclude-default-listeners" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="exclude-superclass-listeners" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="entity-listeners" type="orm:entity-listeners" - minOccurs="0"/> - <xsd:element name="pre-persist" type="orm:pre-persist" minOccurs="0"/> - <xsd:element name="post-persist" type="orm:post-persist" - minOccurs="0"/> - <xsd:element name="pre-remove" type="orm:pre-remove" minOccurs="0"/> - <xsd:element name="post-remove" type="orm:post-remove" minOccurs="0"/> - <xsd:element name="pre-update" type="orm:pre-update" minOccurs="0"/> - <xsd:element name="post-update" type="orm:post-update" minOccurs="0"/> - <xsd:element name="post-load" type="orm:post-load" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="attribute-override" type="orm:attribute-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="association-override" - type="orm:association-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="attributes" type="orm:attributes" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="class" type="xsd:string" use="required"/> - <xsd:attribute name="parent-class" type="xsd:string"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="cacheable" type="xsd:boolean"/> - <xsd:attribute name="metadata-complete" type="xsd:boolean"/> - <xsd:attribute name="read-only" type="xsd:boolean"/> - <xsd:attribute name="existence-checking" type="orm:existence-type"/> - <xsd:attribute name="exclude-default-mappings" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:group name="partitioning-group"> - <xsd:sequence> - <xsd:element name="partitioning" type="orm:partitioning" minOccurs="0"/> - <xsd:element name="replication-partitioning" type="orm:replication-partitioning" minOccurs="0"/> - <xsd:element name="round-robin-partitioning" type="orm:round-robin-partitioning" minOccurs="0"/> - <xsd:element name="pinned-partitioning" type="orm:pinned-partitioning" minOccurs="0"/> - <xsd:element name="range-partitioning" type="orm:range-partitioning" minOccurs="0"/> - <xsd:element name="value-partitioning" type="orm:value-partitioning" minOccurs="0"/> - <xsd:element name="hash-partitioning" type="orm:hash-partitioning" minOccurs="0"/> - <xsd:element name="union-partitioning" type="orm:union-partitioning" minOccurs="0"/> - <xsd:element name="partitioned" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - </xsd:group> - - <!-- **************************************************** --> - - <xsd:simpleType name="access-type"> - <xsd:annotation> - <xsd:documentation> - - This element determines how the persistence provider accesses the - state of an entity or embedded object. - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="PROPERTY"/> - <xsd:enumeration value="FIELD"/> - <xsd:enumeration value="VIRTUAL"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="association-override"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) - public @interface AssociationOverride { - String name(); - JoinColumn[] joinColumns() default{}; - JoinTable joinTable() default @JoinTable; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:choice> - <xsd:element name="join-column" type="orm:join-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="join-table" type="orm:join-table" - minOccurs="0"/> - </xsd:choice> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="attribute-override"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) - public @interface AttributeOverride { - String name(); - Column column(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="column" type="orm:column"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="attributes"> - <xsd:annotation> - <xsd:documentation> - - This element contains the entity field or property mappings. - It may be sparsely populated to include only a subset of the - fields or properties. If metadata-complete for the entity is true - then the remainder of the attributes will be defaulted according - to the default rules. - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:choice> - <xsd:element name="id" type="orm:id" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="embedded-id" type="orm:embedded-id" - minOccurs="0"/> - </xsd:choice> - <xsd:element name="basic" type="orm:basic" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="basic-collection" type="orm:basic-collection" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="basic-map" type="orm:basic-map" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="version" type="orm:version" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="many-to-one" type="orm:many-to-one" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="one-to-many" type="orm:one-to-many" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="one-to-one" type="orm:one-to-one" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="variable-one-to-one" type="orm:variable-one-to-one" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="many-to-many" type="orm:many-to-many" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="element-collection" type="orm:element-collection" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="embedded" type="orm:embedded" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="transformation" type="orm:transformation" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="transient" type="orm:transient" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="structure" type="orm:structure" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="array" type="orm:array" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="basic"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface Basic { - FetchType fetch() default EAGER; - boolean optional() default true; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="column" type="orm:column" minOccurs="0"/> - <xsd:element name="index" type="orm:index" minOccurs="0"/> - <xsd:element name="cache-index" type="orm:cache-index" minOccurs="0"/> - <xsd:element name="generated-value" type="orm:generated-value" minOccurs="0"/> - <xsd:choice minOccurs="0"> - <xsd:element name="lob" type="orm:lob"/> - <xsd:element name="temporal" type="orm:temporal"/> - <xsd:element name="enumerated" type="orm:enumerated"/> - <xsd:element name="convert" type="xsd:string"/> - </xsd:choice> - <xsd:choice minOccurs="0"> - <xsd:element name="converter" type="orm:converter"/> - <xsd:element name="type-converter" type="orm:type-converter"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter"/> - <xsd:element name="struct-converter" type="orm:struct-converter"/> - </xsd:choice> - <xsd:element name="table-generator" type="orm:table-generator" minOccurs="0"/> - <xsd:element name="sequence-generator" type="orm:sequence-generator" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="return-insert" type="orm:return-insert" minOccurs="0"/> - <xsd:element name="return-update" type="orm:emptyType" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="optional" type="xsd:boolean"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="mutable" type="xsd:boolean"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="basic-collection"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface BasicCollection { - /** - * (Optional) Defines whether the value of the field or property - * should be lazily loaded or must be eagerly fetched. The EAGER - * strategy is a requirement on the persistence provider runtime that - * the value must be eagerly fetched. The LAZY strategy is a hint to - * the persistence provider runtime. If not specified, defaults to - * LAZY. - */ - FetchType fetch() default LAZY; - - /** - * (Optional) The name of the value column that holds the direct - * collection data. Defaults to the property or field name. - */ - Column valueColumn() default @Column; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="value-column" type="orm:column" minOccurs="0"/> - <xsd:element name="convert" type="xsd:string" minOccurs="0"/> - <xsd:choice minOccurs="0"> - <xsd:element name="converter" type="orm:converter"/> - <xsd:element name="type-converter" type="orm:type-converter"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter"/> - <xsd:element name="struct-converter" type="orm:struct-converter"/> - </xsd:choice> - <xsd:element name="collection-table" type="orm:eclipselink-collection-table" minOccurs="0"/> - <xsd:element name="join-fetch" type="orm:join-fetch-type" minOccurs="0"/> - <xsd:element name="batch-fetch" type="orm:batch-fetch" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="noncacheable" type="orm:emptyType" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="access" type="orm:access-type"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="basic-map"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface BasicMap { - /** - * (Optional) Defines whether the value of the field or property - * should be lazily loaded or must be eagerly fetched. The EAGER - * strategy is a requirement on the persistence provider runtime that - * the value must be eagerly fetched. The LAZY strategy is a hint to - * the persistence provider runtime. If not specified, defaults to - * LAZY. - */ - FetchType fetch() default LAZY; - - /** - * (Optional) The name of the data column that holds the direct map - * key. If the name on te key column is "", the name will default to: - * the name of the property or field; "_KEY". - */ - Column keyColumn() default @Column; - - /** - * (Optional) Specify the key converter. Default is equivalent to - * specifying @Convert("none"), meaning no converter will be added to - * the direct map key. - */ - Convert keyConverter() default @Convert; - - /** - * (Optional) The name of the data column that holds the direct - * collection data. Defaults to the property or field name. - */ - Column valueColumn() default @Column; - - /** - * (Optional) Specify the value converter. Default is equivalent to - * specifying @Convert("none"), meaning no converter will be added to - * the value column mapping. - */ - Convert valueConverter() default @Convert; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="key-column" type="orm:column" minOccurs="0"/> - <xsd:element name="key-converter" type="xsd:string" minOccurs="0"/> - <xsd:element name="value-column" type="orm:column" minOccurs="0"/> - <xsd:element name="value-converter" type="xsd:string" minOccurs="0"/> - <xsd:choice minOccurs="0" maxOccurs="2"> - <xsd:element name="converter" type="orm:converter"/> - <xsd:element name="type-converter" type="orm:type-converter"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter"/> - <xsd:element name="struct-converter" type="orm:struct-converter"/> - </xsd:choice> - <xsd:element name="collection-table" type="orm:eclipselink-collection-table" minOccurs="0"/> - <xsd:element name="join-fetch" type="orm:join-fetch-type" minOccurs="0"/> - <xsd:element name="batch-fetch" type="orm:batch-fetch" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="noncacheable" type="orm:emptyType" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="access" type="orm:access-type"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="cascade-type"> - <xsd:annotation> - <xsd:documentation> - - public enum CascadeType { ALL, PERSIST, MERGE, REMOVE, REFRESH, DETACH}; - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="cascade-all" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="cascade-persist" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="cascade-merge" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="cascade-remove" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="cascade-refresh" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="cascade-detach" type="orm:emptyType" - minOccurs="0"/> - </xsd:sequence> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="class-extractor"> - <xsd:annotation> - <xsd:documentation> - - /** - * A ClassExtractor allows for a user defined class indicator in place of - * providing a discriminator column. The class has the following restrictions: - - * - It must extend the org.eclipse.persistence.descriptors.ClassExtractor - * class and implement the extractClassFromRow(Record, Session) method. - * - That method must take a database row (a Record/Map) as an argument and - * must return the class to use for that row. - * - * This method will be used to decide which class to instantiate when reading - * from the database. It is the application's responsibility to populate any - * typing information in the database required to determine the class from the - * row. - * - * The ClassExtractor must only be set on the root of an entity class or - * sub-hierarchy in which a different inheritance strategy is applied. The - * ClassExtractor can only be used with the SINGLE_TABLE and JOINED inheritance - * strategies. - * - * If a ClassExtractor is used then a DiscriminatorColumn cannot be used. A - * ClassExtractor also cannot be used on either the root or its subclasses. - * - * In addition, for more complex configurations using a ClassExtractor and a - * SINGLE_TABLE strategy, the descriptor's withAllSubclasses and onlyInstances - * expressions should be set through the ClassExtractor's initialize method. - * - * @see org.eclipse.persistence.descriptors.InheritancePolicy.setWithAllSubclassesExpression(Expression) - * @see org.eclipse.persistence.descriptors.InheritancePolicy.setOnlyInstancesExpression(Expression) - * - * @author Guy Pelletier - * @since EclipseLink 2.1 - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface ClassExtractor { - /** - * (Required) Defines the name of the class extractor that should be - * applied to this entity's descriptor. - */ - Class value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="class" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="clone-copy-policy"> - <xsd:annotation> - <xsd:documentation> - /** - * A CloneCopyPolicy is used to set an - * org.eclipse.persistence.descriptors.copying.CloneCopyPolicy on an - * Entity. A CloneCopyPolicy must specify at one or both of the "method" - * or "workingCopyMethod". "workingCopyMethod" is used to clone objects - * that will be returned to the user as they are registered in - * EclipseLink's transactional mechanism, the UnitOfWork. "method" will - * be used for the clone that is used for comparison in conjunction with - * EclipseLink's DeferredChangeDetectionPolicy - * - * A CloneCopyPolicy should be specified on an Entity, MappedSuperclass - * or Embeddable. - * - * Example: - * @Entity - * @CloneCopyPolicy(method="myCloneMethod") - * - * or: - * - * @Entity - * @CloneCopyPolicy(method="myCloneMethod", workingCopyMethod="myWorkingCopyCloneMethod") - * - * or: - * - * @Entity - * @CloneCopyPolicy(workingCopyMethodName="myWorkingCopyClone") - */ - public @interface CloneCopyPolicy { - - /** - * (Optional) - * Either method or workingCopyMethod must be specified this defines - * a method that will be used to create a clone that will be used - * for comparison by - * EclipseLink's DeferredChangeDetectionPolicy - */ - String method(); - - /** - * (Optional) - * Either method or workingCopyMethod must be specified - * this defines a method that will be used to create a clone that - * will be used to create the object returned when registering an - * Object in an EclipseLink UnitOfWork - */ - String workingCopyMethod(); - - } - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="method" type="xsd:string"/> - <xsd:attribute name="working-copy-method" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="collection-table"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface CollectionTable { - String name() default ""; - String catalog() default ""; - String schema() default ""; - JoinColumn[] joinColumns() default {}; - UniqueConstraint[] uniqueConstraints() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="join-column" type="orm:join-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="unique-constraint" type="orm:unique-constraint" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="catalog" type="xsd:string"/> - <xsd:attribute name="schema" type="xsd:string"/> - <xsd:attribute name="creation-suffix" type="xsd:string" /> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="eclipselink-collection-table"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface CollectionTable { - /** - * (Optional) The name of the collection table. If it is not - * specified, it is defaulted to the concatenation of the following: - * the name of the source entity; "_" ; the name of the relationship - * property or field of the source entity. - */ - String name() default ""; - - /** - * (Optional) The catalog of the table. It defaults to the persistence - * unit default catalog. - */ - String catalog() default ""; - - /** - * (Optional) The schema of the table. It defaults to the persistence - * unit default schema. - */ - String schema() default ""; - - /** - * (Optional) Used to specify a primary key column that is used as a - * foreign key to join to another table. If the source entity uses a - * composite primary key, a primary key join column must be specified - * for each field of the composite primary key. In a single primary - * key case, a primary key join column may optionally be specified. - * Defaulting will apply otherwise as follows: - * name, the same name as the primary key column of the primary table - * of the source entity. referencedColumnName, the same name of - * primary key column of the primary table of the source entity. - */ - PrimaryKeyJoinColumn[] primaryKeyJoinColumns() default {}; - - /** - * (Optional) Unique constraints that are to be placed on the table. - * These are only used if table generation is in effect. - */ - UniqueConstraint[] uniqueConstraints() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="primary-key-join-column" type="orm:primary-key-join-column" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="unique-constraint" type="orm:unique-constraint" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="catalog" type="xsd:string"/> - <xsd:attribute name="schema" type="xsd:string"/> - <xsd:attribute name="creation-suffix" type="xsd:string" /> - </xsd:complexType> - - - <!-- **************************************************** --> - - <xsd:complexType name="column"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface Column { - String name() default ""; - boolean unique() default false; - boolean nullable() default true; - boolean insertable() default true; - boolean updatable() default true; - String columnDefinition() default ""; - String table() default ""; - int length() default 255; - int precision() default 0; // decimal precision - int scale() default 0; // decimal scale - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="unique" type="xsd:boolean"/> - <xsd:attribute name="nullable" type="xsd:boolean"/> - <xsd:attribute name="insertable" type="xsd:boolean"/> - <xsd:attribute name="updatable" type="xsd:boolean"/> - <xsd:attribute name="column-definition" type="xsd:string"/> - <xsd:attribute name="table" type="xsd:string"/> - <xsd:attribute name="length" type="xsd:int"/> - <xsd:attribute name="precision" type="xsd:int"/> - <xsd:attribute name="scale" type="xsd:int"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="conversion-value"> - <xsd:annotation> - <xsd:documentation> - - @Target({}) - @Retention(RUNTIME) - public @interface ConversionValue { - /** - * (Required) Specify the database value. - */ - String dataValue(); - - /** - * (Required) Specify the object value. - */ - String objectValue(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="data-value" type="xsd:string" use="required"/> - <xsd:attribute name="object-value" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="converter"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface Converter { - /** - * (Required) Name this converter. The name should be unique across - * the whole persistence unit. - */ - String name(); - - /** - * (Required) The converter class to be used. This class must implement - * the org.eclipse.persistence.mappings.converters.Converter interface. - */ - Class converterClass(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="class" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="partitioning"> - <xsd:annotation> - <xsd:documentation> - - /** - * A Partitioning is used to partition the data for a class across multiple difference databases - * or across a database cluster such as Oracle RAC. - * Partitioning can provide improved scalability by allowing multiple database machines to service requests. - * This annotation configures a custom PartitioningPolicy. - * - * If multiple partitions are used to process a single transaction, JTA should be used for proper XA transaction support. - * - * Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit. - * Partition policies are globally named to allow reuse, - * the partitioning policy must also be set using the @Partitioned annotation to be used. - * - * @see Partitioned - * @see org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface Partitioning { - String name(); - - /** - * (Required) Full package.class name of a subclass of PartitioningPolicy. - */ - Class partitioningClass(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="class" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="hash-partitioning"> - <xsd:annotation> - <xsd:documentation> - - /** - * HashPartitioning partitions access to a database cluster by the hash of a field value from the object, - * such as the object's location, or tenant. - * The hash indexes into the list of connection pools. - * All write or read request for object's with that hash value are sent to the server. - * If a query does not include the field as a parameter, then it can either be sent - * to all server's and unioned, or left to the sesion's default behavior. - * - * Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit. - * - * @see org.eclipse.persistence.descriptors.partitioning.HashPartitioningPolicy - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface HashPartitioning { - String name(); - - /** - * The database column or query parameter to partition queries by. - * This is the table column name, not the class attribute name. - * The column value must be included in the query and should normally be part of the object's Id. - * This can also be the name of a query parameter. - * If a query does not contain the field the query will not be partitioned. - */ - Column partitionColumn(); - - /** - * List of connection pool names to partition across. - */ - String[] connectionPools(); - - /** - * Defines if queries that do not contain the partition field should be sent - * to every database and have the result unioned. - */ - boolean unionUnpartitionableQueries() default false; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="partition-column" type="orm:column"/> - <xsd:element name="connection-pool" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="union-unpartitionable-queries" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="range-partitioning"> - <xsd:annotation> - <xsd:documentation> - - /** - * RangePartitioningPolicy partitions access to a database cluster by a field value from the object, - * such as the object's id, location, or tenant. - * Each server is assigned a range of values. - * All write or read request for object's with that value are sent to the server. - * If a query does not include the field as a parameter, then it can either be sent - * to all server's and unioned, or left to the sesion's default behavior. - * - * If multiple partitions are used to process a single transaction, JTA should be used for proper XA transaction support. - * - * Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit. - * Partition policies are globally named to allow reuse, - * the partitioning policy must also be set using the @Partitioned annotation to be used. - * - * @see Partitioned - * @see org.eclipse.persistence.descriptors.partitioning.RangePartitioningPolicy - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface RangePartitioning { - String name(); - - /** - * The database column or query parameter to partition queries by. - * This is the table column name, not the class attribute name. - * The column value must be included in the query and should normally be part of the object's Id. - * This can also be the name of a query parameter. - * If a query does not contain the field the query will not be partitioned. - */ - Column partitionColumn(); - - /** - * (Required) List of connection pool names to load balance across. - */ - RangePartition[] partitions(); - - /** - * Defines if queries that do not contain the partition field should be sent - * to every database and have the result unioned. - */ - boolean unionUnpartitionableQueries() default false; - - /** The type of the start and end values. */ - Class partitionValueType() default String.class; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="partition-column" type="orm:column"/> - <xsd:element name="partition" type="orm:range-partition" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="union-unpartitionable-queries" type="xsd:boolean"/> - <xsd:attribute name="partition-value-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="range-partition"> - <xsd:annotation> - <xsd:documentation> - - /** - * Represent a specific range partition. - * Values = startValue and = endValue will be routed to the connection pool. - * - * @see RangePartitioningPolicy - * @see org.eclipse.persistence.descriptors.partitioning.RangePartitioningPolicy - * @see org.eclipse.persistence.descriptors.partitioning.RangePartition - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface RangePartition { - /** The String representation of the range start value. */ - String startValue() default ""; - /** The String representation of the range start value. */ - String endValue() default ""; - /** The connection pool to route queries to for this range. */ - String connectionPool(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="start-value" type="xsd:string"/> - <xsd:attribute name="end-value" type="xsd:string"/> - <xsd:attribute name="connection-pool" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="value-partitioning"> - <xsd:annotation> - <xsd:documentation> - - /** - * ValuePartitioning partitions access to a database cluster by a field value from the object, - * such as the object's location, or tenant. - * Each value is assigned a specific server. - * All write or read request for object's with that value are sent to the server. - * If a query does not include the field as a parameter, then it can either be sent - * to all server's and unioned, or left to the sesion's default behavior. - * - * Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit. - * - * @see org.eclipse.persistence.descriptors.partitioning.ValuePartitioningPolicy - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface ValuePartitioning { - String name(); - - /** - * The database column or query parameter to partition queries by. - * This is the table column name, not the class attribute name. - * The column value must be included in the query and should normally be part of the object's Id. - * This can also be the name of a query parameter. - * If a query does not contain the field the query will not be partitioned. - */ - Column partitionColumn(); - - /** Store the value partitions. Each partition maps a value to a connectionPool. */ - ValuePartition[] partitions(); - - /** The type of the start and end values. */ - Class partitionValueType() default String.class; - - /** The default connection pool is used for any unmapped values. */ - String defaultConnectionPool(); - - /** - * Defines if queries that do not contain the partition field should be sent - * to every database and have the result unioned. - */ - boolean unionUnpartitionableQueries() default false; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="partition-column" type="orm:column"/> - <xsd:element name="partition" type="orm:value-partition" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="union-unpartitionable-queries" type="xsd:boolean"/> - <xsd:attribute name="default-connection-pool" type="xsd:string"/> - <xsd:attribute name="partition-value-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="value-partition"> - <xsd:annotation> - <xsd:documentation> - - /** - * Represent a specific value partition. - * The value will be routed to the connection pool. - * - * @see ValuePartitioningPolicy - * @see org.eclipse.persistence.descriptors.partitioning.ValuePartitioningPolicy - * @see org.eclipse.persistence.descriptors.partitioning.ValuePartition - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface ValuePartition { - /** The String representation of the range start value. */ - String value() default ""; - - /** The connection pool to route queries to for this value. */ - String connectionPool(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="value" type="xsd:string" use="required"/> - <xsd:attribute name="connection-pool" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="round-robin-partitioning"> - <xsd:annotation> - <xsd:documentation> - - /** - * RoundRobinPartitioning sends requests in a round robin fashion to the set of connection pools. - * It is for load-balancing read queries across a cluster of database machines. - * It requires that the full database be replicated on each machine, so does not support partitioning. - * The data should either be read-only, or writes should be replicated on the database. - * - * Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit. - * - * @see org.eclipse.persistence.descriptors.partitioning.RoundRobinPolicy - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface RoundRobinPartitioning { - String name(); - - /** - * (Required) List of connection pool names to load balance across. - */ - String[] connectionPools(); - - /** - * This allows for a set of database to be written to and kept in synch, - * and have reads load-balanced across the databases. - */ - boolean replicateWrites() default false; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="connection-pool" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="replicate-writes" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="replication-partitioning"> - <xsd:annotation> - <xsd:documentation> - - /** - * ReplicationPartitioning sends requests to a set of connection pools. - * It is for replicating data across a cluster of database machines. - * Only modification queries are replicated. - * - * Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit. - * - * @see org.eclipse.persistence.descriptors.partitioning.ReplicationPolicy - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface ReplicationPartitioning { - String name(); - - /** - * (Required) List of connection pool names to load balance across. - */ - String[] connectionPools(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="connection-pool" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="union-partitioning"> - <xsd:annotation> - <xsd:documentation> - - /** - * UnionPartitioning sends queries to all connection pools and unions the results. - * This is for queries or relationships that span partitions when partitioning is used, - * such as on a ManyToMany cross partition relationship. - * - * Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit. - * - * @see org.eclipse.persistence.descriptors.partitioning.UnionPartitioningPolicy - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface UnionPartitioning { - String name(); - - /** - * (Required) List of connection pool names to load balance across. - */ - String[] connectionPools(); - - /** - * Defines if write queries should be replicated. - * Writes are normally not replicated when unioning, - * but can be for ManyToMany relationships, when the join table needs to be replicated. - */ - boolean replicateWrites() default false; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="connection-pool" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="replicate-writes" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="pinned-partitioning"> - <xsd:annotation> - <xsd:documentation> - - /** - * PinnedPartitioning pins requests to a single connection pool. - * - * Partitioning can be enabled on an Entity, relationship, query, or session/persistence unit. - * - * @see org.eclipse.persistence.descriptors.partitioning.PinnedPartitioningPolicy - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface PinnedPartitioning { - String name(); - - /** - * The connection pool name to pin queries to. - */ - String connectionPool(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="connection-pool" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="column-result"> - <xsd:annotation> - <xsd:documentation> - - @Target({}) @Retention(RUNTIME) - public @interface ColumnResult { - String name(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="copy-policy"> - <xsd:annotation> - <xsd:documentation> - /** - * A CopyPolicy is used to set a - * org.eclipse.persistence.descriptors.copying.CopyPolicy on an Entity. - * It is required that a class that implements - * org.eclipse.persistence.descriptors.copying.CopyPolicy be specified - * as the argument. - * - * A CopyPolicy should be specified on an Entity, MappedSuperclass or - * Embeddable. - * - * For instance: - * @Entity - * @CopyPolicy("example.MyCopyPolicy") - */ - public @interface CopyPolicy { - - /* - * (Required) - * This defines the class of the copy policy. It must specify a class - * that implements org.eclipse.persistence.descriptors.copying.CopyPolicy - */ - Class value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="class" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="discriminator-column"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface DiscriminatorColumn { - String name() default "DTYPE"; - DiscriminatorType discriminatorType() default STRING; - String columnDefinition() default ""; - int length() default 31; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="discriminator-type" type="orm:discriminator-type"/> - <xsd:attribute name="column-definition" type="xsd:string"/> - <xsd:attribute name="length" type="xsd:int"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="discriminator-class"> - <xsd:annotation> - <xsd:documentation> - - /** - * A DiscriminatorClass is used within a VariableOneToOne annotation. - */ - @Target({}) - @Retention(RUNTIME) - public @interface DiscriminatorClass { - /** - * (Required) The discriminator to be stored on the database. - */ - String discriminator(); - - /** - * (Required) The class to the instantiated with the given - * discriminator. - */ - Class value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="discriminator" type="xsd:string" use="required"/> - <xsd:attribute name="value" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="discriminator-type"> - <xsd:annotation> - <xsd:documentation> - - public enum DiscriminatorType { STRING, CHAR, INTEGER }; - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="STRING"/> - <xsd:enumeration value="CHAR"/> - <xsd:enumeration value="INTEGER"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:simpleType name="discriminator-value"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface DiscriminatorValue { - String value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"/> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="element-collection"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface ElementCollection { - Class targetClass() default void.class; - FetchType fetch() default LAZY; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:choice> - <xsd:element name="order-by" type="orm:order-by" - minOccurs="0"/> - <xsd:element name="order-column" type="orm:order-column" - minOccurs="0"/> - </xsd:choice> - <xsd:choice> - <xsd:element name="map-key" type="orm:map-key" - minOccurs="0"/> - <xsd:sequence> - <xsd:element name="map-key-class" type="orm:map-key-class" - minOccurs="0"/> - <xsd:choice> - <xsd:element name="map-key-temporal" - type="orm:temporal" - minOccurs="0"/> - <xsd:element name="map-key-enumerated" - type="orm:enumerated" - minOccurs="0"/> - <xsd:element name="map-key-convert" type="xsd:string" minOccurs="0"/> - <xsd:sequence> - <xsd:element name="map-key-attribute-override" - type="orm:attribute-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="map-key-association-override" type="orm:association-override" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - </xsd:choice> - <xsd:choice> - <xsd:element name="map-key-column" - type="orm:map-key-column" - minOccurs="0"/> - <xsd:element name="map-key-join-column" - type="orm:map-key-join-column" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:choice> - </xsd:sequence> - </xsd:choice> - <xsd:choice> - <xsd:sequence> - <xsd:element name="column" type="orm:column" minOccurs="0"/> - <xsd:choice> - <xsd:element name="temporal" - type="orm:temporal" - minOccurs="0"/> - <xsd:element name="enumerated" - type="orm:enumerated" - minOccurs="0"/> - <xsd:element name="lob" - type="orm:lob" - minOccurs="0"/> - <xsd:element name="convert" type="xsd:string" minOccurs="0"/> - </xsd:choice> - </xsd:sequence> - <xsd:sequence> - <xsd:element name="attribute-override" - type="orm:attribute-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="association-override" - type="orm:association-override" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - </xsd:choice> - <xsd:choice minOccurs="0" maxOccurs="2"> - <xsd:element name="converter" type="orm:converter"/> - <xsd:element name="type-converter" type="orm:type-converter"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter"/> - <xsd:element name="struct-converter" type="orm:struct-converter"/> - </xsd:choice> - <xsd:element name="collection-table" type="orm:collection-table" - minOccurs="0"/> - <xsd:element name="cascade-on-delete" type="xsd:boolean" minOccurs="0"/> - <xsd:element name="join-fetch" type="orm:join-fetch-type" minOccurs="0"/> - <xsd:element name="batch-fetch" type="orm:batch-fetch" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - - - <xsd:element name="noncacheable" type="orm:emptyType" minOccurs="0"/> - <xsd:element name="delete-all" type="orm:emptyType" minOccurs="0"/> - <xsd:group ref="orm:partitioning-group"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="target-class" type="xsd:string"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - <xsd:attribute name="composite-member" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="array"> - <xsd:annotation> - <xsd:documentation> - - /** - * Array types are extended object-relational data-types supported by some databases. - * Array types are user define types in the database such as VARRAY types on Oracle. - * Arrays can contains basic types (VARCHAR) or other Struct types, and can be stored in - * a column or in a Struct type. - * This annotation can be defined on a collection attribute that is - * persisted to an Array type. The collection can be of basic types, or embeddable - * class mapped using a Struct. - * - * @see org.eclipse.persistence.mappings.structures.ObjectRelationalDataTypeDescriptor - * @see org.eclipse.persistence.mappings.structures.ArrayMapping - * @see org.eclipse.persistence.mappings.structures.ObjectArrayMapping - * @author James Sutherland - * @since EclipseLink 2.3 - */ - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface Array { - /** - * (Optional) The basic or embeddable class that is the element - * type of the collection. This element is optional only if the - * collection field or property is defined using Java generics, - * and must be specified otherwise. It defaults to the - * paramterized type of the collection when defined using - * generics. - */ - Class targetClass() default void.class; - - /** - * (Required) The database name of the database array structure type. - */ - String databaseType(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="column" type="orm:column" minOccurs="0"/> - <xsd:choice> - <xsd:element name="temporal" - type="orm:temporal" - minOccurs="0"/> - <xsd:element name="enumerated" - type="orm:enumerated" - minOccurs="0"/> - <xsd:element name="lob" - type="orm:lob" - minOccurs="0"/> - <xsd:element name="convert" type="xsd:string" minOccurs="0"/> - </xsd:choice> - <xsd:choice minOccurs="0" maxOccurs="2"> - <xsd:element name="converter" type="orm:converter"/> - <xsd:element name="type-converter" type="orm:type-converter"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter"/> - <xsd:element name="struct-converter" type="orm:struct-converter"/> - </xsd:choice> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="database-type" type="xsd:string" use="required"/> - <xsd:attribute name="target-class" type="xsd:string"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="embeddable"> - <xsd:annotation> - <xsd:documentation> - - Defines the settings and mappings for embeddable objects. Is - allowed to be sparsely populated and used in conjunction with - the annotations. Alternatively, the metadata-complete attribute - can be used to indicate that no annotations are to be processed - in the class. If this is the case then the defaulting rules will - be recursively applied. - - @Target({TYPE}) @Retention(RUNTIME) - public @interface Embeddable {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="customizer" type="orm:customizer" minOccurs="0"/> - <xsd:element name="change-tracking" type="orm:change-tracking" minOccurs="0"/> - <xsd:element name="struct" type="orm:struct" minOccurs="0"/> - <xsd:element name="converter" type="orm:converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="type-converter" type="orm:type-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="struct-converter" type="orm:struct-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="copy-policy" type="orm:copy-policy" minOccurs="0" maxOccurs="1"/> - <xsd:element name="instantiation-copy-policy" type="orm:instantiation-copy-policy" minOccurs="0" maxOccurs="1"/> - <xsd:element name="clone-copy-policy" type="orm:clone-copy-policy" minOccurs="0" maxOccurs="1"/> - <xsd:element name="plsql-record" type="orm:plsql-record" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="plsql-table" type="orm:plsql-table" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="attribute-override" type="orm:attribute-override" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="association-override" type="orm:association-override" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="attributes" type="orm:attributes" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="class" type="xsd:string" use="required"/> - <xsd:attribute name="parent-class" type="xsd:string"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="metadata-complete" type="xsd:boolean"/> - <xsd:attribute name="exclude-default-mappings" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="embedded"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface Embedded {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="attribute-override" type="orm:attribute-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="association-override" - type="orm:association-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="embedded-id"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface EmbeddedId {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="attribute-override" type="orm:attribute-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="entity-listener"> - <xsd:annotation> - <xsd:documentation> - - Defines an entity listener to be invoked at lifecycle events - for the entities that list this listener. - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="pre-persist" type="orm:pre-persist" minOccurs="0"/> - <xsd:element name="post-persist" type="orm:post-persist" - minOccurs="0"/> - <xsd:element name="pre-remove" type="orm:pre-remove" minOccurs="0"/> - <xsd:element name="post-remove" type="orm:post-remove" minOccurs="0"/> - <xsd:element name="pre-update" type="orm:pre-update" minOccurs="0"/> - <xsd:element name="post-update" type="orm:post-update" minOccurs="0"/> - <xsd:element name="post-load" type="orm:post-load" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="class" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="entity-listeners"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface EntityListeners { - Class[] value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="entity-listener" type="orm:entity-listener" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="entity-result"> - <xsd:annotation> - <xsd:documentation> - - @Target({}) @Retention(RUNTIME) - public @interface EntityResult { - Class entityClass(); - FieldResult[] fields() default {}; - String discriminatorColumn() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="field-result" type="orm:field-result" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="entity-class" type="xsd:string" use="required"/> - <xsd:attribute name="discriminator-column" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="enum-type"> - <xsd:annotation> - <xsd:documentation> - - public enum EnumType { - ORDINAL, - STRING - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="ORDINAL"/> - <xsd:enumeration value="STRING"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:simpleType name="enumerated"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface Enumerated { - EnumType value() default ORDINAL; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="orm:enum-type"/> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="fetch-attribute"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) - @Retention(RUNTIME) - public @interface FetchAttribute { - /** - * (Required) The fetch attribute name. - */ - String name(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="fetch-group"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) - @Retention(RUNTIME) - public @interface FetchGroup { - /** - * (Required) The fetch group name. - */ - String name(); - - /** - * (Optional) Indicates whether all relationship attributes - * specified in the fetch group should be loaded. - */ - boolean load() default true; - - /** - * (Required) The list of attributes to fetch. - */ - FetchAttribute[] attributes(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="attribute" type="orm:fetch-attribute" minOccurs="1" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="load" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="fetch-type"> - <xsd:annotation> - <xsd:documentation> - - public enum FetchType { LAZY, EAGER }; - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="LAZY"/> - <xsd:enumeration value="EAGER"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="field-result"> - <xsd:annotation> - <xsd:documentation> - - @Target({}) @Retention(RUNTIME) - public @interface FieldResult { - String name(); - String column(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="column" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="generated-value"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface GeneratedValue { - GenerationType strategy() default AUTO; - String generator() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="strategy" type="orm:generation-type"/> - <xsd:attribute name="generator" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="generation-type"> - <xsd:annotation> - <xsd:documentation> - - public enum GenerationType { TABLE, SEQUENCE, IDENTITY, AUTO }; - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="TABLE"/> - <xsd:enumeration value="SEQUENCE"/> - <xsd:enumeration value="IDENTITY"/> - <xsd:enumeration value="AUTO"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="id"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface Id {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="column" type="orm:column" - minOccurs="0"/> - <xsd:element name="index" type="orm:index" minOccurs="0"/> - <xsd:element name="cache-index" type="orm:cache-index" minOccurs="0"/> - <xsd:element name="generated-value" type="orm:generated-value" - minOccurs="0"/> - <xsd:choice minOccurs="0"> - <xsd:element name="temporal" type="orm:temporal"/> - <xsd:element name="enumerated" type="orm:enumerated"/> - <xsd:element name="convert" type="xsd:string"/> - </xsd:choice> - <xsd:choice minOccurs="0"> - <xsd:element name="converter" type="orm:converter"/> - <xsd:element name="type-converter" type="orm:type-converter"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter"/> - <xsd:element name="struct-converter" type="orm:struct-converter"/> - </xsd:choice> - <xsd:element name="table-generator" type="orm:table-generator" - minOccurs="0"/> - <xsd:element name="sequence-generator" type="orm:sequence-generator" - minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="mutable" type="xsd:boolean"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="id-class"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface IdClass { - Class value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="class" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="id-validation"> - <xsd:annotation> - <xsd:documentation> - - /** - * The IdValidation enum determines the type value that are valid for an Id. - * By default null is not allowed, and 0 is not allow for singleton ids of long or int type. - * The default value is ZERO for singleton ids, and NULL for composite ids. - * This can be set using the @PrimaryKey annotation, or ClassDescriptor API. - * - * @see PrimaryKey - * @see org.eclipse.persistence.descriptors.ClassDescriptor#setIdValidation(IdValidation) - * @author James Sutherland - * @since EclipseLink 1.0 - */ - public enum IdValidation { - /** - * Only null is not allowed as an id value, 0 is allowed. - */ - NULL, - - /** - * null and 0 are not allowed, (only int and long). - */ - ZERO, - - /** - * No id validation is done. - */ - NONE - } - - </xsd:documentation> - </xsd:annotation> - - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="NULL"/> - <xsd:enumeration value="ZERO"/> - <xsd:enumeration value="NONE"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:simpleType name="cache-key-type"> - <xsd:annotation> - <xsd:documentation> - - /** - * Configures what type of Id value is used to store the object in the cache. - * This can either be the basic Id value for simple singleton Ids, - * or an optimized CacheKey type. - * - * @see PrimaryKey#cacheKeyType() - * @see ClassDescriptor#setCacheKeyType(CacheKeyType) - * @author James Sutherland - * @since EclipseLink 2.1 - */ - public enum CacheKeyType { - /** - * This can only be used for simple singleton Ids, such as long/int/String. - * This is the default for simple singleton Ids. - */ - ID_VALUE, - - /** - * Optimized cache key type that allows composite and complex values. - * This is the default for composite or complex Ids. - */ - CACHE_KEY, - - /** - * The cache key type is automatically configured depending on what is optimal for the class. - */ - AUTO - } - - </xsd:documentation> - </xsd:annotation> - - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="ID_VALUE"/> - <xsd:enumeration value="CACHE_KEY"/> - <xsd:enumeration value="AUTO"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="inheritance"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface Inheritance { - InheritanceType strategy() default SINGLE_TABLE; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="strategy" type="orm:inheritance-type"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="inheritance-type"> - <xsd:annotation> - <xsd:documentation> - - public enum InheritanceType - { SINGLE_TABLE, JOINED, TABLE_PER_CLASS}; - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="SINGLE_TABLE"/> - <xsd:enumeration value="JOINED"/> - <xsd:enumeration value="TABLE_PER_CLASS"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="instantiation-copy-policy"> - <xsd:annotation> - <xsd:documentation> - /** - * An InstantiationCopyPolicy is used to set an - * org.eclipse.persistence.descriptors.copying.InstantiationCopyPolicy - * on an Entity. InstantiationCopyPolicy is the default CopyPolicy in - * EclipseLink and therefore this configuration option is only used to - * override other types of copy policies - * - * An InstantiationCopyPolicy should be specified on an Entity, - * MappedSuperclass or Embeddable. - * - * Example: - * @Entity - * @InstantiationCopyPolicy - */ - public @interface InstantiationCopyPolicy { - } - </xsd:documentation> - </xsd:annotation> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="join-column"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface JoinColumn { - String name() default ""; - String referencedColumnName() default ""; - boolean unique() default false; - boolean nullable() default true; - boolean insertable() default true; - boolean updatable() default true; - String columnDefinition() default ""; - String table() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="referenced-column-name" type="xsd:string"/> - <xsd:attribute name="unique" type="xsd:boolean"/> - <xsd:attribute name="nullable" type="xsd:boolean"/> - <xsd:attribute name="insertable" type="xsd:boolean"/> - <xsd:attribute name="updatable" type="xsd:boolean"/> - <xsd:attribute name="column-definition" type="xsd:string"/> - <xsd:attribute name="table" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="join-fetch-type"> - <xsd:annotation> - <xsd:documentation> - - public enum JoinFetchType { - /** - * An inner join is used to fetch the related object. - * This does not allow for null/empty values. - */ - INNER, - - /** - * An inner join is used to fetch the related object. - * This allows for null/empty values. - */ - OUTER, - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="INNER"/> - <xsd:enumeration value="OUTER"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:simpleType name="batch-fetch-type"> - <xsd:annotation> - <xsd:documentation> - public enum BatchFetchType { - /** - * This is the default form of batch reading. - * The original query's selection criteria is joined with the batch query. - */ - JOIN, - - /** - * This uses an SQL EXISTS and a sub-select in the batch query instead of a join. - * This has the advantage of not requiring an SQL DISTINCT which can have issues - * with LOBs, or may be more efficient for some types of queries or on some databases. - */ - EXISTS, - - /** - * This uses an SQL IN clause in the batch query passing in the source object Ids. - * This has the advantage of only selecting the objects not already contained in the cache, - * and can work better with cursors, or if joins cannot be used. - * This may only work for singleton Ids on some databases. - */ - IN - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="JOIN"/> - <xsd:enumeration value="EXISTS"/> - <xsd:enumeration value="IN"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="join-table"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface JoinTable { - String name() default ""; - String catalog() default ""; - String schema() default ""; - JoinColumn[] joinColumns() default {}; - JoinColumn[] inverseJoinColumns() default {}; - UniqueConstraint[] uniqueConstraints() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="join-column" type="orm:join-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="inverse-join-column" type="orm:join-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="unique-constraint" type="orm:unique-constraint" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="catalog" type="xsd:string"/> - <xsd:attribute name="schema" type="xsd:string"/> - <xsd:attribute name="creation-suffix" type="xsd:string" /> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="lob"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface Lob {} - - </xsd:documentation> - </xsd:annotation> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="lock-mode-type"> - <xsd:annotation> - <xsd:documentation> - - public enum LockModeType { READ, WRITE, OPTIMISTIC, OPTIMISTIC_FORCE_INCREMENT, PESSIMISTIC_READ, PESSIMISTIC_WRITE, PESSIMISTIC_FORCE_INCREMENT, NONE}; - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="READ"/> - <xsd:enumeration value="WRITE"/> - <xsd:enumeration value="OPTIMISTIC"/> - <xsd:enumeration value="OPTIMISTIC_FORCE_INCREMENT"/> - <xsd:enumeration value="PESSIMISTIC_READ"/> - <xsd:enumeration value="PESSIMISTIC_WRITE"/> - <xsd:enumeration value="PESSIMISTIC_FORCE_INCREMENT"/> - <xsd:enumeration value="NONE"/> - - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="many-to-many"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface ManyToMany { - Class targetEntity() default void.class; - CascadeType[] cascade() default {}; - FetchType fetch() default LAZY; - String mappedBy() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:choice> - <xsd:element name="order-by" type="orm:order-by" - minOccurs="0"/> - <xsd:element name="order-column" type="orm:order-column" - minOccurs="0"/> - </xsd:choice> - <xsd:choice> - <xsd:element name="map-key" type="orm:map-key" - minOccurs="0"/> - <xsd:sequence> - <xsd:element name="map-key-class" type="orm:map-key-class" - minOccurs="0"/> - <xsd:choice> - <xsd:element name="map-key-temporal" - type="orm:temporal" - minOccurs="0"/> - <xsd:element name="map-key-enumerated" - type="orm:enumerated" - minOccurs="0"/> - <xsd:element name="map-key-convert" type="xsd:string" minOccurs="0"/> - <xsd:choice> - <xsd:element name="map-key-attribute-override" - type="orm:attribute-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="map-key-association-override" type="orm:association-override" minOccurs="0" maxOccurs="unbounded"/> - </xsd:choice> - </xsd:choice> - <xsd:choice> - <xsd:element name="map-key-column" type="orm:map-key-column" - minOccurs="0"/> - <xsd:element name="map-key-join-column" - type="orm:map-key-join-column" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:choice> - </xsd:sequence> - </xsd:choice> - <xsd:choice minOccurs="0" maxOccurs="1"> - <xsd:element name="converter" type="orm:converter"/> - <xsd:element name="type-converter" type="orm:type-converter"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter"/> - <xsd:element name="struct-converter" type="orm:struct-converter"/> - </xsd:choice> - <xsd:element name="join-table" type="orm:join-table" - minOccurs="0"/> - <xsd:element name="cascade" type="orm:cascade-type" - minOccurs="0"/> - <xsd:element name="cascade-on-delete" type="xsd:boolean" minOccurs="0"/> - <xsd:element name="join-fetch" type="orm:join-fetch-type" minOccurs="0"/> - <xsd:element name="batch-fetch" type="orm:batch-fetch" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="noncacheable" type="orm:emptyType" minOccurs="0"/> - <xsd:group ref="orm:partitioning-group"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="target-entity" type="xsd:string"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="mapped-by" type="xsd:string"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="many-to-one"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface ManyToOne { - Class targetEntity() default void.class; - CascadeType[] cascade() default {}; - FetchType fetch() default EAGER; - boolean optional() default true; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:choice> - <xsd:element name="join-column" type="orm:join-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="join-table" type="orm:join-table" - minOccurs="0"/> - </xsd:choice> - <xsd:element name="cascade" type="orm:cascade-type" - minOccurs="0"/> - <xsd:element name="join-fetch" type="orm:join-fetch-type" minOccurs="0"/> - <xsd:element name="batch-fetch" type="orm:batch-fetch" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="noncacheable" type="orm:emptyType" minOccurs="0"/> - <xsd:group ref="orm:partitioning-group"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="target-entity" type="xsd:string"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="optional" type="xsd:boolean"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="maps-id" type="xsd:string"/> - <xsd:attribute name="id" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="map-key"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface MapKey { - String name() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="map-key-class"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface MapKeyClass { - Class value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="class" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="map-key-column"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface MapKeyColumn { - String name() default ""; - boolean unique() default false; - boolean nullable() default false; - boolean insertable() default true; - boolean updatable() default true; - String columnDefinition() default ""; - String table() default ""; - int length() default 255; - int precision() default 0; // decimal precision - int scale() default 0; // decimal scale - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="unique" type="xsd:boolean"/> - <xsd:attribute name="nullable" type="xsd:boolean"/> - <xsd:attribute name="insertable" type="xsd:boolean"/> - <xsd:attribute name="updatable" type="xsd:boolean"/> - <xsd:attribute name="column-definition" type="xsd:string"/> - <xsd:attribute name="table" type="xsd:string"/> - <xsd:attribute name="length" type="xsd:int"/> - <xsd:attribute name="precision" type="xsd:int"/> - <xsd:attribute name="scale" type="xsd:int"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="map-key-join-column"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface MapKeyJoinColumn { - String name() default ""; - String referencedColumnName() default ""; - boolean unique() default false; - boolean nullable() default false; - boolean insertable() default true; - boolean updatable() default true; - String columnDefinition() default ""; - String table() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="referenced-column-name" type="xsd:string"/> - <xsd:attribute name="unique" type="xsd:boolean"/> - <xsd:attribute name="nullable" type="xsd:boolean"/> - <xsd:attribute name="insertable" type="xsd:boolean"/> - <xsd:attribute name="updatable" type="xsd:boolean"/> - <xsd:attribute name="column-definition" type="xsd:string"/> - <xsd:attribute name="table" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="mapped-superclass"> - <xsd:annotation> - <xsd:documentation> - - Defines the settings and mappings for a mapped superclass. Is - allowed to be sparsely populated and used in conjunction with - the annotations. Alternatively, the metadata-complete attribute - can be used to indicate that no annotations are to be processed - If this is the case then the defaulting rules will be recursively - applied. - - @Target(TYPE) @Retention(RUNTIME) - public @interface MappedSuperclass{} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="multitenant" type="orm:multitenant" minOccurs="0"/> - <xsd:element name="additional-criteria" type="orm:additional-criteria" minOccurs="0"/> - <xsd:element name="customizer" type="orm:customizer" minOccurs="0"/> - <xsd:element name="change-tracking" type="orm:change-tracking" minOccurs="0"/> - <xsd:element name="id-class" type="orm:id-class" minOccurs="0"/> - <xsd:element name="primary-key" type="orm:primary-key" minOccurs="0"/> - <xsd:element name="optimistic-locking" type="orm:optimistic-locking" minOccurs="0"/> - <xsd:element name="cache" type="orm:cache" minOccurs="0"/> - <xsd:element name="cache-interceptor" type="orm:cache-interceptor" minOccurs="0"/> - <xsd:element name="cache-index" type="orm:cache-index" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="fetch-group" type="orm:fetch-group" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="converter" type="orm:converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="type-converter" type="orm:type-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="struct-converter" type="orm:struct-converter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="copy-policy" type="orm:copy-policy" minOccurs="0" maxOccurs="1"/> - <xsd:element name="instantiation-copy-policy" type="orm:instantiation-copy-policy" minOccurs="0" maxOccurs="1"/> - <xsd:element name="clone-copy-policy" type="orm:clone-copy-policy" minOccurs="0" maxOccurs="1"/> - <xsd:element name="sequence-generator" type="orm:sequence-generator" - minOccurs="0"/> - <xsd:element name="table-generator" type="orm:table-generator" - minOccurs="0"/> - <xsd:group ref="orm:partitioning-group"/> - <xsd:element name="named-query" type="orm:named-query" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-native-query" type="orm:named-native-query" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-stored-procedure-query" type="orm:named-stored-procedure-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-stored-function-query" type="orm:named-stored-function-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-plsql-stored-procedure-query" type="orm:named-plsql-stored-procedure-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="named-plsql-stored-function-query" type="orm:named-plsql-stored-function-query" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="plsql-record" type="orm:plsql-record" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="plsql-table" type="orm:plsql-table" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="sql-result-set-mapping" - type="orm:sql-result-set-mapping" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="query-redirectors" type="orm:query-redirectors" minOccurs="0" maxOccurs="1"/> - <xsd:element name="exclude-default-listeners" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="exclude-superclass-listeners" type="orm:emptyType" - minOccurs="0"/> - <xsd:element name="entity-listeners" type="orm:entity-listeners" - minOccurs="0"/> - <xsd:element name="pre-persist" type="orm:pre-persist" minOccurs="0"/> - <xsd:element name="post-persist" type="orm:post-persist" - minOccurs="0"/> - <xsd:element name="pre-remove" type="orm:pre-remove" minOccurs="0"/> - <xsd:element name="post-remove" type="orm:post-remove" minOccurs="0"/> - <xsd:element name="pre-update" type="orm:pre-update" minOccurs="0"/> - <xsd:element name="post-update" type="orm:post-update" minOccurs="0"/> - <xsd:element name="post-load" type="orm:post-load" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="attribute-override" type="orm:attribute-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="association-override" - type="orm:association-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="attributes" type="orm:attributes" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="class" type="xsd:string" use="required"/> - <xsd:attribute name="parent-class" type="xsd:string"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="cacheable" type="xsd:boolean"/> - <xsd:attribute name="metadata-complete" type="xsd:boolean"/> - <xsd:attribute name="read-only" type="xsd:boolean"/> - <xsd:attribute name="existence-checking" type="orm:existence-type"/> - <xsd:attribute name="exclude-default-mappings" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="multitenant"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) - @Retention(RUNTIME) - public @interface Multitenant { - /** - * (Optional) Specify the multi-tenant strategy to use. - */ - MultitenantType value() default MultitenantType.SINGLE_TABLE; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="tenant-discriminator-column" type="orm:tenant-discriminator-column" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="type" type="orm:multitenant-type"/> - <xsd:attribute name="include-criteria" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="multitenant-type"> - <xsd:annotation> - <xsd:documentation> - - public enum MultitenantType { - /** - * Specifies that table(s) the entity maps to includes rows for multiple - * tenants. The tenant discriminator column(s) are used with application - * context values to limit what a persistence context can access. - */ - SINGLE_TABLE, - - /** - * Specifies that different tables are used for each tenant. The table scan - * be uniquely identified by name, schema/tablespace. - */ - TABLE_PER_TENANT, - - /** - * Specifies that the DB will handle the tenant filtering on all SELECT, - * UPDATE and DELETE queries. Using this type assumes that the platform - * used with your persistence unit does indeed support VPD. - */ - VPD - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="SINGLE_TABLE"/> - <xsd:enumeration value="TABLE_PER_TENANT"/> - <xsd:enumeration value="VPD"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="named-native-query"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface NamedNativeQuery { - String name(); - String query(); - QueryHint[] hints() default {}; - Class resultClass() default void.class; - String resultSetMapping() default ""; //named SqlResultSetMapping - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="query" type="xsd:string"/> - <xsd:element name="hint" type="orm:query-hint" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="result-class" type="xsd:string"/> - <xsd:attribute name="result-set-mapping" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="named-query"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface NamedQuery { - String name(); - String query(); - LockModeType lockMode() default NONE; - QueryHint[] hints() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="query" type="xsd:string"/> - <xsd:element name="lock-mode" type="orm:lock-mode-type" minOccurs="0"/> - <xsd:element name="hint" type="orm:query-hint" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="named-stored-procedure-query"> - <xsd:annotation> - <xsd:documentation> - - /** - * A NamedStoredProcedureQuery annotation allows the definition of - * queries that call stored procedures as named queries. - * A NamedStoredProcedureQuery annotation may be defined on an Entity or - * MappedSuperclass. - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface NamedStoredProcedureQuery { - /** - * (Required) Unique name that references this stored procedure query. - */ - String name(); - - /** - * (Optional) Query hints. - */ - QueryHint[] hints() default {}; - - /** - * (Optional) Refers to the class of the result. - */ - Class resultClass() default void.class; - - /** - * (Optional) The name of the SQLResultMapping. - */ - String resultSetMapping() default ""; - - /** - * (Required) The name of the stored procedure. - */ - String procedureName(); - - /** - * (Optional) Whether the query should return a result set. - */ - boolean returnsResultSet() default true; - - /** - * (Optional) Defines if the stored procedure returns multiple result sets. - * This is only relevant on databases that support multiple result sets from stored procedures. - */ - boolean multipleResultSets() default false; - - /** - * (Optional) Defines if the stored procedure should be called by index or by name. - * By index requires that the StoredProcedureParameter are defined in the same order as the procedure on the database. - * By name requires the database platform support naming procedure parameters. - */ - boolean callByIndex() default false; - - /** - * (Optional) Defines arguments to the stored procedure. - */ - StoredProcedureParameter[] parameters() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="hint" type="orm:query-hint" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="parameter" type="orm:stored-procedure-parameter" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="result-class" type="xsd:string"/> - <xsd:attribute name="result-set-mapping" type="xsd:string"/> - <xsd:attribute name="procedure-name" type="xsd:string" use="required"/> - <xsd:attribute name="returns-result-set" type="xsd:boolean"/> - <xsd:attribute name="multiple-result-sets" type="xsd:boolean"/> - <xsd:attribute name="call-by-index" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="named-stored-function-query"> - <xsd:annotation> - <xsd:documentation> - - /** - * A NamedStoredFunctionQuery annotation allows the definition of - * queries that call stored function as named queries. - * A NamedStoredFunctionQuery annotation may be defined on an Entity or - * MappedSuperclass. - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface NamedStoredFunctionQuery { - /** - * (Required) Unique name that references this stored procedure query. - */ - String name(); - - /** - * (Optional) Query hints. - */ - QueryHint[] hints() default {}; - - /** - * (Optional) The name of the SQLResultMapping. - */ - String resultSetMapping() default ""; - - /** - * (Required) The name of the stored procedure. - */ - String functionName(); - - /** - * (Optional) Defines if the stored procedure should be called by index or by name. - * By index requires that the StoredProcedureParameter are defined in the same order as the procedure on the database. - * By name requires the database platform support naming procedure parameters. - */ - boolean callByIndex() default false; - - /** - * (Optional) Defines arguments to the stored procedure. - */ - StoredProcedureParameter[] parameters() default {}; - - /** - * (Required) Defines return of the stored function. - */ - StoredProcedureParameter[] returnParameter(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="hint" type="orm:query-hint" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="parameter" type="orm:stored-procedure-parameter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="return-parameter" type="orm:stored-procedure-parameter" minOccurs="1"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="result-set-mapping" type="xsd:string"/> - <xsd:attribute name="function-name" type="xsd:string" use="required"/> - <xsd:attribute name="call-by-index" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="named-plsql-stored-function-query"> - <xsd:annotation> - <xsd:documentation> - - /** - * A NamedPLSQLStoredFunctionQuery annotation allows the definition of queries that - * call PLSQL stored functions as named queries. - * The PLSQL support adds support for complex PLSQL types such as RECORD and TABLE types, - * that are not accessible from JDBC. - * - * A NamedPLSQLStoredFunctionQuery annotation may be defined on an Entity or - * MappedSuperclass. - * - * @author James Sutherland - * @since EclipseLink 2.3 - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface NamedPLSQLStoredFunctionQuery { - /** - * (Required) Unique name that references this stored procedure query. - */ - String name(); - - /** - * (Optional) Query hints. - */ - QueryHint[] hints() default {}; - - /** - * (Optional) The name of the SQLResultMapping. - */ - String resultSetMapping() default ""; - - /** - * (Required) The name of the stored procedure. - */ - String functionName(); - - /** - * (Optional) Defines the parameters to the stored procedure. - */ - PLSQLParameter[] parameters() default {}; - - /** - * (Required) Defines the return value of the stored function. - */ - PLSQLParameter returnParameter(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="hint" type="orm:query-hint" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="parameter" type="orm:plsql-parameter" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="return-parameter" type="orm:plsql-parameter" minOccurs="1"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="result-set-mapping" type="xsd:string"/> - <xsd:attribute name="function-name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="named-plsql-stored-procedure-query"> - <xsd:annotation> - <xsd:documentation> - - /** - * A PLSQLNamedStoredProcedureQuery annotation allows the definition of queries that - * call PLSQL stored procedures as named queries. - * The PLSQL support adds support for complex PLSQL types such as RECORD and TABLE types, - * that are not accessible from JDBC. - * - * A PLSQLNamedStoredProcedureQuery annotation may be defined on an Entity or - * MappedSuperclass. - * - * @author James Sutherland - * @since EclipseLink 2.3 - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface NamedPLSQLStoredProcedureQuery { - /** - * (Required) Unique name that references this stored procedure query. - */ - String name(); - - /** - * (Optional) Query hints. - */ - QueryHint[] hints() default {}; - - /** - * (Optional) Refers to the class of the result. - */ - Class resultClass() default void.class; - - /** - * (Optional) The name of the SQLResultMapping. - */ - String resultSetMapping() default ""; - - /** - * (Required) The name of the stored procedure. - */ - String procedureName(); - - /** - * (Optional) Defines the parameters to the stored procedure. - */ - PLSQLParameter[] parameters() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="hint" type="orm:query-hint" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="parameter" type="orm:plsql-parameter" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="result-class" type="xsd:string"/> - <xsd:attribute name="result-set-mapping" type="xsd:string"/> - <xsd:attribute name="procedure-name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="plsql-record"> - <xsd:annotation> - <xsd:documentation> - - /** - * A PLSQLRecord annotation is used to define a database PLSQL RECORD type. - * This type can be used within PLSQL procedure calls. - * - * @see NamedPLSQLStoredProcedureQuery - * @author James Sutherland - * @since EclipseLink 2.3 - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface PLSQLRecord { - - /** - * (Required) The name of the record type in the database. - */ - String name(); - - /** - * (Required) The name of the database OBJECT TYPE that mirrors the record's structure. - * The record will be converted to/from this type so it can be passed through JDBC. - */ - String compatibleType(); - - /** - * (Optional) The Java class to map the object-type to. - * This class must be mapped using a @Struct annotation. - */ - Class javaType() default void.class; - - /** - * (Required) Defines the fields in the record type. - */ - PLSQLParameter[] fields(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="field" type="orm:plsql-parameter" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="compatible-type" type="xsd:string"/> - <xsd:attribute name="java-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="plsql-table"> - <xsd:annotation> - <xsd:documentation> - - /** - * A PLSQLRecord annotation is used to define a database PLSQL RECORD type. - * This type can be used within PLSQL procedure calls. - * - * @see NamedPLSQLStoredProcedureQuery - * @author James Sutherland - * @since EclipseLink 2.3 - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface PLSQLRecord { - - /** - * (Required) The name of the record type in the database. - */ - String name(); - - /** - * (Required) The name of the database OBJECT TYPE that mirrors the record's structure. - * The record will be converted to/from this type so it can be passed through JDBC. - */ - String compatibleType(); - - /** - * (Optional) The Java class to map the object-type to. - * This class must be mapped using a @Struct annotation. - */ - Class javaType() default void.class; - - /** - * (Required) Defines the fields in the record type. - */ - PLSQLParameter[] fields(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="compatible-type" type="xsd:string"/> - <xsd:attribute name="java-type" type="xsd:string"/> - <xsd:attribute name="nested-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="object-type-converter"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface ObjectTypeConverter { - /** - * (Required) Name this converter. The name should be unique - * across the whole persistence unit. - */ - String name(); - - /** - * (Optional) Specify the type stored on the database. The - * default is inferred from the type of the persistence - * field or property. - */ - Class dataType() default void.class; - - /** - * (Optional) Specify the type stored on the entity. The - * default is inferred from the type of the persistent - * field or property. - */ - Class objectType() default void.class; - - /** - * (Required) Specify the conversion values to be used - * with the object converter. - */ - ConversionValue[] conversionValues(); - - /** - * (Optional) Specify a default object value. Used for - * legacy data if the data value is missing. - */ - String defaultObjectValue() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="conversion-value" type="orm:conversion-value" minOccurs="1" maxOccurs="unbounded"/> - <xsd:element name="default-object-value" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="data-type" type="xsd:string"/> - <xsd:attribute name="object-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="one-to-many"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface OneToMany { - Class targetEntity() default void.class; - CascadeType[] cascade() default {}; - FetchType fetch() default LAZY; - String mappedBy() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:choice> - <xsd:element name="order-by" type="orm:order-by" - minOccurs="0"/> - <xsd:element name="order-column" type="orm:order-column" - minOccurs="0"/> - </xsd:choice> - <xsd:choice> - <xsd:element name="map-key" type="orm:map-key" - minOccurs="0"/> - <xsd:sequence> - <xsd:element name="map-key-class" type="orm:map-key-class" - minOccurs="0"/> - <xsd:choice> - <xsd:element name="map-key-temporal" - type="orm:temporal" - minOccurs="0"/> - <xsd:element name="map-key-enumerated" - type="orm:enumerated" - minOccurs="0"/> - <xsd:element name="map-key-convert" type="xsd:string" minOccurs="0"/> - <xsd:choice> - <xsd:element name="map-key-attribute-override" - type="orm:attribute-override" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="map-key-association-override" type="orm:association-override" minOccurs="0" maxOccurs="unbounded"/> - </xsd:choice> - </xsd:choice> - <xsd:choice> - <xsd:element name="map-key-column" type="orm:map-key-column" - minOccurs="0"/> - <xsd:element name="map-key-join-column" - type="orm:map-key-join-column" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:choice> - </xsd:sequence> - </xsd:choice> - <xsd:choice minOccurs="0" maxOccurs="1"> - <xsd:element name="converter" type="orm:converter"/> - <xsd:element name="type-converter" type="orm:type-converter"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter"/> - <xsd:element name="struct-converter" type="orm:struct-converter"/> - </xsd:choice> - <xsd:choice> - <xsd:element name="join-table" type="orm:join-table" - minOccurs="0"/> - <xsd:element name="join-column" type="orm:join-column" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:choice> - <xsd:element name="cascade" type="orm:cascade-type" - minOccurs="0"/> - <xsd:element name="cascade-on-delete" type="xsd:boolean" minOccurs="0"/> - <xsd:element name="private-owned" type="orm:emptyType" minOccurs="0"/> - <xsd:element name="join-fetch" type="orm:join-fetch-type" minOccurs="0"/> - <xsd:element name="batch-fetch" type="orm:batch-fetch" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="noncacheable" type="orm:emptyType" minOccurs="0"/> - <xsd:element name="delete-all" type="orm:emptyType" minOccurs="0"/> - <xsd:group ref="orm:partitioning-group"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="target-entity" type="xsd:string"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="mapped-by" type="xsd:string"/> - <xsd:attribute name="orphan-removal" type="xsd:boolean"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="one-to-one"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface OneToOne { - Class targetEntity() default void.class; - CascadeType[] cascade() default {}; - FetchType fetch() default EAGER; - boolean optional() default true; - String mappedBy() default ""; - boolean orphanRemoval() default false; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:choice> - <xsd:element name="primary-key-join-column" - type="orm:primary-key-join-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="join-column" type="orm:join-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="join-table" type="orm:join-table" - minOccurs="0"/> - </xsd:choice> - <xsd:element name="cascade" type="orm:cascade-type" - minOccurs="0"/> - <xsd:element name="cascade-on-delete" type="xsd:boolean" minOccurs="0"/> - <xsd:element name="private-owned" type="orm:emptyType" minOccurs="0"/> - <xsd:element name="join-fetch" type="orm:join-fetch-type" minOccurs="0"/> - <xsd:element name="batch-fetch" type="orm:batch-fetch" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="noncacheable" type="orm:emptyType" minOccurs="0"/> - <xsd:group ref="orm:partitioning-group"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="target-entity" type="xsd:string"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="optional" type="xsd:boolean"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="mapped-by" type="xsd:string"/> - <xsd:attribute name="orphan-removal" type="xsd:boolean"/> - <xsd:attribute name="maps-id" type="xsd:string"/> - <xsd:attribute name="id" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="optimistic-locking"> - <xsd:annotation> - <xsd:documentation> - - /** - * An optimistic-locking element is used to specify the type of - * optimistic locking EclipseLink should use when updating or deleting - * entities. An optimistic-locking specification is supported on - * an entity or mapped-superclass. - * - * It is used in conjunction with the optimistic-locking-type. - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface OptimisticLocking { - /** - * (Optional) The type of optimistic locking policy to use. - */ - OptimisticLockingType type() default VERSION_COLUMN; - - /** - * (Optional) For an optimistic locking policy of type - * SELECTED_COLUMNS, this annotation member becomes a (Required) - * field. - */ - Column[] selectedColumns() default {}; - - /** - * (Optional) Specify where the optimistic locking policy should - * cascade lock. Currently only supported with VERSION_COLUMN locking. - */ - boolean cascade() default false; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="selected-column" type="orm:column" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="type" type="orm:optimistic-locking-type"/> - <xsd:attribute name="cascade" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="optimistic-locking-type"> - <xsd:annotation> - <xsd:documentation> - - /** - * A simple type that is used within an optimistic-locking - * specification to specify the type of optimistic-locking that - * EclipseLink should use when updating or deleting entities. - */ - public enum OptimisticLockingType { - /** - * Using this type of locking policy compares every field in the table - * in the WHERE clause when doing an update or a delete. If any field - * has been changed, an optimistic locking exception will be thrown. - */ - ALL_COLUMNS, - - /** - * Using this type of locking policy compares only the changed fields - * in the WHERE clause when doing an update. If any field has been - * changed, an optimistic locking exception will be thrown. A delete - * will only compare the primary key. - */ - CHANGED_COLUMNS, - - /** - * Using this type of locking compares selected fields in the WHERE - * clause when doing an update or a delete. If any field has been - * changed, an optimistic locking exception will be thrown. Note that - * the fields specified must be mapped and not be primary keys. - */ - SELECTED_COLUMNS, - - /** - * Using this type of locking policy compares a single version number - * in the where clause when doing an update. The version field must be - * mapped and not be the primary key. - */ - VERSION_COLUMN - } - - </xsd:documentation> - </xsd:annotation> - - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="ALL_COLUMNS"/> - <xsd:enumeration value="CHANGED_COLUMNS"/> - <xsd:enumeration value="SELECTED_COLUMNS"/> - <xsd:enumeration value="VERSION_COLUMN"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:simpleType name="order-by"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface OrderBy { - String value() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"/> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="order-column"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface OrderColumn { - String name() default ""; - boolean nullable() default true; - boolean insertable() default true; - boolean updatable() default true; - String columnDefinition() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="nullable" type="xsd:boolean"/> - <xsd:attribute name="insertable" type="xsd:boolean"/> - <xsd:attribute name="updatable" type="xsd:boolean"/> - <xsd:attribute name="column-definition" type="xsd:string"/> - <xsd:attribute name="correction-type" type="orm:order-column-correction-type"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="order-column-correction-type"> - <xsd:annotation> - <xsd:documentation> - - public enum OrderCorrectionType { - READ, - READ_WRITE, - EXCEPTION - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="READ"/> - <xsd:enumeration value="READ_WRITE"/> - <xsd:enumeration value="EXCEPTION"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="post-load"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD}) @Retention(RUNTIME) - public @interface PostLoad {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="method-name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="post-persist"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD}) @Retention(RUNTIME) - public @interface PostPersist {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="method-name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="post-remove"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD}) @Retention(RUNTIME) - public @interface PostRemove {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="method-name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="post-update"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD}) @Retention(RUNTIME) - public @interface PostUpdate {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="method-name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="pre-persist"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD}) @Retention(RUNTIME) - public @interface PrePersist {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="method-name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="pre-remove"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD}) @Retention(RUNTIME) - public @interface PreRemove {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="method-name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="pre-update"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD}) @Retention(RUNTIME) - public @interface PreUpdate {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="method-name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="primary-key"> - <xsd:annotation> - <xsd:documentation> - - /** - * The PrimaryKey annotation allows advanced configuration of the Id. - * A validation policy can be given that allows specifying if zero is a valid id value. - * The set of primary key columns can also be specified precisely. - * - * @author James Sutherland - * @since EclipseLink 1.1 - */ - @Target({TYPE}) - @Retention(RUNTIME) - public @interface PrimaryKey { - /** - * (Optional) Configures what id validation is done. - * By default 0 is not a valid id value, this can be used to allow 0 id values. - */ - IdValidation validation() default IdValidation.ZERO; - - /** - * (Optional) Configures what cache key type is used to store the object in the cache. - * By default the type is determined by what type is optimal for the class. - */ - CacheKeyType cacheKeyType() default CacheKeyType.AUTO; - - /** - * (Optional) Used to specify the primary key columns directly. - * This can be used instead of @Id if the primary key includes a non basic field, - * such as a foreign key, or a inheritance discriminator, embedded, or transformation mapped field. - */ - Column[] columns() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="column" type="orm:column" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="validation" type="orm:id-validation"/> - <xsd:attribute name="cache-key-type" type="orm:cache-key-type"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="primary-key-join-column"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) - public @interface PrimaryKeyJoinColumn { - String name() default ""; - String referencedColumnName() default ""; - String columnDefinition() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="referenced-column-name" type="xsd:string"/> - <xsd:attribute name="column-definition" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="property"> - <xsd:annotation> - <xsd:documentation> - - A user defined mapping's property. - @Target({METHOD, FIELD, TYPE}) - @Retention(RUNTIME) - public @interface Property { - /** - * Property name. - */ - String name(); - - /** - * String representation of Property value, - * converted to an instance of valueType. - */ - String value(); - - /** - * Property value type. - * The value converted to valueType by ConversionManager. - * If specified must be a simple type that could be handled by - * ConversionManager: - * numerical, boolean, temporal. - */ - Class valueType() default String.class; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="value" type="xsd:string" use="required"/> - <xsd:attribute name="value-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="query-hint"> - <xsd:annotation> - <xsd:documentation> - - @Target({}) @Retention(RUNTIME) - public @interface QueryHint { - String name(); - String value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="value" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="query-redirectors"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface QueryRedirectors { - - /** - * This AllQueries Query Redirector will be applied to any executing object query - * that does not have a more precise redirector (like the - * ReadObjectQuery Redirector) or a redirector set directly on the query. - * Query redirectors allow the user to intercept query execution preventing - * it or alternately performing some side effect like auditing. - * - */ - Class allQueries() default void.class; - - /** - * A Default ReadAll Query Redirector will be applied to any executing - * ReadAllQuery that does not have a redirector set directly on the query. - * Query redirectors allow the user to intercept query execution preventing - * it or alternately performing some side effect like auditing. - * For users executing a JPA Query through the getResultList() API this is the redirector that will be invoked - */ - Class readAll() default void.class; - - /** - * A Default ReadObject Query Redirector will be applied to any executing - * ReadObjectQuery that does not have a redirector set directly on the query. - * Query redirectors allow the user to intercept query execution preventing - * it or alternately performing some side effect like auditing. - * For users executing a JPA Query through the getSingleResult() API or EntityManager.find() this is the redirector that will be invoked - */ - Class readObject() default void.class; - - /** - * A Default ReportQuery Redirector will be applied to any executing - * ReportQuery that does not have a redirector set directly on the query. - * Query redirectors allow the user to intercept query execution preventing - * it or alternately performing some side effect like auditing. - * For users executing a JPA Query that contains agregate functions or selects multiple entities this is the redirector that will be invoked - */ - Class report() default void.class; - - /** - * A Default Update Query Redirector will be applied to any executing - * UpdateObjectQuery or UpdateAllQuery that does not have a redirector set directly on the query. - * In EclipseLink an UpdateObjectQuery is executed whenever flushing changes to the datasource. - * Query redirectors allow the user to intercept query execution preventing - * it or alternately performing some side effect like auditing. - */ - Class update() default void.class; - - /** - * A Default Insert Query Redirector will be applied to any executing - * InsertObjectQuery that does not have a redirector set directly on the query. - * In EclipseLink an InsertObjectQuery is executed when persisting an object to the datasource. - * Query redirectors allow the user to intercept query execution preventing - * it or alternately performing some side effect like auditing. - */ - Class insert() default void.class; - - /** - * A Default Delete Object Query Redirector will be applied to any executing - * DeleteObjectQuery or DeleteAllQuery that does not have a redirector set directly on the query. - * Query redirectors allow the user to intercept query execution preventing - * it or alternately performing some side effect like auditing. - */ - Class delete() default void.class; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="all-queries" type="xsd:string"/> - <xsd:attribute name="read-all" type="xsd:string"/> - <xsd:attribute name="read-object" type="xsd:string"/> - <xsd:attribute name="report" type="xsd:string"/> - <xsd:attribute name="update" type="xsd:string"/> - <xsd:attribute name="insert" type="xsd:string"/> - <xsd:attribute name="delete" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="read-transformer"> - <xsd:annotation> - <xsd:documentation> - - /** - * Annotation for org.eclipse.persistence.mappings.TransformationMapping. - * Unless the TransformationMapping is write-only, it should have a - * ReadTransformer, it defines transformation of database column(s) - * value(s)into attribute value. - * - * Also unless it's a read-only mapping, either WriteTransformer - * annotation or WriteTransformers annotation should be specified. Each - * WriteTransformer defines transformation of the attribute value to a - * single database column value (column is specified in the - * WriteTransformer). - */ - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface ReadTransformer { - /** - * User-defined class that must implement the - * org.eclipse.persistence.mappings.transformers.AttributeTransformer - * interface. The class will be instantiated, its - * buildAttributeValue will be used to create the value to be - * assigned to the attribute. - * Either transformerClass or method must be specified, but not both. - */ - Class transformerClass() default void.class; - - /** - * The mapped class must have a method with this name which returns - * a value to be assigned to the attribute (not assigns the value to - * the attribute). Either transformerClass or method must be - * specified, but not both. - */ - String method() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="transformer-class" type="xsd:string"/> - <xsd:attribute name="method" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="return-insert"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface ReturnInsert { - /** - * A ReturnInsert annotation allows for INSERT operations to return - * values back into the object being written. This allows for table - * default values, trigger or stored procedures computed values to - * be set back into the object. - */ - boolean returnOnly() default false; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="return-only" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="secondary-table"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface SecondaryTable { - String name(); - String catalog() default ""; - String schema() default ""; - PrimaryKeyJoinColumn[] pkJoinColumns() default {}; - UniqueConstraint[] uniqueConstraints() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="primary-key-join-column" - type="orm:primary-key-join-column" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="unique-constraint" type="orm:unique-constraint" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="catalog" type="xsd:string"/> - <xsd:attribute name="schema" type="xsd:string"/> - <xsd:attribute name="creation-suffix" type="xsd:string" /> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="sequence-generator"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) - public @interface SequenceGenerator { - String name(); - String sequenceName() default ""; - String catalog() default ""; - String schema() default ""; - int initialValue() default 1; - int allocationSize() default 50; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="sequence-name" type="xsd:string"/> - <xsd:attribute name="catalog" type="xsd:string"/> - <xsd:attribute name="schema" type="xsd:string"/> - <xsd:attribute name="initial-value" type="xsd:int"/> - <xsd:attribute name="allocation-size" type="xsd:int"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="sql-result-set-mapping"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface SqlResultSetMapping { - String name(); - EntityResult[] entities() default {}; - ColumnResult[] columns() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="entity-result" type="orm:entity-result" - minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="column-result" type="orm:column-result" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="stored-procedure-parameter"> - <xsd:annotation> - <xsd:documentation> - - /** - * A StoredProcedureParameter annotation is used within a - * NamedStoredProcedureQuery annotation. - */ - @Target({}) - @Retention(RUNTIME) - public @interface StoredProcedureParameter { - /** - * (Optional) The direction of the stored procedure parameter. - */ - Direction direction() default IN; - - /** - * (Optional) Stored procedure parameter name. - */ - String name() default ""; - - /** - * (Required) The query parameter name. - */ - String queryParameter(); - - /** - * (Optional) Define if the parameter is required, or optional and defaulted by the procedure. - */ - boolean optional() default false; - - /** - * (Optional) The type of Java class desired back from the procedure, - * this is dependent on the type returned from the procedure. - */ - Class type() default void.class; - - /** - * (Optional) The JDBC type code, this dependent on the type returned - * from the procedure. - */ - int jdbcType() default -1; - - /** - * (Optional) The JDBC type name, this may be required for ARRAY or - * STRUCT types. - */ - String jdbcTypeName() default ""; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="direction" type="orm:direction-type"/> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="query-parameter" type="xsd:string" use="required"/> - <xsd:attribute name="optional" type="xsd:boolean"/> - <xsd:attribute name="type" type="xsd:string"/> - <xsd:attribute name="jdbc-type" type="xsd:integer"/> - <xsd:attribute name="jdbc-type-name" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="plsql-parameter"> - <xsd:annotation> - <xsd:documentation> - - /** - * A PLSQLParameter annotation is used within a - * NamedPLSQLStoredProcedureQuery or PLSQLRecord annotation. - * - * @see NamedPLSQLStoredProcedureQuery - * @see PLSQLRecord - * @author James Sutherland - * @since EclipseLink 2.3 - */ - @Target({}) - @Retention(RUNTIME) - public @interface PLSQLParameter { - /** - * (Optional) The direction of the stored procedure parameter. - */ - Direction direction() default IN; - - /** - * (Required) Stored procedure parameter name. - */ - String name() default ""; - - /** - * (Optional) The query parameter name. - */ - String queryParameter(); - - /** - * (Optional) Define if the parameter is required, or optional and defaulted by the procedure. - */ - boolean optional() default false; - - /** - * (Optional) The database data-type for the paramter. - * This either one of the type constants defined in OraclePLSQLTypes, or JDBCTypes, - * or a custom record or table type name. - * @see PLSQLRecord - * @see OraclePLSQLTypes - * @see JDBCTypes - */ - String databaseType() default "VARCHAR"; - - /** - * (Optional) The max length of the field value. - */ - int length() default 255; - - /** - * (Optional) If a numeric, the max scale value. - */ - int scale() default 0; - - /** - * (Optional) If a numeric, the max precision value. - */ - int precision() default 0; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="direction" type="orm:direction-type"/> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="query-parameter" type="xsd:string"/> - <xsd:attribute name="optional" type="xsd:boolean"/> - <xsd:attribute name="database-type" type="xsd:string"/> - <xsd:attribute name="length" type="xsd:integer"/> - <xsd:attribute name="scale" type="xsd:integer"/> - <xsd:attribute name="precision" type="xsd:integer"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="struct-converter"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface StructConverter { - /** - * (Required) Name this converter. The name should be unique across - * the whole persistence unit. - */ - String name(); - - /** - * (Required) The converter class to be used. This class must - * implement the EclipseLink interface - * org.eclipse.persistence.mappings.converters.Converter - */ - String converter(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="converter" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="struct"> - <xsd:annotation> - <xsd:documentation> - - /** - * Struct types are extended object-relational data-types supported by some databases. - * Struct types are user define types in the database such as OBJECT types on Oracle. - * Structs can normally contains Arrays (VARRAY) or other Struct types, and can be stored in - * a column or a table. - * This annotation define a class to map to a database Struct type. - * The class should normally be an Embeddable, but could also be an Entity if stored in a object table. - * - * @see org.eclipse.persistence.mappings.structures.ObjectRelationalDataTypeDescriptor - * @see org.eclipse.persistence.mappings.structures.StructureMapping - * @author James Sutherland - * @since EclipseLink 2.3 - */ - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface Struct { - /** - * (Required) The database name of the database structure type. - */ - String name(); - - /** - * (Optional) Defines the order of the fields contained in the database structure type. - */ - String[] fields() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="field" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="structure"> - <xsd:annotation> - <xsd:documentation> - - /** - * Struct types are extended object-relational data-types supported by some databases. - * Struct types are user define types in the database such as OBJECT types on Oracle. - * Structs can normally contains Arrays (VARRAY) or other Struct types, and can be stored in - * a column or a table. - * This annotation can be defined on a field/method to define an StructureMapping to an embedded Struct type. - * The target Embeddable must be mapped using the Struct annotation. - * - * @see Struct - * @see org.eclipse.persistence.mappings.structures.ObjectRelationalDataTypeDescriptor - * @see org.eclipse.persistence.mappings.structures.StructureMapping - * @author James Sutherland - * @since EclipseLink 2.3 - */ - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface Structure { - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="table"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE}) @Retention(RUNTIME) - public @interface Table { - String name() default ""; - String catalog() default ""; - String schema() default ""; - UniqueConstraint[] uniqueConstraints() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="unique-constraint" type="orm:unique-constraint" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="catalog" type="xsd:string"/> - <xsd:attribute name="schema" type="xsd:string"/> - <xsd:attribute name="creation-suffix" type="xsd:string" /> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="index"> - <xsd:annotation> - <xsd:documentation> - - /** - * Allow a database INDEX to be define when generating DDL. - * The @Index can be defined on a Entity class, or on an attribute. - * The column is defaulted when defined on a attribute. - * - * @author James Sutherland - * @since EclipseLink 2.2 - */ - @Target({METHOD, FIELD, TYPE}) - @Retention(RUNTIME) - public @interface Index { - /** The name of the INDEX, defaults to INDEX_(table-name) */ - String name() default ""; - - /** The schema of the INDEX */ - String schema() default ""; - - /** The catalog of the INDEX */ - String catalog() default ""; - - /** The table to define the index on, defaults to entities primary table. */ - String table() default ""; - - boolean unique() default false; - - /** - * Specify the set of columns to define the index on. - * Not required when annotated on a field/method. - */ - String[] columnNames() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="column-name" type="xsd:string" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="catalog" type="xsd:string"/> - <xsd:attribute name="schema" type="xsd:string"/> - <xsd:attribute name="table" type="xsd:string"/> - <xsd:attribute name="unique" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="cache-index"> - <xsd:annotation> - <xsd:documentation> - - /** - * Allow a cache index to be define. - * A cache index allow singleResult queries to obtain a cache hit when querying on the indexed fields. - * resultList queries cannot obtain cache hits, as it is unknown if all of the objects are in memory, - * (unless the cache usage query hint is used). - * The index should be unique, but if not unique, the first indexed object will be returned. - * Cache indexes are only relevant when caching is enabled. - * The @CacheIndex can be defined on a Entity class, or on an attribute. - * The column is defaulted when defined on a attribute. - * - * @author James Sutherland - * @since EclipseLink 2.4 - */ - @Target({METHOD, FIELD, TYPE}) - @Retention(RUNTIME) - public @interface CacheIndex { - /** - * Specify the set of columns to define the index on. - * Not required when annotated on a field/method. - */ - String[] columnNames() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="column-name" type="xsd:string" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="table-generator"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) - public @interface TableGenerator { - String name(); - String table() default ""; - String catalog() default ""; - String schema() default ""; - String pkColumnName() default ""; - String valueColumnName() default ""; - String pkColumnValue() default ""; - int initialValue() default 0; - int allocationSize() default 50; - UniqueConstraint[] uniqueConstraints() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="description" type="xsd:string" minOccurs="0"/> - <xsd:element name="unique-constraint" type="orm:unique-constraint" - minOccurs="0" maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="table" type="xsd:string"/> - <xsd:attribute name="catalog" type="xsd:string"/> - <xsd:attribute name="schema" type="xsd:string"/> - <xsd:attribute name="creation-suffix" type="xsd:string"/> - <xsd:attribute name="pk-column-name" type="xsd:string"/> - <xsd:attribute name="value-column-name" type="xsd:string"/> - <xsd:attribute name="pk-column-value" type="xsd:string"/> - <xsd:attribute name="initial-value" type="xsd:int"/> - <xsd:attribute name="allocation-size" type="xsd:int"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:simpleType name="temporal"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface Temporal { - TemporalType value(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="orm:temporal-type"/> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:simpleType name="temporal-type"> - <xsd:annotation> - <xsd:documentation> - - public enum TemporalType { - DATE, // java.sql.Date - TIME, // java.sql.Time - TIMESTAMP // java.sql.Timestamp - } - - </xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:token"> - <xsd:enumeration value="DATE"/> - <xsd:enumeration value="TIME"/> - <xsd:enumeration value="TIMESTAMP"/> - </xsd:restriction> - </xsd:simpleType> - - <!-- **************************************************** --> - - <xsd:complexType name="tenant-discriminator-column"> - <xsd:annotation> - <xsd:documentation> - @Target({}) - @Retention(RUNTIME) - public @interface TenantDiscriminatorColumn { - /** - * (Optional) The name of column to be used for the tenant discriminator. - */ - String name() default "TENANT_ID"; - - /** - * (Optional) The name of the context property to apply to the - * tenant discriminator column. - */ - String contextProperty() default "eclipselink.tenant-id"; - - /** - * (Optional) The type of object/column to use as a class discriminator. - * Defaults to {@link DiscriminatorType#STRING DiscriminatorType.STRING}. - */ - DiscriminatorType discriminatorType() default DiscriminatorType.STRING; - - /** - * (Optional) The SQL fragment that is used when generating the DDL - * for the discriminator column. - * Defaults to the provider-generated SQL to create a column - * of the specified discriminator type. - */ - String columnDefinition() default ""; - - /** - * (Optional) The column length for String-based discriminator types. - * Ignored for other discriminator types. - */ - int length() default 31; - - /** - * (Optional) The name of the table that contains the column. - * If absent the column is assumed to be in the primary table. - */ - String table() default ""; - - /** - * Specifies that the tenant discriminator column is part of the primary - * key of the tables. - */ - boolean primaryKey() default false; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"/> - <xsd:attribute name="context-property" type="xsd:string"/> - <xsd:attribute name="discriminator-type" type="orm:discriminator-type"/> - <xsd:attribute name="column-definition" type="xsd:string"/> - <xsd:attribute name="length" type="xsd:int"/> - <xsd:attribute name="table" type="xsd:string"/> - <xsd:attribute name="primary-key" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="time-of-day"> - <xsd:annotation> - <xsd:documentation> - - @Target({}) - @Retention(RUNTIME) - public @interface TimeOfDay { - /** - * (Optional) Hour of the day. - */ - int hour() default 0; - - /** - * (Optional) Minute of the day. - */ - int minute() default 0; - - /** - * (Optional) Second of the day. - */ - int second() default 0; - - /** - * (Optional) Millisecond of the day. - */ - int millisecond() default 0; - - /** - * Internal use. Do not modify. - */ - boolean specified() default true; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="hour" type="xsd:integer"/> - <xsd:attribute name="minute" type="xsd:integer"/> - <xsd:attribute name="second" type="xsd:integer"/> - <xsd:attribute name="millisecond" type="xsd:integer"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="transformation"> - <xsd:annotation> - <xsd:documentation> - - /** - * Transformation is an optional annotation for - * org.eclipse.persistence.mappings.TransformationMapping. - * TransformationMapping allows to map an attribute to one or more - * database columns. - * - * Transformation annotation is an optional part of - * TransformationMapping definition. Unless the TransformationMapping is - * write-only, it should have a ReadTransformer, it defines - * transformation of database column(s) value(s)into attribute value. - * Also unless it's a read-only mapping, either WriteTransformer - * annotation or WriteTransformers annotation should be specified. Each - * WriteTransformer defines transformation of the attribute value to a - * single database column value (column is specified in the - * WriteTransformer). - */ - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface Transformation { - /** - * (Optional) Defines whether the value of the field or property - * should be lazily loaded or must be eagerly fetched. The EAGER - * strategy is a requirement on the persistence provider runtime - * that the value must be eagerly fetched. The LAZY strategy is a - * hint to the persistence provider runtime. If not specified, - * defaults to EAGER. - */ - FetchType fetch() default EAGER; - - /** - * (Optional) The optional element is a hint as to whether the value - * of the field or property may be null. It is disregarded - * for primitive types, which are considered non-optional. - */ - boolean optional() default true; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="read-transformer" type="orm:read-transformer"/> - <xsd:element name="write-transformer" type="orm:write-transformer" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="optional" type="xsd:boolean"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="mutable" type="xsd:boolean"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="transient"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface Transient {} - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="type-converter"> - <xsd:annotation> - <xsd:documentation> - - @Target({TYPE, METHOD, FIELD}) - @Retention(RUNTIME) - public @interface TypeConverter { - /** - * (Required) Name this converter. The name should be unique - * across the whole persistence unit. - */ - String name(); - - /** - * (Optional) Specify the type stored on the database. The - * default is inferred from the type of the persistence field - * or property. - */ - Class dataType() default void.class; - - /** - * (Optional) Specify the type stored on the entity. The - * default is inferred from the type of the persistent field - * or property. - */ - Class objectType() default void.class; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="data-type" type="xsd:string"/> - <xsd:attribute name="object-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="unique-constraint"> - <xsd:annotation> - <xsd:documentation> - - @Target({}) @Retention(RUNTIME) - public @interface UniqueConstraint { - String name() default ""; - String[] columnNames(); - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="column-name" type="xsd:string" - maxOccurs="unbounded"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="variable-one-to-one"> - <xsd:annotation> - <xsd:documentation> - /** - * Variable one to one mappings are used to represent a pointer - * references between a java object and an implementer of an interface. - * This mapping is usually represented by a single pointer (stored in an - * instance variable) between the source and target objects. In the - * relational database tables, these mappings are normally implemented - * using a foreign key and a type code. - * - * A VariableOneToOne can be specified within an Entity, - * MappedSuperclass and Embeddable class. - */ - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface VariableOneToOne { - /** - * (Optional) The interface class that is the target of the - * association. If not specified it will be inferred from the type - * of the object being referenced. - */ - Class targetInterface() default void.class; - - /** - * (Optional) The operations that must be cascaded to the target of - * the association. - */ - CascadeType[] cascade() default {}; - - /** - * (Optional) Defines whether the value of the field or property - * should be lazily loaded or must be eagerly fetched. The EAGER - * strategy is a requirement on the persistence provider runtime - * that the value must be eagerly fetched. The LAZY strategy is a - * hint to the persistence provider runtime. If not specified, - * defaults to EAGER. - */ - FetchType fetch() default EAGER; - - /** - * (Optional) Whether the association is optional. If set to false - * then a non-null relationship must always exist. - */ - boolean optional() default true; - - /** - * (Optional) The discriminator column will hold the type - * indicators. If the DiscriminatorColumn is not specified, the name - * of the discriminator column defaults to "DTYPE" and the - * discriminator type to STRING. - */ - DiscriminatorColumn discriminatorColumn() default @DiscriminatorColumn; - - /** - * (Optional) The list of discriminator types that can be used with - * this VariableOneToOne. If none are specified then those entities - * within the persistence unit that implement the target interface - * will be added to the list of types. The discriminator type will - * default as follows: - * - If DiscriminatorColumn type is STRING: Entity.name() - * - If DiscriminatorColumn type is CHAR: First letter of the - * Entity class - * - If DiscriminatorColumn type is INTEGER: The next integer after - * the highest integer explicitly added. - */ - DiscriminatorClass[] discriminatorClasses() default {}; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="cascade" type="orm:cascade-type" minOccurs="0"/> - <xsd:element name="discriminator-column" type="orm:discriminator-column" minOccurs="0"/> - <xsd:element name="discriminator-class" type="orm:discriminator-class" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="join-column" type="orm:join-column" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="private-owned" type="orm:emptyType" minOccurs="0"/> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - <xsd:element name="noncacheable" type="orm:emptyType" minOccurs="0"/> - <xsd:group ref="orm:partitioning-group"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="target-interface" type="xsd:string"/> - <xsd:attribute name="fetch" type="orm:fetch-type"/> - <xsd:attribute name="optional" type="xsd:boolean"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="orphan-removal" type="xsd:boolean"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="version"> - <xsd:annotation> - <xsd:documentation> - - @Target({METHOD, FIELD}) @Retention(RUNTIME) - public @interface Version {} - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="column" type="orm:column" minOccurs="0"/> - <xsd:element name="index" type="orm:index" minOccurs="0"/> - <xsd:choice minOccurs="0"> - <xsd:element name="temporal" type="orm:temporal"/> - <xsd:element name="convert" type="xsd:string"/> - </xsd:choice> - <xsd:choice minOccurs="0"> - <xsd:element name="converter" type="orm:converter"/> - <xsd:element name="type-converter" type="orm:type-converter"/> - <xsd:element name="object-type-converter" type="orm:object-type-converter"/> - <xsd:element name="struct-converter" type="orm:struct-converter"/> - </xsd:choice> - <xsd:element name="property" type="orm:property" minOccurs="0" maxOccurs="unbounded"/> - <xsd:element name="access-methods" type="orm:access-methods" minOccurs="0"/> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" use="required"/> - <xsd:attribute name="access" type="orm:access-type"/> - <xsd:attribute name="mutable" type="xsd:boolean"/> - <xsd:attribute name="attribute-type" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="write-transformer"> - <xsd:annotation> - <xsd:documentation> - - /** - * Annotation for org.eclipse.persistence.mappings.TransformationMapping. - * WriteTransformer defines transformation of the attribute value to a - * single database column value (column is specified in the - * WriteTransformer). - * - * A single WriteTransformer may be specified directly on the method or - * attribute. Multiple WriteTransformers should be wrapped into - * WriteTransformers annotation. No WriteTransformers specified for - * read-only mapping. Unless the TransformationMapping is write-only, it - * should have a ReadTransformer, it defines transformation of database - * column(s) value(s)into attribute value. - */ - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface WriteTransformer { - /** - * User-defined class that must implement the - * org.eclipse.persistence.mappings.transformers.FieldTransformer - * interface. The class will be instantiated, its buildFieldValue - * will be used to create the value to be written into the database - * column. Note that for ddl generation and returning to be - * supported the method buildFieldValue in the class should be - * defined to return the relevant Java type, not just Object as - * defined in the interface, for instance: - * public Time buildFieldValue(Object instance, String fieldName, Session session). - * Either transformerClass or method must be specified, but not both. - */ - Class transformerClass() default void.class; - - /** - * The mapped class must have a method with this name which returns - * a value to be written into the database column. - * Note that for ddl generation and returning to be supported the - * method should be defined to return a particular type, not just - * Object, for instance: - * public Time getStartTime(). - * The method may require a Transient annotation to avoid being - * mapped as Basic by default. - * Either transformerClass or method must be specified, but not both. - */ - String method() default ""; - - /** - * Specify here the column into which the value should be written. - * The only case when this could be skipped is if a single - * WriteTransformer annotates an attribute - the attribute's name - * will be used as a column name. - */ - Column column() default @Column; - } - - </xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="column" type="orm:column"/> - </xsd:sequence> - <xsd:attribute name="transformer-class" type="xsd:string"/> - <xsd:attribute name="method" type="xsd:string"/> - </xsd:complexType> - - <!-- **************************************************** --> - - <xsd:complexType name="batch-fetch"> - <xsd:annotation> - <xsd:documentation> - /** - * A BatchFetch annotation can be used on any relationship mapping, - * (OneToOne, ManyToOne, OneToMany, ManyToMany, ElementCollection, BasicCollection, BasicMap). - * It allows the related objects to be batch read in a single query. - * Batch fetching can also be set at the query level, and it is - * normally recommended to do so as all queries may not require batching. - * - * @author James Sutherland - * @since EclipseLink 2.1 - */ - @Target({METHOD, FIELD}) - @Retention(RUNTIME) - public @interface BatchFetch { - /** - * (Optional) The type of batch-fetch to use. - * Either JOIN, EXISTS or IN. - * JOIN is the default. - */ - BatchFetchType value() default BatchFetchType.JOIN; - - /** - * Define the default batch fetch size. - * This is only used for IN type batch reading and defines - * the number of keys used in each IN clause. - * The default size is 256, or the query's pageSize for cursor queries. - */ - int size() default -1; - } - </xsd:documentation> - </xsd:annotation> - <xsd:attribute name="type" type="orm:batch-fetch-type"/> - <xsd:attribute name="size" type="xsd:integer"/> - </xsd:complexType> - -</xsd:schema> - - diff --git a/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_oxm_2_4.xsd b/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_oxm_2_4.xsd deleted file mode 100644 index d97c3dd3b3..0000000000 --- a/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_oxm_2_4.xsd +++ /dev/null @@ -1,589 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!-- -****************************************************************************** - Copyright (c) 1998, 2010 Oracle. All rights reserved. - This program and the accompanying materials are made available under the - terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 - which accompanies this distribution. - The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html - and the Eclipse Distribution License is available at - http://www.eclipse.org/org/documents/edl-v10.php. - - Contributors: - dmccann - December 22/2010 - 2.3 - Initial implementation -*****************************************************************************/ ---> -<xs:schema xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm" xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.eclipse.org/eclipselink/xsds/persistence/oxm" version="2.4"> - - <xs:element name="xml-bindings"> - <xs:complexType> - <xs:all> - <xs:element minOccurs="0" ref="xml-schema"/> - <xs:element minOccurs="0" ref="xml-schema-type"/> - <xs:element minOccurs="0" ref="xml-schema-types"/> - <xs:element minOccurs="0" ref="xml-java-type-adapters"/> - <xs:element minOccurs="0" name="xml-registries"> - <xs:complexType> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="xml-registry"/> - </xs:sequence> - </xs:complexType> - </xs:element> - <xs:element minOccurs="0" name="xml-enums"> - <xs:complexType> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="xml-enum"/> - </xs:sequence> - </xs:complexType> - </xs:element> - <xs:element minOccurs="0" name="java-types"> - <xs:complexType> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="java-type"/> - </xs:sequence> - </xs:complexType> - </xs:element> - </xs:all> - <xs:attribute default="PUBLIC_MEMBER" name="xml-accessor-type" type="xml-access-type"/> - <xs:attribute default="UNDEFINED" name="xml-accessor-order" type="xml-access-order"/> - <xs:attribute default="false" name="xml-mapping-metadata-complete" type="xs:boolean"/> - <xs:attribute default="##default" name="package-name" type="xs:string"/> - <xs:attribute name="xml-name-transformer" type="xs:string"/> - <xs:attribute name="version" type="supported-versions"/> - </xs:complexType> - </xs:element> - <xs:element name="xml-registry"> - <xs:complexType> - <xs:sequence> - <xs:element maxOccurs="unbounded" name="xml-element-decl"> - <xs:complexType> - <xs:attribute name="java-method" type="xs:string"/> - <xs:attribute name="name" type="xs:string" use="required"/> - <xs:attribute default="\u0000" name="defaultValue" type="xs:string"/> - <xs:attribute default="##default" name="namespace" type="xs:string"/> - <xs:attribute default="javax.xml.bind.annotation.XmlElementDecl.GLOBAL" name="scope" type="xs:string"/> - <xs:attribute default="" name="substitutionHeadName" type="xs:string"/> - <xs:attribute default="##default" name="substitutionHeadNamespace" type="xs:string"/> - <xs:attribute default="##default" name="type" type="xs:string"/> - </xs:complexType> - </xs:element> - </xs:sequence> - <xs:attribute name="name" type="xs:string"/> - </xs:complexType> - </xs:element> - <xs:element name="java-type"> - <xs:complexType> - <xs:all> - <xs:element minOccurs="0" ref="xml-type"/> - <xs:element minOccurs="0" ref="xml-root-element"/> - <xs:element minOccurs="0" ref="xml-virtual-access-methods"/> - <xs:element minOccurs="0" ref="xml-see-also"/> - <xs:element minOccurs="0" ref="xml-java-type-adapter"/> - <xs:element minOccurs="0" ref="xml-class-extractor"/> - <xs:element minOccurs="0" ref="xml-properties"/> - <xs:element minOccurs="0" name="java-attributes"> - <xs:complexType> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="java-attribute"/> - </xs:sequence> - </xs:complexType> - </xs:element> - </xs:all> - <xs:attribute name="name" type="xs:string"/> - <xs:attribute default="##default" name="super-type" type="xs:string"/> - <xs:attribute default="UNDEFINED" name="xml-accessor-order" type="xml-access-order"/> - <xs:attribute default="PUBLIC_MEMBER" name="xml-accessor-type" type="xml-access-type"/> - <xs:attribute name="xml-customizer" type="xs:string"/> - <xs:attribute name="xml-discriminator-node" type="xs:string"/> - <xs:attribute name="xml-discriminator-value" type="xs:string"/> - <xs:attribute default="false" name="xml-inline-binary-data" type="xs:boolean"/> - <xs:attribute default="false" name="xml-transient" type="xs:boolean"/> - <xs:attribute name="xml-name-transformer" type="xs:string"/> - </xs:complexType> - </xs:element> - <xs:element name="java-attribute" type="java-attribute"/> - <xs:complexType abstract="true" name="java-attribute"> - <xs:attribute name="java-attribute" type="xs:string"/> - </xs:complexType> - <xs:element name="xml-access-methods" type="xml-access-methods"/> - <xs:complexType name="xml-access-methods"> - <xs:attribute name="get-method" type="xs:string"/> - <xs:attribute name="set-method" type="xs:string"/> - </xs:complexType> - <xs:element name="xml-class-extractor" type="xml-class-extractor"/> - <xs:complexType name="xml-class-extractor"> - <xs:attribute name="class" type="xs:string" use="required"/> - </xs:complexType> - <xs:element name="xml-properties" type="xml-properties"/> - <xs:complexType name="xml-properties"> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" name="xml-property"> - <xs:complexType> - <xs:attribute name="name" type="xs:string" use="required"/> - <xs:attribute name="value" type="xs:string" use="required"/> - <xs:attribute default="java.lang.String" name="value-type" type="xs:string"/> - </xs:complexType> - </xs:element> - </xs:sequence> - </xs:complexType> - <!-- Enums --> - <xs:simpleType name="xml-access-order"> - <xs:restriction base="xs:string"> - <xs:enumeration value="ALPHABETICAL"/> - <xs:enumeration value="UNDEFINED"/> - </xs:restriction> - </xs:simpleType> - <xs:simpleType name="xml-access-type"> - <xs:restriction base="xs:string"> - <xs:enumeration value="FIELD"/> - <xs:enumeration value="NONE"/> - <xs:enumeration value="PROPERTY"/> - <xs:enumeration value="PUBLIC_MEMBER"/> - </xs:restriction> - </xs:simpleType> - <xs:simpleType name="xml-ns-form"> - <xs:restriction base="xs:string"> - <xs:enumeration value="UNQUALIFIED"/> - <xs:enumeration value="QUALIFIED"/> - <xs:enumeration value="UNSET"/> - </xs:restriction> - </xs:simpleType> - <xs:simpleType name="xml-marshal-null-representation"> - <xs:restriction base="xs:string"> - <xs:enumeration value="XSI_NIL"/> - <xs:enumeration value="ABSENT_NODE"/> - <xs:enumeration value="EMPTY_NODE"/> - </xs:restriction> - </xs:simpleType> - <xs:simpleType name="supported-versions"> - <xs:restriction base="xs:string"> - <xs:enumeration value="2.0"/> - <xs:enumeration value="2.1"/> - <xs:enumeration value="2.2"/> - <xs:enumeration value="2.3"/> - <xs:enumeration value="2.4"/> - </xs:restriction> - </xs:simpleType> - - <!-- @Target(value=PACKAGE) --> - <xs:element name="xml-schema"> - <xs:complexType> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" name="xml-ns"> - <xs:complexType> - <xs:attribute name="namespace-uri" type="xs:string"/> - <xs:attribute name="prefix" type="xs:string"/> - </xs:complexType> - </xs:element> - </xs:sequence> - <xs:attribute default="UNSET" name="attribute-form-default" type="xml-ns-form"/> - <xs:attribute default="UNSET" name="element-form-default" type="xml-ns-form"/> - <xs:attribute name="location" type="xs:string"/> - <xs:attribute name="namespace" type="xs:string"/> - </xs:complexType> - </xs:element> - <xs:element name="xml-schema-types"> - <xs:complexType> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="xml-schema-type"/> - </xs:sequence> - </xs:complexType> - </xs:element> - <xs:element name="xml-java-type-adapters"> - <xs:complexType> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="xml-java-type-adapter"/> - </xs:sequence> - </xs:complexType> - </xs:element> - - <!-- @Target(value={FIELD,METHOD,PACKAGE}) --> - <xs:element name="xml-schema-type"> - <xs:complexType> - <xs:attribute name="name" type="xs:string" use="required"/> - <xs:attribute default="http://www.w3.org/2001/XMLSchema" name="namespace" type="xs:string"/> - <xs:attribute default="javax.xml.bind.annotation.XmlSchemaType.DEFAULT" name="type" type="xs:string"/> - </xs:complexType> - </xs:element> - - <!-- @Target(value={PACKAGE,FIELD,METHOD,TYPE,PARAMETER}) --> - <xs:element name="xml-java-type-adapter" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:attribute name="value" type="xs:string" use="required"/> - <xs:attribute default="javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter.DEFAULT" name="type" type="xs:string"/> - <xs:attribute default="javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter.DEFAULT" name="value-type" type="xs:string"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - - <!-- @Target(value={FIELD,METHOD,TYPE}) --> - <xs:element name="xml-transient" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:attribute default="false" name="xml-location" type="xs:boolean"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - - <!-- @Target(value=TYPE) --> - <xs:element name="xml-enum"> - <xs:complexType> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="xml-enum-value"/> - </xs:sequence> - <xs:attribute name="java-enum" type="xs:string" use="required"/> - <xs:attribute default="java.lang.String" name="value" type="xs:string"/> - </xs:complexType> - </xs:element> - <xs:element name="xml-type"> - <xs:complexType> - <xs:attribute default="##default" name="name" type="xs:string"/> - <xs:attribute default="##default" name="namespace" type="xs:string"/> - <xs:attribute default="javax.xml.bind.annotation.XmlType.DEFAULT" name="factory-class" type="xs:string"/> - <xs:attribute name="factory-method" type="xs:string"/> - <xs:attribute name="prop-order"> - <xs:simpleType> - <xs:list itemType="xs:string"/> - </xs:simpleType> - </xs:attribute> - </xs:complexType> - </xs:element> - <xs:element name="xml-root-element"> - <xs:complexType> - <xs:attribute default="##default" name="name" type="xs:string"/> - <xs:attribute default="##default" name="namespace" type="xs:string"/> - </xs:complexType> - </xs:element> - <xs:element name="xml-see-also"> - <xs:simpleType> - <xs:list itemType="xs:string"/> - </xs:simpleType> - </xs:element> - <xs:element name="xml-virtual-access-methods"> - <xs:complexType> - <xs:attribute default="get" name="get-method" type="xs:string"/> - <xs:attribute default="set" name="set-method" type="xs:string"/> - <xs:attribute default="NODES" name="schema" type="xml-virtual-access-methods-schema"/> - </xs:complexType> - </xs:element> - <xs:simpleType name="xml-virtual-access-methods-schema"> - <xs:restriction base="xs:string"> - <xs:enumeration value="NODES"/> - <xs:enumeration value="ANY"/> - </xs:restriction> - </xs:simpleType> - - <!-- @Target(value={FIELD}) --> - <xs:element name="xml-enum-value"> - <xs:complexType> - <xs:simpleContent> - <xs:extension base="xs:string"> - <xs:attribute name="java-enum-value" type="xs:string" use="required"/> - </xs:extension> - </xs:simpleContent> - </xs:complexType> - </xs:element> - - <!-- @Target(value={FIELD,METHOD}) --> - <xs:element name="xml-any-attribute" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:all> - <xs:element minOccurs="0" ref="xml-access-methods"/> - <xs:element minOccurs="0" ref="xml-properties"/> - </xs:all> - <xs:attribute default="false" name="read-only" type="xs:boolean"/> - <xs:attribute default="false" name="write-only" type="xs:boolean"/> - <xs:attribute name="xml-path" type="xs:string"/> - <xs:attribute default="##default" name="container-type" type="xs:string"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-attribute" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:all> - <xs:element minOccurs="0" ref="xml-abstract-null-policy"/> - <xs:element minOccurs="0" ref="xml-access-methods"/> - <xs:element minOccurs="0" ref="xml-java-type-adapter"/> - <xs:element minOccurs="0" ref="xml-properties"/> - <xs:element minOccurs="0" ref="xml-schema-type"/> - </xs:all> - <xs:attribute default="##default" name="name" type="xs:string"/> - <xs:attribute default="##default" name="namespace" type="xs:string"/> - <xs:attribute default="false" name="required" type="xs:boolean"/> - <xs:attribute default="false" name="xml-id" type="xs:boolean"/> - <xs:attribute default="false" name="xml-idref" type="xs:boolean"/> - <xs:attribute default="false" name="xml-key" type="xs:boolean"/> - <xs:attribute default="false" name="xml-list" type="xs:boolean"/> - <xs:attribute default="false" name="xml-inline-binary-data" type="xs:boolean"/> - <xs:attribute default="false" name="xml-attachment-ref" type="xs:boolean"/> - <xs:attribute name="xml-mime-type" type="xs:string"/> - <xs:attribute default="false" name="read-only" type="xs:boolean"/> - <xs:attribute default="false" name="write-only" type="xs:boolean"/> - <xs:attribute default="##default" name="container-type" type="xs:string"/> - <xs:attribute default="##default" name="type" type="xs:string"/> - <xs:attribute name="xml-path" type="xs:string"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-any-element" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:all> - <xs:element minOccurs="0" ref="xml-access-methods"/> - <xs:element minOccurs="0" ref="xml-java-type-adapter"/> - <xs:element minOccurs="0" ref="xml-properties"/> - <xs:element minOccurs="0" ref="xml-element-refs"/> - </xs:all> - <xs:attribute default="false" name="xml-mixed" type="xs:boolean"/> - <xs:attribute default="false" name="lax" type="xs:boolean"/> - <xs:attribute default="javax.xml.bind.annotation.W3CDomHandler" name="dom-handler" type="xs:string"/> - <xs:attribute default="false" name="read-only" type="xs:boolean"/> - <xs:attribute default="false" name="write-only" type="xs:boolean"/> - <xs:attribute name="xml-path" type="xs:string"/> - <xs:attribute default="##default" name="container-type" type="xs:string"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-element" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:all> - <xs:element minOccurs="0" ref="xml-abstract-null-policy"/> - <xs:element minOccurs="0" ref="xml-access-methods"/> - <xs:element minOccurs="0" ref="xml-element-wrapper"/> - <xs:element minOccurs="0" ref="xml-java-type-adapter"/> - <xs:element minOccurs="0" ref="xml-map"/> - <xs:element minOccurs="0" ref="xml-properties"/> - <xs:element minOccurs="0" ref="xml-schema-type"/> - </xs:all> - <xs:attribute default="##default" name="name" type="xs:string"/> - <xs:attribute default="##default" name="namespace" type="xs:string"/> - <xs:attribute name="default-value" type="xs:string"/> - <xs:attribute default="false" name="nillable" type="xs:boolean"/> - <xs:attribute default="false" name="required" type="xs:boolean"/> - <xs:attribute default="##default" name="container-type" type="xs:string"/> - <xs:attribute default="javax.xml.bind.annotation.XmlElement.DEFAULT" name="type" type="xs:string"/> - <xs:attribute default="false" name="xml-id" type="xs:boolean"/> - <xs:attribute default="false" name="xml-idref" type="xs:boolean"/> - <xs:attribute default="false" name="xml-key" type="xs:boolean"/> - <xs:attribute default="false" name="xml-list" type="xs:boolean"/> - <xs:attribute default="false" name="xml-inline-binary-data" type="xs:boolean"/> - <xs:attribute default="false" name="xml-attachment-ref" type="xs:boolean"/> - <xs:attribute name="xml-mime-type" type="xs:string"/> - <xs:attribute default="false" name="read-only" type="xs:boolean"/> - <xs:attribute default="false" name="write-only" type="xs:boolean"/> - <xs:attribute default="false" name="cdata" type="xs:boolean"/> - <xs:attribute name="xml-path" type="xs:string"/> - <xs:attribute default="false" name="xml-location" type="xs:boolean"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-elements" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:sequence> - <xs:element minOccurs="0" ref="xml-access-methods"/> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="xml-element"/> - <xs:element minOccurs="0" ref="xml-element-wrapper"/> - <xs:element minOccurs="0" ref="xml-properties"/> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="xml-join-nodes"/> - </xs:sequence> - <xs:attribute default="false" name="xml-idref" type="xs:boolean"/> - <xs:attribute default="false" name="xml-list" type="xs:boolean"/> - <xs:attribute default="false" name="read-only" type="xs:boolean"/> - <xs:attribute default="false" name="write-only" type="xs:boolean"/> - <xs:attribute default="##default" name="container-type" type="xs:string"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-element-ref" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:all> - <xs:element minOccurs="0" name="xml-access-methods" type="xml-access-methods"/> - <xs:element minOccurs="0" ref="xml-element-wrapper"/> - <xs:element minOccurs="0" ref="xml-properties"/> - <xs:element minOccurs="0" ref="xml-java-type-adapter"/> - </xs:all> - <xs:attribute default="##default" name="name" type="xs:string"/> - <xs:attribute name="namespace" type="xs:string"/> - <xs:attribute default="##default" name="container-type" type="xs:string"/> - <xs:attribute default="javax.xml.bind.annotation.XmlElementRef.DEFAULT" name="type" type="xs:string"/> - <xs:attribute default="false" name="xml-mixed" type="xs:boolean"/> - <xs:attribute default="false" name="read-only" type="xs:boolean"/> - <xs:attribute default="false" name="write-only" type="xs:boolean"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-element-refs" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:sequence> - <xs:element minOccurs="0" name="xml-access-methods" type="xml-access-methods"/> - <xs:element maxOccurs="unbounded" minOccurs="0" ref="xml-element-ref"/> - <xs:element minOccurs="0" ref="xml-element-wrapper"/> - <xs:element minOccurs="0" ref="xml-properties"/> - <xs:element minOccurs="0" ref="xml-java-type-adapter"/> - </xs:sequence> - <xs:attribute default="false" name="xml-mixed" type="xs:boolean"/> - <xs:attribute default="false" name="read-only" type="xs:boolean"/> - <xs:attribute default="false" name="write-only" type="xs:boolean"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-inverse-reference" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:all> - <xs:element minOccurs="0" ref="xml-access-methods"/> - <xs:element minOccurs="0" ref="xml-properties"/> - </xs:all> - <xs:attribute name="mapped-by" type="xs:string" use="required"/> - <xs:attribute default="##default" name="container-type" type="xs:string"/> - <xs:attribute default="##default" name="type" type="xs:string"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-element-wrapper"> - <xs:complexType> - <xs:attribute default="##default" name="name" type="xs:string"/> - <xs:attribute default="##default" name="namespace" type="xs:string"/> - <xs:attribute default="false" name="nillable" type="xs:boolean"/> - <xs:attribute default="false" name="required" type="xs:boolean"/> - </xs:complexType> - </xs:element> - <xs:element name="xml-value" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:all> - <xs:element minOccurs="0" ref="xml-abstract-null-policy"/> - <xs:element minOccurs="0" ref="xml-access-methods"/> - <xs:element minOccurs="0" ref="xml-properties"/> - <xs:element minOccurs="0" ref="xml-java-type-adapter"/> - </xs:all> - <xs:attribute default="false" name="cdata" type="xs:boolean"/> - <xs:attribute default="false" name="read-only" type="xs:boolean"/> - <xs:attribute default="##default" name="type" type="xs:string"/> - <xs:attribute default="false" name="write-only" type="xs:boolean"/> - <xs:attribute default="##default" name="container-type" type="xs:string"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-map"> - <xs:complexType> - <xs:all> - <xs:element minOccurs="0" name="key"> - <xs:complexType> - <xs:attribute name="type" type="xs:string"/> - </xs:complexType> - </xs:element> - <xs:element minOccurs="0" name="value"> - <xs:complexType> - <xs:attribute name="type" type="xs:string"/> - </xs:complexType> - </xs:element> - </xs:all> - </xs:complexType> - </xs:element> - <xs:element name="xml-abstract-null-policy" type="xml-abstract-null-policy"/> - <xs:complexType abstract="true" name="xml-abstract-null-policy"> - <xs:attribute default="false" name="xsi-nil-represents-null" type="xs:boolean"/> - <xs:attribute default="false" name="empty-node-represents-null" type="xs:boolean"/> - <xs:attribute default="ABSENT_NODE" name="null-representation-for-xml" type="xml-marshal-null-representation"/> - </xs:complexType> - <xs:element name="xml-null-policy" substitutionGroup="xml-abstract-null-policy"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="xml-abstract-null-policy"> - <xs:attribute default="true" name="is-set-performed-for-absent-node" type="xs:boolean"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-is-set-null-policy" substitutionGroup="xml-abstract-null-policy"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="xml-abstract-null-policy"> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="0" name="is-set-parameter"> - <xs:complexType> - <xs:attribute name="value" type="xs:string" use="required"/> - <xs:attribute name="type" type="xs:string" use="required"/> - </xs:complexType> - </xs:element> - </xs:sequence> - <xs:attribute name="is-set-method-name" type="xs:string" use="required"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-transformation" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:sequence> - <xs:element minOccurs="0" name="xml-access-methods" type="xml-access-methods"/> - <xs:element minOccurs="0" ref="xml-properties"/> - <xs:element name="xml-read-transformer"> - <xs:complexType> - <xs:attribute name="method" type="xs:string"/> - <xs:attribute name="transformer-class" type="xs:string"/> - </xs:complexType> - </xs:element> - <xs:element maxOccurs="unbounded" minOccurs="0" name="xml-write-transformer"> - <xs:complexType> - <xs:attribute name="method" type="xs:string"/> - <xs:attribute name="xml-path" type="xs:string" use="required"/> - <xs:attribute name="transformer-class" type="xs:string"/> - </xs:complexType> - </xs:element> - </xs:sequence> - <xs:attribute default="true" name="optional" type="xs:boolean"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> - <xs:element name="xml-join-nodes" substitutionGroup="java-attribute"> - <xs:complexType> - <xs:complexContent> - <xs:extension base="java-attribute"> - <xs:sequence> - <xs:element maxOccurs="unbounded" minOccurs="1" name="xml-join-node"> - <xs:complexType> - <xs:attribute name="xml-path" type="xs:string" use="required"/> - <xs:attribute name="referenced-xml-path" type="xs:string" use="required"/> - </xs:complexType> - </xs:element> - </xs:sequence> - <xs:attribute default="##default" name="container-type" type="xs:string"/> - <xs:attribute default="##default" name="type" type="xs:string"/> - </xs:extension> - </xs:complexContent> - </xs:complexType> - </xs:element> -</xs:schema> diff --git a/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_persistence_map_1.0.xsd b/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_persistence_map_1.0.xsd deleted file mode 100644 index 02c6c61c6c..0000000000 --- a/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_persistence_map_1.0.xsd +++ /dev/null @@ -1,4109 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- -****************************************************************************** - Copyright (c) 1998, 2010 Oracle. All rights reserved. - This program and the accompanying materials are made available under the - terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 - which accompanies this distribution. - The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html - and the Eclipse Distribution License is available at - http://www.eclipse.org/org/documents/edl-v10.php. - - Contributors: - Oracle - initial API and implementation from Oracle TopLink -*****************************************************************************/ ---> -<!-- Eclipse Persistence Service Project :: Map Schema file for ORM/OXM/EIS --> -<xsd:schema - targetNamespace="http://www.eclipse.org/eclipselink/xsds/persistence" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" - xmlns="http://www.eclipse.org/eclipselink/xsds/persistence" - elementFormDefault="qualified" - attributeFormDefault="unqualified" - version="1.0" - > - <xsd:element name="object-persistence" type="object-persistence" /> - <xsd:complexType name="object-persistence"> - <xsd:annotation> - <xsd:documentation>An object-persistence mapping module, a set of class-mapping-descriptors.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>A name for the model being mapped.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-mapping-descriptors"> - <xsd:annotation> - <xsd:documentation>The list of class mapping descriptors.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="class-mapping-descriptor" type="class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Information of how a class is persisted to its data-store.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="login" type="datasource-login"> - <xsd:annotation> - <xsd:documentation>The datasource connection and configuration information.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="default-temporal-mutable" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Defines the default for how Date and Calendar types are used with change tracking.</xsd:documentation> - <xsd:documentation>By default they are assumed not to be changed directly (only replaced).</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - <xsd:attribute default="Eclipse Persistence Services - 1.0 (Build YYMMDD)" name="version" type="xsd:string" /> - </xsd:complexType> - <xsd:complexType name="datasource-login"> - <xsd:annotation> - <xsd:documentation>The datasource connection and configuration information.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="platform-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the platform class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="user-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The datasource user-name.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="password" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The datasource password, this is stored in encrypted form.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="external-connection-pooling" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Defines if the connections are managed by the datasource driver, and a new connection should be acquire per call.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="external-transaction-controller" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Defines if the transaction are managed by a transaction manager, and should not be managed by TopLink.</xsd:documentation> - <xsd:documentation>This can also be used if the datasource does not support transactions.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="sequencing"> - <xsd:annotation> - <xsd:documentation>Sequencing information.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" name="default-sequence" type="sequence"> - <xsd:annotation> - <xsd:documentation>Default sequence. The name is optional. If no name provided an empty string will be used as a name.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="sequences"> - <xsd:annotation> - <xsd:documentation>Non default sequences. Make sure each sequence has unique name.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="sequence" type="sequence" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="database-login"> - <xsd:annotation> - <xsd:documentation>The JDBC driver and database connection and configuration information.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="datasource-login"> - <xsd:sequence> - <xsd:element minOccurs="0" name="driver-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the JDBC driver class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="connection-url" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The full JDBC driver connection URL.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="bind-all-parameters" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if parameter binding should be used.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cache-all-statements" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if statement caching should be used. This should be used with parameter binding, this cannot be used with external connection pooling.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="byte-array-binding" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if byte array data-types should use binding.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="string-binding" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if string data-types should use binding.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="256" name="string-binding-size" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Configure the threshold string size for usage of string binding.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="streams-for-binding" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if large byte array and string data-types should be bound as streams.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="force-field-names-to-upper-case" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure to force all field names to upper-case.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="optimize-data-conversion" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure data optimization.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="trim-strings" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if string trailing blanks should be trimmed. This is normally required for CHAR data-types.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-writing" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if batch writing should be used.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="jdbc-batch-writing" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>If using batch writing, configure if the JDBC drivers batch writing should be used.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-login"> - <xsd:annotation> - <xsd:documentation>The JCA driver and EIS connection and configuration information.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="datasource-login"> - <xsd:sequence> - <xsd:element minOccurs="0" name="connection-spec-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the TopLink platform specific connection spec class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="connection-factory-url" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The JNDI url for the managed JCA adapter's connection factory.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-login"> - <xsd:annotation> - <xsd:documentation>The connection and configuration information.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="datasource-login"> - <xsd:sequence> - <xsd:element minOccurs="0" default="true" name="equal-namespace-resolvers" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Information of how a class is persisted to its data-store.</xsd:documentation> - <xsd:documentation>This is an abstract definition to allow flexibility in the types of classes and datastores persisted, i.e. interfaces, abstract classes, aggregates, non-relational persistence.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the implementation class being persisted. The class name must be full qualified with its package.</xsd:documentation> - <xsd:documentation>Example: <class xmlns="http://www.eclipse.org/eclipselink/xsds/persistence">example.employee.implementation.Employee</class></xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="alias" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optionally an alias name can be given for the class. The alias is a string that can be used to refer to the class in place of its implementation name, such as in querying.</xsd:documentation> - <xsd:documentation>Example: <alias xmlns="http://www.eclipse.org/eclipselink/xsds/persistence">Employee</alias></xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="primary-key"> - <xsd:annotation> - <xsd:documentation>The list of fields/columns that make up the primary key or unique identifier of the class.</xsd:documentation> - <xsd:documentation>This is used for caching, relationships, and for database operations.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The primary key field.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="read-only" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Defines if the class is read-only.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="properties"> - <xsd:annotation> - <xsd:documentation>Allow for user defined properties to be defined.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="property" type="property"> - <xsd:annotation> - <xsd:documentation>A user defined property.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="inheritance" type="inheritance-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class is related in inheritance and how this inheritance is persisted.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="events" type="event-policy"> - <xsd:annotation> - <xsd:documentation>Defines the persistent events for this class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="querying" type="query-policy"> - <xsd:annotation> - <xsd:documentation>The list of defined queries for the class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="attribute-mappings"> - <xsd:annotation> - <xsd:documentation>The list of mappings that define how the class' attributes are persisted.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="attribute-mapping" type="attribute-mapping"> - <xsd:annotation> - <xsd:documentation>Defines how a attribute is persisted. The attribute mapping definition is extendable to allow for different types of mappings.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="descriptor-type" type="class-descriptor-type"> - <xsd:annotation> - <xsd:documentation>Defines the descriptor type, such as aggregate or independent.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="interfaces" type="interface-policy"> - <xsd:annotation> - <xsd:documentation>Defines the interfaces that this class implements..</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="locking" type="locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines the locking behavior for the class. Such as an optimistic locking policy based on version, timestamp or change set of columns.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="sequencing" type="sequencing-policy"> - <xsd:annotation> - <xsd:documentation>Defines how a generated unique id should be assigned to the class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="caching" type="caching-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class' instances should be cached.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="remote-caching" type="caching-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class' instances should be cached on remote clients.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="history-policy" type="history-policy"> - <xsd:annotation> - <xsd:documentation>Defines how past versions of objects are persisted to the data-store. By default there will be no history policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="returning-policy" type="returning-policy"> - <xsd:annotation> - <xsd:documentation>Defines retuning policy. By default there will be no returning policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="amendment" type="amendment"> - <xsd:annotation> - <xsd:documentation>Allow for the descriptor to be amended or customized through a class API after loading.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="instantiation" type="instantiation-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object instantiation behavoir to be customized</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="copying" type="copy-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object cloning/copying behavoir to be customized.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="query-keys"> - <xsd:annotation> - <xsd:documentation>A list of query keys or aliases for database information. These can be used in queries instead of the database column names.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="query-key" type="query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for querying database information.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="cmp-policy" type="cmp-policy"> - <xsd:annotation> - <xsd:documentation>Place holder of CMP information specific.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="fetch-groups" type="fetch-groups"> - <xsd:annotation> - <xsd:documentation>Contains all pre-defined fetch groups at the descriptor level</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" maxOccurs="1" name="change-policy" type="change-policy"> - <xsd:annotation> - <xsd:documentation>Contains the Change Policy for this descriptor</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - <xsd:attribute fixed="10" name="schema-major-version" type="xsd:integer" /> - <xsd:attribute fixed="0" name="schema-minor-version" type="xsd:integer" /> - </xsd:complexType> - <xsd:simpleType name="class-descriptor-type"> - <xsd:annotation> - <xsd:documentation>Defines the class descriptor type.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="independent" /> - <xsd:enumeration value="aggregate" /> - <xsd:enumeration value="aggregate-collection" /> - <xsd:enumeration value="composite" /> - <xsd:enumeration value="composite" /> - <xsd:enumeration value="interface" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="interface-policy"> - <xsd:annotation> - <xsd:documentation>Specify the interfaces that a class descriptor implements, or the implemention class for an interface descriptor.</xsd:documentation> - <xsd:documentation>Optionally a set of public interfaces for the class can be specified. This allows the interface to be used to refer to the implementation class.</xsd:documentation> - <xsd:documentation>If two classes implement the same interface, an interface descriptor should be defined for the interface.</xsd:documentation> - <xsd:documentation>This can also be used to define inheritance between interface descriptors.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="interface" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified interface class name.</xsd:documentation> - <xsd:documentation>Example: <class xmlns="http://www.eclipse.org/eclipselink/xsds/persistence">example.employee.api.Employee</class></xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="implementor-descriptor" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified class name of the implementation class for which this interface is the public interface.</xsd:documentation> - <xsd:documentation>This can be used if the interface has only a single implementor.</xsd:documentation> - <xsd:documentation>Example: <class xmlns="http://www.eclipse.org/eclipselink/xsds/persistence">example.employee.impl.Employee</class></xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="copy-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object cloning/copying behavoir to be customized.</xsd:documentation> - </xsd:annotation> - </xsd:complexType> - <xsd:complexType name="instantiation-copy-policy"> - <xsd:annotation> - <xsd:documentation>Creates a copying through creating a new instance to copy into.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="copy-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="clone-copy-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object cloning/copying behavoir to be customized through a clone method.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="copy-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the clone method on the object, i.e. 'clone'</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="instantiation-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object instantiation behavoir to be customized.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the method on the factory to instantiate the object instance.'</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="factory-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified factory class name.'</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="factory-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the method to instantiate the factory class.'</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="amendment"> - <xsd:annotation> - <xsd:documentation>Specifies a class and static method to be called to allow for the descriptor to be amended or customized through a class API after loading.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="amendment-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation> The fully qualified name of the amendment class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="amendment-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the static amendment method on the class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="relational-class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Defines a class mapping to a relational database table(s).</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="class-mapping-descriptor"> - <xsd:sequence> - <xsd:element minOccurs="0" name="tables"> - <xsd:annotation> - <xsd:documentation>The list of the tables the class is persisted to. Typically a class is persisted to a single table, but multiple tables can be defined.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="table" type="table"> - <xsd:annotation> - <xsd:documentation>The list of tables that the class is persisted to. This is typically a single table but can be multiple, or empty for inheritance or aggregated classes.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="foreign-keys-for-multiple-table" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>Allow the foreign key field references to be define for multiple table descriptors.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="multiple-table-join-criteria" type="criteria"> - <xsd:annotation> - <xsd:documentation>For complex multiple table join conditions an expression may be provided instead of the table foreign key information.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy.</xsd:documentation> - </xsd:annotation> - </xsd:complexType> - <xsd:complexType name="version-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on a numeric version field/column that tracks changes and the version to an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="locking-policy"> - <xsd:sequence> - <xsd:element name="version-field" type="field"> - <xsd:annotation> - <xsd:documentation>The name and optionally the table of the column that the attribute is stored into.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="store-version-in-cache" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the version value should be stored in the cache, or if it will be stored in the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="timestamp-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on timestamp version column that tracks changes and the version to an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="version-locking-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" default="false" name="server-time" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the timestamp should be obtained locally or from the database server.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="all-fields-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on comparing the original read values of all fields of the object with the current state of the values in the database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="locking-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="changed-fields-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on comparing the original read values of only the changed fields of the object with the current state of the values in the database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="locking-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="selected-fields-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on comparing the original read values of a specified set of fields of the object with the current state of the values in the database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="locking-policy"> - <xsd:sequence> - <xsd:element name="fields"> - <xsd:annotation> - <xsd:documentation>Specify the set of fields to compare on update and delete.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="sequencing-policy"> - <xsd:annotation> - <xsd:documentation>Defines how a database generated unique id should be assigned to the class.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="sequence-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify the name of the sequence generator. This could be the name of a sequence object, or a row value in a sequence table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="sequence-field" type="field"> - <xsd:annotation> - <xsd:documentation>Specify the field/column that the generated sequence id is assigned to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:simpleType name="cache-type"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid caching types.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="none" /> - <xsd:enumeration value="full" /> - <xsd:enumeration value="cache" /> - <xsd:enumeration value="weak-reference" /> - <xsd:enumeration value="soft-reference" /> - <xsd:enumeration value="soft-cache-weak-reference" /> - <xsd:enumeration value="hard-cache-weak-reference" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="caching-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class' instances should be cached and how object identity should be maintained.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="soft-cache-weak-reference" name="cache-type" type="cache-type"> - <xsd:annotation> - <xsd:documentation>Specify the type of caching, such as LRU, weak reference or none.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="100" name="cache-size" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specify the initial or maximum size of the cache.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="always-refresh" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to always refresh cached objects on queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="only-refresh-cache-if-newer-version" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to refresh if the cached object is an older version.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="disable-cache-hits" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Disable obtaining cache hits on primary key queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="always-conform" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to always conform queries within a transaction.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="isolated" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if objects of this type should be isolated from the shared cache.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="isolate-new-data-after-transaction" name="unitofwork-isolation-level" type="unitofwork-isolation-level"> - <xsd:annotation> - <xsd:documentation>Specify how the unit of work should be isolated to the session cache.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="cache-invalidation-policy" type="cache-invalidation"> - <xsd:annotation> - <xsd:documentation>Defines the cache invalidation policy. By default there will be no cache invalidation policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="change-set" name="cache-sync-type" type="cache-sync-type"> - <xsd:annotation> - <xsd:documentation>The type of cache synchronization to be used with this descripor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="cache-invalidation" abstract="true"> - <xsd:annotation> - <xsd:documentation>Abstract superclass for cache invalidation policies.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="false" name="update-read-time-on-update" type="xsd:boolean" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="no-expiry-cache-invalidation-policy"> - <xsd:annotation> - <xsd:documentation>Cache invalidation policy where objects in the cache do not expire.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="cache-invalidation" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="time-to-live-cache-invalidation-policy"> - <xsd:annotation> - <xsd:documentation>Cache invalidation policy where objects live a specific number of milliseconds after they are read.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="cache-invalidation"> - <xsd:sequence> - <xsd:element name="time-to-live" type="xsd:long" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="daily-cache-invalidation-policy"> - <xsd:annotation> - <xsd:documentation>Cache invalidation Policy where objects expire at a specific time every day</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="cache-invalidation"> - <xsd:sequence> - <xsd:element name="expiry-time" type="xsd:dateTime" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="history-policy"> - <xsd:annotation> - <xsd:documentation>Defines how past versions of objects are to be persisted to the data-store.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="true" name="handle-writes" type="xsd:boolean" /> - <xsd:element minOccurs="0" default="false" name="use-database-time" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="history-tables"> - <xsd:annotation> - <xsd:documentation>Defines the names of the mirroring historical tables.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="history-table" type="history-table" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="start-fields"> - <xsd:annotation> - <xsd:documentation>Defines the start fields for each historical table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="start-field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="end-fields"> - <xsd:annotation> - <xsd:documentation>Defines the end fields for each historical table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="end-field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="history-table"> - <xsd:annotation> - <xsd:documentation>Each entry is a source (descriptor) to history table name association.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="" name="source" type="xsd:string" /> - <xsd:element minOccurs="1" name="history" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="returning-policy"> - <xsd:annotation> - <xsd:documentation>Defines retuning policy. By default there will be no returning policy.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="1" name="returning-field-infos"> - <xsd:annotation> - <xsd:documentation>Lists the fields to be returned together with the flags defining returning options</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="returning-field-info" type="returning-field-info" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="returning-field-info"> - <xsd:annotation> - <xsd:documentation>Field to be returned together with type and the flags defining returning options. At least one of insert, update should be true.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the target referenced class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The field to be returned.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="insert" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Indicates whether the field should be retuned after Insert.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="insert-mode-return-only" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>If insert==true, indicates whether the field should not be inserted (true). If insert==false - ignored.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="update" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Indicates whether the field should be retuned after Insert.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="inheritance-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class is related in inheritance and how this inheritance is persisted.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="parent-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the parent/superclass of the class being persisted. The class name must be full qualified with its package.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="read-subclasses-on-queries" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Define if subclasses of the class should be returned on queries, or only the exact class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="all-subclasses-view" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optionally specify the name of a view that joins all of the subclass' tables.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="use-class-name-as-indicator" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the fully qualified class name should be used as the class type indicator.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-extraction-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of a method on the class that takes the class' row as argument a computed that class type to be used to instantiate from the row.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-indicator-field" type="field"> - <xsd:annotation> - <xsd:documentation>The name of the type field/column that the class type is stored into.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-indicator-mappings" type="class-indicator-mappings"> - <xsd:annotation> - <xsd:documentation>The set of class indicator values and the subclasses they map to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-extractor" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of a class that implements a class extractor interface.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="only-instances-criteria" type="criteria"> - <xsd:annotation> - <xsd:documentation>The criteria that filters out all sibling and subclass instances on queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="all-subclasses-criteria" type="criteria"> - <xsd:annotation> - <xsd:documentation>The criteria that filters out sibling instances on queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="outer-join-subclasses" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>For inheritance queries specify if all subclasses should be outer joined, instead of a query per subclass.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="qname-inheritance-policy"> - <xsd:annotation> - <xsd:documentation>Extends inheritance policy. Allows for prefixed names to be resolved at runtime to find the approriate class</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="inheritance-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="class-indicator-mappings"> - <xsd:annotation> - <xsd:documentation>The set of class indicator values and the subclasses they map to.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="class-indicator-mapping"> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the class the type maps to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="class-indicator" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>The field value used to define the class type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="event-policy"> - <xsd:annotation> - <xsd:documentation>Defines the persistent events for this class.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="event-listeners"> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="event-listener" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of an event listener class that implements the descriptor event listener interface.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="post-build-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after building the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="pre-write-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before writing the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-write-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after writing the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="pre-insert-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before inserting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-insert-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after inserting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="pre-update-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before updating the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-update-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after updating the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="pre-delete-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before deleting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-delete-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after deleting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="about-to-insert-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before inserting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="about-to-update-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before updating the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-clone-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after cloning the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-merge-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after merging the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-refresh-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after refreshing the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="query-policy"> - <xsd:annotation> - <xsd:documentation>The list of defined queries and query properties for the class.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="queries"> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="query" type="query"> - <xsd:annotation> - <xsd:documentation>A query definition for the class' instances.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="timeout" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifies a timeout to apply to all queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="check-cache" name="existence" type="existence-policy"> - <xsd:annotation> - <xsd:documentation>Allow the behavoir used to determine if an insert or update should occur for an object to be customized.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="insert-query" type="insert-object-query"> - <xsd:annotation> - <xsd:documentation>Custom insert query. This overide the default insert behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="update-query" type="update-object-query"> - <xsd:annotation> - <xsd:documentation>Custom update query. This overide the default update behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-query" type="delete-object-query"> - <xsd:annotation> - <xsd:documentation>Custom delete query. This overide the default delete behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="does-exist-query" type="does-exist-query"> - <xsd:annotation> - <xsd:documentation>Custom does exist query. This overide the default delete behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="read-object-query" type="read-object-query"> - <xsd:annotation> - <xsd:documentation>Custom read object query. This overide the default read behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="read-all-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Custom read all query. This overide the default read all behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:simpleType name="existence-policy"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid existence policies for determining if an insert or update should occur for an object.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="check-cache" /> - <xsd:enumeration value="check-database" /> - <xsd:enumeration value="assume-existence" /> - <xsd:enumeration value="assume-non-existence" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for querying database information.</xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query-key alias name.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - </xsd:complexType> - <xsd:simpleType name="cache-sync-type"> - <xsd:annotation> - <xsd:documentation>The type of cache synchronization to use with a descriptor.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="invalidation" /> - <xsd:enumeration value="no-changes" /> - <xsd:enumeration value="change-set-with-new-objects" /> - <xsd:enumeration value="change-set" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:simpleType name="unitofwork-isolation-level"> - <xsd:annotation> - <xsd:documentation>Specify how the unit of work isolated from the session cache.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="use-session-cache-after-transaction" /> - <xsd:enumeration value="isolate-new-data-after-transaction" /> - <xsd:enumeration value="isolate-cache-after-transaction" /> - <xsd:enumeration value="isolate-cache-always" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="direct-query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for a database column.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="query-key"> - <xsd:sequence> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The field/column being aliased.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="relationship-query-key" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines an alias for a join to another class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="query-key"> - <xsd:sequence> - <xsd:element name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the target referenced class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:choice> - <xsd:element name="foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key join condition between the source and target class' tables.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="criteria" type="criteria"> - <xsd:annotation> - <xsd:documentation>The join criteria between the source and target class' tables.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:choice> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="one-to-one-query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for a 1-1 join to another class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-query-key" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="one-to-many-query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for a 1-m join from another class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent> - <xsd:extension base="relationship-query-key" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-direct-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping from an attirbute to a simple field datatype, i.e. String, Number, Date.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The name and optionally the table of the field/column that the attribute is stored into.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="null-value" type="xsd:anySimpleType" minOccurs="0"> - <xsd:annotation> - <xsd:documentation>Optionally specify a value that null data values should be converted to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="converter" type="value-converter" minOccurs="0"> - <xsd:annotation> - <xsd:documentation>Optionally specify how the data value should be converted to the object value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="attribute-classification" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="attribute-mapping"> - <xsd:annotation> - <xsd:documentation>Defines how a attribute is persisted. The attribute mapping definition is extendable to allow for different types of mappings.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="attribute-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the attribute. This is the implementation class attribute name.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="read-only" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the attribute is read-only.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="get-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the get method for the attribute.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="set-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the set method for the attribute.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="properties"> - <xsd:annotation> - <xsd:documentation>Allow for user defined properties to be defined.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="property" type="property"> - <xsd:annotation> - <xsd:documentation>A user defined property.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="direct-mapping"> - <xsd:annotation> - <xsd:documentation>Defines how a simple attribute is persisted.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent> - <xsd:extension base="abstract-direct-mapping"> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-direct-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping from an attirbute to a simple field datatype, i.e. String, Number, Date.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent> - <xsd:extension base="abstract-direct-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="is-cdata" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="null-policy" type="abstract-null-policy" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-direct-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping from an attirbute to a simple field datatype, i.e. String, Number, Date.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-direct-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="field-transformation" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a field transformation for a transformation mapping</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="field" type="field" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="method-based-field-transformation"> - <xsd:complexContent mixed="false"> - <xsd:extension base="field-transformation"> - <xsd:sequence> - <xsd:element name="method" type="xsd:string" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="transformer-based-field-transformation"> - <xsd:complexContent mixed="false"> - <xsd:extension base="field-transformation"> - <xsd:sequence> - <xsd:element name="transformer-class" type="xsd:string" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-transformation-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a transformation mapping that uses Java code to transform between the data and object values.</xsd:documentation> - <xsd:documentation>This can be used if a single attribute maps to multiple fields, or field only mappings or attribute only mappings.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="attribute-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the attribute transformation defined in the domain class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="attribute-transformer" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The class name of the attribute transformer. Used in place of attribute-transformation.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="mutable" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy" /> - <xsd:element minOccurs="0" name="field-transformations"> - <xsd:annotation> - <xsd:documentation>The field transformations.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field-transformation" type="field-transformation" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="transformation-mapping"> - <xsd:annotation> - <xsd:documentation>This can be used if a single attribute maps to multiple fields, or field only mappings or attribute only mappings.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-transformation-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-transformation-mapping"> - <xsd:annotation> - <xsd:documentation>This can be used if a single attribute maps to multiple fields, or field only mappings or attribute only mappings.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-transformation-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-transformation-mapping"> - <xsd:annotation> - <xsd:documentation>This can be used if a single attribute maps to multiple fields, or field only mappings or attribute only mappings.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-transformation-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="aggregate-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a relationship where the target object is strictly privately owned by the source object and stores within the source objects row</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified class name of the target class of the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="allow-null" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if a row of all nulls should be interpreted as null.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="field-translations"> - <xsd:annotation> - <xsd:documentation>Allow for the mapping to use different field names than the descriptor.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field-translation"> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="source-field" type="field"> - <xsd:annotation> - <xsd:documentation>The field in the source descriptor's table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="target-field" type="field"> - <xsd:annotation> - <xsd:documentation>The field in the aggregate descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="relationship-mapping"> - <xsd:annotation> - <xsd:documentation>Defines how a relationship between two classes is persisted.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified class name of the target class of the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="private-owned" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the target objects are privately owned dependent objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cascade-persist" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the create operation should be cascaded to the referenced object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cascade-merge" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the create operation should be cascaded to the referenced object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cascade-refresh" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the refresh operation should be cascaded to the referenced object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cascade-remove" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the remove operation should be cascaded to the referenced object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="one-to-one-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-1 relationship from the source instance to the target instance.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key in the source class' table that defines the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="foreign-key-fields"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-object-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-one-to-one-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-1 relationship from the source instance to the target instance.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="one-to-one-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="one-to-many-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-m relationship from the source instance to the target instances.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="target-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key in the target class' table that defines the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="delete-all-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the related objects can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-one-to-many-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-m relationship from the source instance to the target instances.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="source-foreign-key-fields"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="target-foreign-key-fields"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="foreign-key-grouping-element" type="field" /> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="delete-all-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the related objects can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a collection of simple types relationship from the source instance to a set of simple data values.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="data-read-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target data values.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="reference-table" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the reference table that stores the source primary key and the data values.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="direct-field" type="field"> - <xsd:annotation> - <xsd:documentation>The field/column in the reference table that stores the data values.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="reference-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key in the reference table that defines the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="value-converter" type="value-converter"> - <xsd:annotation> - <xsd:documentation>Optionally specify how the data value should be converted to the object value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="insert-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to insert a row into the reference table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to delete a row from the reference table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the rows from the reference table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="session-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name session that defines the reference table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="history-policy" type="history-policy"> - <xsd:annotation> - <xsd:documentation>Defines how past versions of this attribute are persisted to the data-store. By default there will be no history policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-map-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a map relationship from the source instance to a set of key values pairs of simple data values.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="direct-collection-mapping"> - <xsd:sequence> - <xsd:element name="direct-key-field" type="field"> - <xsd:annotation> - <xsd:documentation>The field/column in the reference table that sores the map key data value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="key-converter" type="value-converter"> - <xsd:annotation> - <xsd:documentation>Optionally specify how the key data value should be converted to the object value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="aggregate-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-m relationship from the source instance to the target instances where the target instances are strictly privately owned by the source object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="target-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key in the target class' table that defines the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="delete-all-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the related objects can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="many-to-many-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a m-m relationship from the source instance to the target instances.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="relation-table" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the relation table that stores the source/target primary keys.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="source-relation-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key from the relational table to the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="target-relation-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key from the relational table to the target class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="insert-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to insert a row into the relation table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to delete a row from the relation table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the rows from the relation table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="history-policy" type="history-policy"> - <xsd:annotation> - <xsd:documentation>Defines how past versions of this attribute are persisted to the data-store. By default there will be no history policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="variable-one-to-one-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-1 relationship from the source instance to the target instance that may be of several types related through an interface.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-object-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="type-field" type="field"> - <xsd:annotation> - <xsd:documentation>Specify the column to store the class type of the related object into.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="foreign-key-fields"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element name="foreign-key-to-query-key"> - <xsd:annotation> - <xsd:documentation>The list of source/target column/query key references relating a foreign key in one table to the query keys defining a primary or unique key value in the other interface descriptor.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="query-key-reference"> - <xsd:annotation> - <xsd:documentation>The reference of a source table foreign key and a target interface descriptor query key.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="source-field" type="field"> - <xsd:annotation> - <xsd:documentation>The foreign key field/column name in the source table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="target-query-key" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query key name of the target interface descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="class-indicator-mappings" type="class-indicator-mappings"> - <xsd:annotation> - <xsd:documentation>The set of class indicator values and the subclasses they map to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a container/collection type.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="collection-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the collection implementation class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="sorted-collection-container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a sorted collection type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="comparator-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the comparitor, used to compare objects in sorting the collection.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="list-container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a list collection type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="map-container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a map container type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="map-key-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the method to call on the target objects to get the key value for the map.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-map-container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a direct map container type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="scrollable-cursor-policy"> - <xsd:annotation> - <xsd:documentation>Defines a scrollable cursor container type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="cursored-stream-policy"> - <xsd:annotation> - <xsd:documentation>Defines a cursored stream container type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="indirection-policy" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a deferred read indirection mechanism.</xsd:documentation> - </xsd:annotation> - </xsd:complexType> - <xsd:complexType name="value-holder-indirection-policy"> - <xsd:annotation> - <xsd:documentation>Defines usage of value holders to implement indirection.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="indirection-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="proxy-indirection-policy"> - <xsd:annotation> - <xsd:documentation>Defines usage of proxies to implement indirection.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="indirection-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="transparent-collection-indirection-policy"> - <xsd:annotation> - <xsd:documentation>Defines usage of transparent collections to implement indirection.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="indirection-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="collection-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the collection interface to use, i.e. List, Set, Map.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="map-key-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the method to call on the target objects to get the key value for the map.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="container-indirection-policy"> - <xsd:annotation> - <xsd:documentation>Defines usage of a user defined container to implement indirection.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="indirection-policy"> - <xsd:sequence> - <xsd:element name="container-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the container implementer to use.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="typesafe-enumeration-converter"> - <xsd:annotation> - <xsd:documentation>Typesafe Enumeration conversion</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="value-converter" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="type-conversion-converter"> - <xsd:annotation> - <xsd:documentation>Specifies the data type and an object type of the attribute to convert between.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="value-converter"> - <xsd:sequence> - <xsd:element minOccurs="0" name="object-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the attribute type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="data-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the attributes storage data type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="serialized-object-converter"> - <xsd:annotation> - <xsd:documentation>Uses object serialization to convert between the object and data type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="value-converter"> - <xsd:sequence> - <xsd:element minOccurs="0" name="data-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the attributes storage data type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-type-converter"> - <xsd:annotation> - <xsd:documentation>Specifies a mapping of values from database values used in the field and object values used in the attribute.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="value-converter"> - <xsd:sequence> - <xsd:element minOccurs="0" name="default-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>An optional default value can be specified. This value is used if a database type is not found in the type mapping.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="type-mappings"> - <xsd:annotation> - <xsd:documentation>Specifies the mapping of values. Both the object and database values must be unique.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="type-mapping" type="type-mapping"> - <xsd:annotation> - <xsd:documentation>Defines the object and data value mapping.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="attribute-only-type-mappings"> - <xsd:annotation> - <xsd:documentation>Specifies a mapping of additional values that map non-unique data values to a unique attribute value.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="type-mapping" type="type-mapping"> - <xsd:annotation> - <xsd:documentation>Defines the object and data value mapping.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="type-mapping"> - <xsd:annotation> - <xsd:documentation>Define an object and data value mapping.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="object-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>Specifies the value to use in the object's attribute.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="data-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>Specifies the value to use in the database field.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="database-query" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query/interaction against a database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="query"> - <xsd:sequence> - <xsd:element minOccurs="0" default="true" name="maintain-cache" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the query should bypass the cache completely.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="bind-all-parameters" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the query should use paramater binding for arguments, or print the arguments in-line.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="cache-statement" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the queries statement should be cached, this must be used with parameter binding.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="timeout" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifies a timeout to cancel the query in if the request takes too long to complete.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="prepare" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the query should prepare and cache its generated SQL, or regenerate the SQL on each execution.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="call" type="criteria"> - <xsd:annotation> - <xsd:documentation>For static calls the SQL or Stored Procedure call definition can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid join fetch options.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="none" /> - <xsd:enumeration value="inner-join" /> - <xsd:enumeration value="outer-join" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:simpleType name="cascade-policy"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid cascade policies.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="none" /> - <xsd:enumeration value="private" /> - <xsd:enumeration value="all" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="value-read-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for reading a single value.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="direct-read-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-read-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for reading a collection of values.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="data-read-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="data-read-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for reading raw data.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="read-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="read-query" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query for reading.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query"> - <xsd:sequence> - <xsd:element minOccurs="0" default="false" name="cache-query-results" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the query should cache the query results to avoid future executions.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="max-rows" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifies the maximum number of rows to fetch, results will be trunctate on the database to this size.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="first-result" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifies where to start the cursor in a result set returned from the database. Results prior to this number will not be built into objects</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="fetch-size" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifiess the number of rows to fetch from the database on each result set next operation.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="query-result-cache-policy" type="query-result-cache-policy"> - <xsd:annotation> - <xsd:documentation>Specify how the query results should be cached.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="query-result-cache-policy"> - <xsd:annotation> - <xsd:documentation>Defines how a query's results should be cached.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="invalidation-policy" type="cache-invalidation"> - <xsd:annotation> - <xsd:documentation>Defines the cache invalidation policy. By default there will be no cache invalidation policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="100" name="maximum-cached-results" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>This defines the number of query result sets that will be cached. The LRU query results will be discarded when the max size is reached.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="data-modify-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for manipulating data.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-modify-query" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query for modifying an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="update-object-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for updating an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-modify-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="insert-object-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for inserting an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-modify-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="delete-object-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for deleting an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-modify-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="does-exist-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for determining if an object exists.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="existence-check" type="existence-check"> - <xsd:annotation> - <xsd:documentation>The existence check option.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="existence-check"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid existence check options.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="check-cache" /> - <xsd:enumeration value="check-database" /> - <xsd:enumeration value="assume-existence" /> - <xsd:enumeration value="assume-non-existence" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="delete-all-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for deleting a criteria of objects.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-level-read-query" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query for objects (as apposed to data).</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="read-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The full qualified name of the class of objects being queried.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="refresh" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the query should refresh any cached objects from the database.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="remote-refresh" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the query should refresh any remotely cached objects from the server.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="cascade-policy" type="cascade-policy"> - <xsd:annotation> - <xsd:documentation>Specifies if the queries settings (such as refresh, maintain-cache) should apply to the object's relationship queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="primary-key" name="cache-usage" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify how the query should interact with the cache.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="lock-mode" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify if the query should lock the resulting rows on the database.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="distinct-state" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify if the query should filter distinct results.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="in-memory-querying"> - <xsd:annotation> - <xsd:documentation>The in memory querying policy.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element default="ignore-exceptions-return-conformed" name="policy" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify how indirection or unconformable expressions should be treating with in-memory querying and conforming.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="use-default-fetch-group" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the default fetch group should be used for the query.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="fetch-group" type="fetch-group"> - <xsd:annotation> - <xsd:documentation>Allow the query to partially fetch the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="fetch-group-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify a pre-defined named fetch group to allow the query to partially fetch the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="use-exclusive-connection" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the exclusive connection (VPD) should be used for the query.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="joined-attribute-expressions"> - <xsd:annotation> - <xsd:documentation>Specifies the attributes being joined.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Represents an expression for joining</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="read-only" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if objects resulting from the query are read-only, and will not be registered in the unit of work.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="outer-join-subclasses" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>For inheritance queries specify if all subclasses should be outer joined, instead of a query per subclass.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="read-all-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for a set of objects.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-level-read-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="batch-read-attribute-expressions"> - <xsd:annotation> - <xsd:documentation>Specifies all attributes for batch reading.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Represents an expression for batch reading</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="order-by-expressions"> - <xsd:annotation> - <xsd:documentation>Sets the order expressions for the query.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Represents an expression for ordering</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="read-object-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for a single object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-level-read-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="report-query"> - <xsd:annotation> - <xsd:documentation>Query for information about a set of objects instead of the objects themselves.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="read-all-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="return-choice" type="return-choice"> - <xsd:annotation> - <xsd:documentation>Simplifies the result by only returning the first result, first value, or all attribute values.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="retrieve-primary-keys" type="retrieve-primary-keys"> - <xsd:annotation> - <xsd:documentation>Indicates wether the primary key values should also be retrieved for the reference class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="report-items"> - <xsd:annotation> - <xsd:documentation>Items to be selected, these could be attributes or aggregate functions.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="item" type="report-item"> - <xsd:annotation> - <xsd:documentation>Represents an item requested</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="group-by-expressions"> - <xsd:annotation> - <xsd:documentation>Sets GROUP BY expressions for the query.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Represents an expression for grouping</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="return-choice"> - <xsd:annotation> - <xsd:documentation>Simplifies the result by only returning the first result, first value, or all attribute values.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="return-single-result" /> - <xsd:enumeration value="return-single-value" /> - <xsd:enumeration value="return-single-attribute" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:simpleType name="retrieve-primary-keys"> - <xsd:annotation> - <xsd:documentation>Indicates wether the primary key values should also be retrieved for the reference class.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="full-primary-key" /> - <xsd:enumeration value="first-primary-key" /> - <xsd:enumeration value="no-primary-key" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="report-item"> - <xsd:annotation> - <xsd:documentation>Represents an item requested in ReportQuery.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Name given for item, can be used to retieve value from result.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="attribute-expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Expression (partial) that describes the attribute wanted.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="expression" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query filter expression tree.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="relation-expression"> - <xsd:annotation> - <xsd:documentation>Defines a relation expression that compares to expressions through operators such as equal, lessThan, etc..</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="left" type="expression" /> - <xsd:element name="right" type="expression" /> - </xsd:sequence> - <xsd:attribute name="operator" type="operator" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="logic-expression"> - <xsd:annotation> - <xsd:documentation>Defines a expression composed of two sub-expressions joined through an operator such as AND, OR.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="left" type="expression" /> - <xsd:element name="right" type="expression" /> - </xsd:sequence> - <xsd:attribute name="operator" type="operator" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="function-expression"> - <xsd:annotation> - <xsd:documentation>Defines a expression composed of a function applied to a list of sub-expressions.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element minOccurs="0" name="arguments"> - <xsd:annotation> - <xsd:documentation>The list of function arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="expression"> - <xsd:annotation> - <xsd:documentation>Defines an argument expression.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - <xsd:attribute name="function" type="operator" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="constant-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression value. If the value is null the value tag can is absent.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element minOccurs="0" name="value" type="xsd:anySimpleType" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="query-key-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression query-key.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="base" type="expression" /> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" /> - <xsd:attribute name="any-of" type="xsd:boolean" /> - <xsd:attribute name="outer-join" type="xsd:boolean" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="field-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression field.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="field" type="field" /> - <xsd:element name="base" type="expression" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="parameter-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression parameter.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="parameter" type="field" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="base-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression builder/base.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="operator"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid operators.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string" /> - </xsd:simpleType> - <xsd:complexType name="sql-call"> - <xsd:annotation> - <xsd:documentation>Defines an SQL query language string.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="sql" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The full SQL query string. Arguments can be specified through #arg-name tokens in the string.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="ejbql-call"> - <xsd:annotation> - <xsd:documentation>Defines an EJB-QL query language string.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="ejbql" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The EJB-QL query string.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="stored-procedure-call"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure invocation definition.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="procedure-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the stored procedure.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="cursor-output-procedure" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Define the call to use a cursor output parameter to define the result set.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="arguments"> - <xsd:annotation> - <xsd:documentation>The list of input and output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="procedure-argument"> - <xsd:annotation> - <xsd:documentation>Defines an argument to the procedure. The order of the arguments must match the procedure arguments if not named.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="stored-function-call"> - <xsd:annotation> - <xsd:documentation>Defines a stored function invocation definition.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="stored-procedure-call"> - <xsd:sequence> - <xsd:element minOccurs="1" name="stored-function-result" type="procedure-output-argument"> - <xsd:annotation> - <xsd:documentation>The return value of the stored-function.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="procedure-argument"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure call argument.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="procedure-argument-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The stored procedure name of the argument. For indexed argument the name is not required.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="argument-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query name of the argument. This is the name of the argument as define in the query.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="procedure-argument-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the argument class type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="procedure-argument-sqltype" type="xsd:int"> - <xsd:annotation> - <xsd:documentation>The JDBC int type of the argument, as defined in java.jdbc.Types</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="procedure-argument-sqltype-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the type if procedure-argument-sqltype is STRUCT or ARRAY</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="argument-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>The procedure argument value maybe be specified if not using a query argument.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="procedure-output-argument"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure call output argument.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="procedure-argument" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="procedure-inoutput-argument"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure call output argument.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="procedure-argument"> - <xsd:sequence> - <xsd:element name="output-argument-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query name of the argument. This is the name of the argument as define in the query.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-stored-procedure-call"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure invocation definition whose arguments contain at least one Oracle PL/SQL type that has no JDBC representation (e.g. BOOLEAN, PLS_INTEGER, PL/SQL record).</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="procedure-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the stored procedure.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="arguments"> - <xsd:annotation> - <xsd:documentation>The list of input and output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="plsql-procedure-argument-type"> - <xsd:annotation> - <xsd:documentation>Defines an argument to the procedure.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-procedure-argument-type" abstract="true"> - <xsd:sequence> - <xsd:element name="name" type="xsd:string" /> - <xsd:element minOccurs="0" name="index" type="xsd:string" /> - <xsd:element minOccurs="0" name="direction" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="jdbc-type"> - <xsd:complexContent mixed="false"> - <xsd:extension base="plsql-procedure-argument-type"> - <xsd:sequence> - <xsd:choice> - <xsd:element minOccurs="0" name="length" type="xsd:string" /> - <xsd:sequence> - <xsd:element name="precision" type="xsd:string" /> - <xsd:element name="scale" type="xsd:string" /> - </xsd:sequence> - </xsd:choice> - </xsd:sequence> - <xsd:attribute name="type-name" type="xsd:string" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-type"> - <xsd:complexContent mixed="false"> - <xsd:extension base="plsql-procedure-argument-type"> - <xsd:attribute name="type-name" type="xsd:string" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-record"> - <xsd:complexContent mixed="false"> - <xsd:extension base="plsql-procedure-argument-type"> - <xsd:sequence> - <xsd:element name="record-name" type="xsd:string" /> - <xsd:element name="type-name" type="xsd:string" /> - <xsd:element minOccurs="0" name="compatible-type" type="xsd:string" /> - <xsd:element minOccurs="0" name="fields"> - <xsd:annotation> - <xsd:documentation>The list of fields.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="plsql-procedure-argument-type"> - <xsd:annotation> - <xsd:documentation>Defines an argument to the procedure.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Defines a class mapping to an EIS record data structure.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="class-mapping-descriptor"> - <xsd:sequence> - <xsd:element name="datatype" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the record structure name the descriptor maps to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="namespace-resolver" type="namespace-resolver"> - <xsd:annotation> - <xsd:documentation>The namespace resolver for the descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="mapped-interaction"> - <xsd:annotation> - <xsd:documentation>Defines an EIS interaction utilizing MappedRecord.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="function-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the function.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-result-path" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the input result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="output-result-path" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the output result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-arguments"> - <xsd:annotation> - <xsd:documentation>The list of input arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="output-arguments"> - <xsd:annotation> - <xsd:documentation>The list of output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-interaction"> - <xsd:annotation> - <xsd:documentation>Defines an EIS interaction utilizing XML records.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="function-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the function.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-record-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name to use for the input record, if required by the adapter.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-root-element-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the output result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-result-path" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the input result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="output-result-path" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the output result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-arguments"> - <xsd:annotation> - <xsd:documentation>The list of input arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="output-arguments"> - <xsd:annotation> - <xsd:documentation>The list of output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="indexed-interaction"> - <xsd:annotation> - <xsd:documentation>Defines an EIS interaction utilizing Indexed records.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="function-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the function.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-arguments"> - <xsd:annotation> - <xsd:documentation>The list of input arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="output-arguments"> - <xsd:annotation> - <xsd:documentation>The list of output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="interaction-argument"> - <xsd:annotation> - <xsd:documentation>Defines an interaction argument.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="argument-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>The procedure argument value maybe be specified if not using a query argument.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The interaction name of the argument. For indexed arguments the name is not required.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - <xsd:attribute name="argument-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query name of the argumen. This is the name of the argument as define in the query, or the descriptor field name.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - </xsd:complexType> - <xsd:complexType name="object-relational-class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Defines a class mapping to a Structure type in an object-relational database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relational-class-mapping-descriptor"> - <xsd:sequence> - <xsd:element minOccurs="0" name="structure" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the object structure type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="field-order"> - <xsd:annotation> - <xsd:documentation>The ordered list of the field defined in the structure.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="nested-table-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-m/m-m relationship that makes use of the object-relational nested-table type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The field/column in the source table that stores the nested-table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="structure" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify the object-relational type name of the nested-table type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="array-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a collection of primitive/simple type values using the object-relational array type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-direct-collection-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="structure" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify the object-relational type name of the structure type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-array-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a collection of object-types using the object-relational array type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-collection-mapping"> - <xsd:sequence> - <xsd:element name="structure" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify the object-relational type name of the structure type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="structure-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a structure of object-types using the object-relational structure type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-object-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="reference-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a reference to another object-type using the object-relational reference type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The field in the source type that stores the reference.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-relational-field"> - <xsd:annotation> - <xsd:documentation>Defines an ObjectRelationalDatabaseField</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="field"> - <xsd:sequence> - <xsd:element minOccurs="0" name="nested-type-field" type="field" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-xml-type-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a direct mapping to an Oracle XDB XML Type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="direct-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="read-whole-document" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-composite-direct-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a direct collection mapping for an XML list of elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element name="field" type="field" /> - <xsd:element minOccurs="0" name="value-converter" type="value-converter"> - <xsd:annotation> - <xsd:documentation>Optionally specify how the data value should be converted to the object value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="value-converter-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optionally specify a user defined converter class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-collection-reference-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-M relationship from the source XML element to the target XML element based on a key.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="xml-object-reference-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="containerpolicy" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="uses-single-node" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-object-reference-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-1 relationship from the source XML element to the target XML element based on one or more keys.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="aggregate-object-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="source-to-target-key-field-association" type="foreign-key" /> - <xsd:element minOccurs="0" name="source-to-target-key-fields"> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-composite-direct-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a direct collection mapping for an XML list of elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-direct-collection-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="is-cdata" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-composite-direct-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a direct collection mapping for an XML list of elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-direct-collection-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-composite-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite collection mapping for an XML list of nested elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="reference-class" type="xsd:string" /> - <xsd:element name="field" type="field" /> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-composite-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite collection mapping for an XML list of nested elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-collection-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-composite-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite collection mapping for an XML list of nested elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-collection-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-composite-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite object mapping for an XML nested element.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="reference-class" type="xsd:string" /> - <xsd:element name="field" type="field" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-composite-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite object mapping for an XML nested element.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-object-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="null-policy" type="abstract-null-policy" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-composite-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite object mapping for an XML nested element.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-object-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Defines a class mapping to an XML element.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="class-mapping-descriptor"> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="default-root-element" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the element the descriptor maps to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="default-root-element-field" type="node"> - <xsd:annotation> - <xsd:documentation>The XMLField representing the default root element of the descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="should-preserve-document" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Indicates if nodes should be cached to preserve unmapped data</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="namespace-resolver" type="namespace-resolver"> - <xsd:annotation> - <xsd:documentation>The namespace resolver for the descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="schema" type="schema-reference"> - <xsd:annotation> - <xsd:documentation>The location of the XML Schema.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-any-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a collection to an xs:any declaration or xs:anyType element</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="field" type="field" /> - <xsd:element minOccurs="0" name="container" type="container-policy" /> - <xsd:element minOccurs="0" default="false" name="use-xml-root" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="keep-as-element-policy" type="xsd:string" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-any-attribute-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a collection to an xs:any declaration or xs:anyType element</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="field" type="field" /> - <xsd:element minOccurs="0" name="container" type="container-policy" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-any-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a single object to an xs:any declaration</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="field" type="field" /> - <xsd:element minOccurs="0" default="false" name="use-xml-root" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-fragment-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a single Node to a fragment of an XML document</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="xml-direct-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-fragment-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a collection of Nodes to a fragment of an XML document</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-collection-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-binary-data-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a binary object to base64 binary</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="xml-direct-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="is-swa-ref" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="mime-type" type="xsd:string" /> - <xsd:element minOccurs="0" name="should-inline-data" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-choice-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a collection to a choice structure in an xml document</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element name="container-policy" type="container-policy" /> - <xsd:element maxOccurs="unbounded" name="field-to-class-association" type="xml-choice-field-to-class-association" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-choice-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a collection to a choice structure in an xml document</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="field-to-class-association" type="xml-choice-field-to-class-association" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-choice-field-to-class-association"> - <xsd:sequence> - <xsd:element name="xml-field" type="node" /> - <xsd:element name="class-name" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="xml-conversion-pair"> - <xsd:sequence> - <xsd:element name="qname" type="xsd:string" /> - <xsd:element name="class-name" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="node"> - <xsd:annotation> - <xsd:documentation>Defines an XPath expression to an element or attribute in an XML document.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="field"> - <xsd:sequence> - <xsd:element minOccurs="0" name="position" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>The position of the node in the parent type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="typed-text-field" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>If this is a typed text field.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="single-node" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Indicates if each item in the collection is in the same node instead of having one node per item in the collection</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="schema-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The schema type of the element.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="xml-to-java-conversion-pair" type="xml-conversion-pair" /> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="java-to-xml-conversion-pair" type="xml-conversion-pair" /> - <xsd:element minOccurs="0" name="leaf-element-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Indicates the elements type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="union-node"> - <xsd:annotation> - <xsd:documentation>Use to represent nodes which are mapped to unions</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="field"> - <xsd:sequence> - <xsd:element minOccurs="0" name="typed-text-field" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>If this is a typed text field.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="single-node" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Indicates if each item in the collection is in the same node instead of having one node per item in the collection</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="schema-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The schema type of the element.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="xml-to-java-conversion-pair" type="xml-conversion-pair" /> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="java-to-xml-conversion-pair" type="xml-conversion-pair" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="namespace-resolver"> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="1" name="namespaces"> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="namespace" type="namespace" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" maxOccurs="1" name="default-namespace-uri" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="namespace"> - <xsd:sequence> - <xsd:element name="prefix" type="xsd:string" /> - <xsd:element name="namespace-uri" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="schema-reference"> - <xsd:sequence> - <xsd:element minOccurs="0" name="resource" type="xsd:string" /> - <xsd:element name="schema-context" type="xsd:string" /> - <xsd:element name="node-type" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="schema-class-path-reference"> - <xsd:complexContent mixed="false"> - <xsd:extension base="schema-reference" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="schema-file-reference"> - <xsd:complexContent mixed="false"> - <xsd:extension base="schema-reference" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="schema-url-reference"> - <xsd:complexContent mixed="false"> - <xsd:extension base="schema-reference" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="java-character"> - <xsd:restriction base="xsd:string" /> - </xsd:simpleType> - <xsd:simpleType name="java-timestamp"> - <xsd:restriction base="xsd:dateTime" /> - </xsd:simpleType> - <xsd:simpleType name="java-util-date"> - <xsd:restriction base="xsd:dateTime" /> - </xsd:simpleType> - <xsd:complexType name="cmp-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="pessimistic-locking" type="pessimistic-locking"> - <xsd:annotation> - <xsd:documentation>Defines the cmp bean-level pessimistic locking policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="defer-until-commit" type="defer-until-commit"> - <xsd:annotation> - <xsd:documentation>Defines modification deferral level for non-deferred writes.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="non-deferred-create-time" type="non-deferred-create-time"> - <xsd:annotation> - <xsd:documentation>Defines point at which insert will be issued to Database.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="pessimistic-locking"> - <xsd:sequence> - <xsd:element minOccurs="0" default="wait" name="locking-mode" type="locking-mode" /> - </xsd:sequence> - </xsd:complexType> - <xsd:simpleType name="defer-until-commit"> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="all-modifications" /> - <xsd:enumeration value="update-modifications" /> - <xsd:enumeration value="none" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:simpleType name="non-deferred-create-time"> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="after-ejbcreate" /> - <xsd:enumeration value="after-ejbpostcreate" /> - <xsd:enumeration value="undefined" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:simpleType name="locking-mode"> - <xsd:annotation> - <xsd:documentation>Holds the pessimistic locking mode.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="wait" /> - <xsd:enumeration value="no-wait" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="sequence"> - <xsd:annotation> - <xsd:documentation>Sequence object.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="" name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Sequence name.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="50" name="preallocation-size" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Sequence preallocation size.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="default-sequence"> - <xsd:annotation> - <xsd:documentation>References default sequence object, overriding its name and (optionally) preallocation size.</xsd:documentation> - <xsd:documentation>To use preallocation size of default sequence object, set preallocation size to 0</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="sequence" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="native-sequence"> - <xsd:annotation> - <xsd:documentation>Database sequence mechanism used.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="sequence" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="table-sequence"> - <xsd:annotation> - <xsd:documentation>Table sequence</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="sequence"> - <xsd:sequence> - <xsd:element minOccurs="0" default="SEQUENCE" name="table" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Define the name of the sequence table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="SEQ_NAME" name="name-field" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Define the name of the sequence name field in the sequence table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="SEQ_COUNT" name="counter-field" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Define the name of the sequence counter field in the sequence table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="unary-table-sequence"> - <xsd:annotation> - <xsd:documentation>Unary table sequence - sequence name is a table name, table has a single field and a single row</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="sequence"> - <xsd:sequence> - <xsd:element minOccurs="0" default="SEQUENCE" name="counter-field" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Define the name of the sequence counter field in the sequence table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xmlfile-sequence"> - <xsd:annotation> - <xsd:documentation>Xmlfile sequence.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="sequence" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-sequence"> - <xsd:annotation> - <xsd:documentation>Xml sequence</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="sequence"> - <xsd:sequence> - <xsd:element minOccurs="0" default="SEQUENCE" name="root-element" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Define the name of the sequence table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="SEQ_NAME" name="name-element" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Define the name of the sequence name field in the sequence table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="SEQ_COUNT" name="counter-element" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Define the name of the sequence counter field in the sequence table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="fetch-groups"> - <xsd:annotation> - <xsd:documentation>Contains all pre-defined fetch groups.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="default-fetch-group" type="fetch-group" /> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="fetch-group" type="fetch-group" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="fetch-group"> - <xsd:annotation> - <xsd:documentation>Contains the fetch group attributes info.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="name" type="xsd:string" /> - <xsd:element name="fetch-group-attributes"> - <xsd:complexType> - <xsd:annotation> - <xsd:documentation>Contains a fetch group's attribute list.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="fetch-group-attribute" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="change-policy"> - <xsd:annotation> - <xsd:documentation>Describes the change tracking policy for this descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:complexType> - <xsd:complexType name="deferred-detection-change-policy"> - <xsd:annotation> - <xsd:documentation>Uses backup clone to detect changes.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="change-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-level-change-policy"> - <xsd:annotation> - <xsd:documentation>Uses "mark dirty" to detect changes.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="change-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="attribute-level-change-policy"> - <xsd:annotation> - <xsd:documentation>Uses a ChangeTracker firing PropertyChangeEvent's to detect changes.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="change-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-null-policy"> - <xsd:annotation> - <xsd:documentation>Defines the Null Policy in use for this relationship currently a choice of [NullPolicy and IsSetNullPolicy].</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="false" name="xsi-nil-represents-null" type="xsd:boolean" /> - <xsd:element minOccurs="0" default="false" name="empty-node-represents-null" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="null-representation-for-xml" type="marshal-null-representation" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="null-policy"> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-null-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" default="true" name="is-set-performed-for-absent-node" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="is-set-null-policy"> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-null-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="is-set-method-name" type="xsd:string" /> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="is-set-parameter-type" type="xsd:string" /> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="is-set-parameter" type="xsd:string" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="marshal-null-representation"> - <xsd:annotation> - <xsd:documentation>Write null, no tag(default) or an empty tag.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="XSI_NIL" /> - <xsd:enumeration value="ABSENT_NODE" /> - <xsd:enumeration value="EMPTY_NODE" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="field"> - <xsd:annotation> - <xsd:documentation>Defines a generic field concept, such as a database column.</xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the field.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - </xsd:complexType> - <xsd:complexType name="column"> - <xsd:annotation> - <xsd:documentation>Defines a column in a relational database table.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="field"> - <xsd:attribute name="table" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the column's table. This table must be listed in the class' tables. If not specified the first table of the class will be used.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="foreign-key"> - <xsd:annotation> - <xsd:documentation>The list of source/target field/column references relating a foreign key in one table to the primary or unique key in another table.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="field-reference"> - <xsd:annotation> - <xsd:documentation>The reference of a source table foreign key and a target table primary key.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="source-field" type="field"> - <xsd:annotation> - <xsd:documentation>The foreign key field/column name in the source table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="target-field" type="field"> - <xsd:annotation> - <xsd:documentation>The primary or unique key field/column name in the target table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="query"> - <xsd:annotation> - <xsd:documentation>Defines a query specification for querying instances of the class.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="criteria" type="criteria"> - <xsd:annotation> - <xsd:documentation>The selection criteria of the query.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="arguments"> - <xsd:annotation> - <xsd:documentation>The list of query arguments. The order of the argument must match the order of the argument value passed to the query.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="query-argument"> - <xsd:annotation> - <xsd:documentation>The query argument.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the query. This name can be used to reference and execute the query.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - </xsd:complexType> - <xsd:complexType name="criteria"> - <xsd:annotation> - <xsd:documentation>Defines the filtering clause of a query.</xsd:documentation> - </xsd:annotation> - </xsd:complexType> - <xsd:complexType name="query-argument"> - <xsd:annotation> - <xsd:documentation>Defines a query argument.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified class type name of the argument may be provided.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>Optional constant value for the argument.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the query argument.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - </xsd:complexType> - <xsd:complexType name="property"> - <xsd:annotation> - <xsd:documentation>A user defined property.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="value" type="xsd:anyType" /> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" /> - </xsd:complexType> - <xsd:complexType name="table"> - <xsd:annotation> - <xsd:documentation>The list of tables that the class is persisted to. This is typically a single table but can be multiple, or empty for inheritance or aggregated classes.</xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the table. The name can be fully qualified with the schema, tablespace or link.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - </xsd:complexType> - <xsd:complexType name="value-converter"> - <xsd:annotation> - <xsd:documentation> - Specifies how the data value should be converted to the - object value. - </xsd:documentation> - </xsd:annotation> - </xsd:complexType> -</xsd:schema>
\ No newline at end of file diff --git a/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_persistence_map_2.3.xsd b/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_persistence_map_2.3.xsd deleted file mode 100644 index 12a97f0bd7..0000000000 --- a/common/plugins/org.eclipse.jpt.common.eclipselink.core/schemas/eclipselink_persistence_map_2.3.xsd +++ /dev/null @@ -1,4307 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- -****************************************************************************** - Copyright (c) 1998, 2010 Oracle. All rights reserved. - This program and the accompanying materials are made available under the - terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 - which accompanies this distribution. - The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html - and the Eclipse Distribution License is available at - http://www.eclipse.org/org/documents/edl-v10.php. - - Contributors: - Oracle - initial API and implementation from Oracle TopLink -*****************************************************************************/ ---> -<!-- Eclipse Persistence Service Project :: Map Schema file for ORM/OXM/EIS --> -<xsd:schema - targetNamespace="http://www.eclipse.org/eclipselink/xsds/persistence" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" - xmlns="http://www.eclipse.org/eclipselink/xsds/persistence" - elementFormDefault="qualified" - attributeFormDefault="unqualified" - version="2.3" - > - <xsd:element name="object-persistence" type="object-persistence" /> - <xsd:complexType name="object-persistence"> - <xsd:annotation> - <xsd:documentation>An object-persistence mapping module, a set of class-mapping-descriptors.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>A name for the model being mapped.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-mapping-descriptors"> - <xsd:annotation> - <xsd:documentation>The list of class mapping descriptors.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="class-mapping-descriptor" type="class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Information of how a class is persisted to its data-store.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="login" type="datasource-login"> - <xsd:annotation> - <xsd:documentation>The datasource connection and configuration information.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="default-temporal-mutable" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Defines the default for how Date and Calendar types are used with change tracking.</xsd:documentation> - <xsd:documentation>By default they are assumed not to be changed directly (only replaced).</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="queries"> - <xsd:annotation> - <xsd:documentation>A list of queries to be stored on the session.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="query" type="database-query"> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - <xsd:attribute default="Eclipse Persistence Services - 2.0 (Build YYMMDD)" name="version" type="xsd:string" /> - </xsd:complexType> - <xsd:complexType name="datasource-login"> - <xsd:annotation> - <xsd:documentation>The datasource connection and configuration information.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="platform-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the platform class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="user-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The datasource user-name.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="password" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The datasource password, this is stored in encrypted form.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="external-connection-pooling" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Defines if the connections are managed by the datasource driver, and a new connection should be acquire per call.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="external-transaction-controller" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Defines if the transaction are managed by a transaction manager, and should not be managed by TopLink.</xsd:documentation> - <xsd:documentation>This can also be used if the datasource does not support transactions.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="sequencing"> - <xsd:annotation> - <xsd:documentation>Sequencing information.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" name="default-sequence" type="sequence"> - <xsd:annotation> - <xsd:documentation>Default sequence. The name is optional. If no name provided an empty string will be used as a name.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="sequences"> - <xsd:annotation> - <xsd:documentation>Non default sequences. Make sure each sequence has unique name.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="sequence" type="sequence" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="database-login"> - <xsd:annotation> - <xsd:documentation>The JDBC driver and database connection and configuration information.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="datasource-login"> - <xsd:sequence> - <xsd:element minOccurs="0" name="driver-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the JDBC driver class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="connection-url" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The full JDBC driver connection URL.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="bind-all-parameters" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if parameter binding should be used.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cache-all-statements" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if statement caching should be used. This should be used with parameter binding, this cannot be used with external connection pooling.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="byte-array-binding" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if byte array data-types should use binding.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="string-binding" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if string data-types should use binding.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="256" name="string-binding-size" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Configure the threshold string size for usage of string binding.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="streams-for-binding" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if large byte array and string data-types should be bound as streams.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="force-field-names-to-upper-case" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure to force all field names to upper-case.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="optimize-data-conversion" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure data optimization.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="trim-strings" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if string trailing blanks should be trimmed. This is normally required for CHAR data-types.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-writing" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Configure if batch writing should be used.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="jdbc-batch-writing" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>If using batch writing, configure if the JDBC drivers batch writing should be used.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-login"> - <xsd:annotation> - <xsd:documentation>The JCA driver and EIS connection and configuration information.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="datasource-login"> - <xsd:sequence> - <xsd:element minOccurs="0" name="connection-spec-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the TopLink platform specific connection spec class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="connection-factory-url" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The JNDI url for the managed JCA adapter's connection factory.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-login"> - <xsd:annotation> - <xsd:documentation>The connection and configuration information.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="datasource-login"> - <xsd:sequence> - <xsd:element minOccurs="0" default="true" - name="equal-namespace-resolvers" type="xsd:boolean" /> - <xsd:element name="document-preservation-policy" - type="document-preservation-policy" maxOccurs="1" - minOccurs="0"> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Information of how a class is persisted to its data-store.</xsd:documentation> - <xsd:documentation>This is an abstract definition to allow flexibility in the types of classes and datastores persisted, i.e. interfaces, abstract classes, aggregates, non-relational persistence.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the implementation class being persisted. The class name must be full qualified with its package.</xsd:documentation> - <xsd:documentation>Example: <class xmlns="http://www.eclipse.org/eclipselink/xsds/persistence">example.employee.implementation.Employee</class></xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="alias" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optionally an alias name can be given for the class. The alias is a string that can be used to refer to the class in place of its implementation name, such as in querying.</xsd:documentation> - <xsd:documentation>Example: <alias xmlns="http://www.eclipse.org/eclipselink/xsds/persistence">Employee</alias></xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="primary-key"> - <xsd:annotation> - <xsd:documentation>The list of fields/columns that make up the primary key or unique identifier of the class.</xsd:documentation> - <xsd:documentation>This is used for caching, relationships, and for database operations.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The primary key field.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="read-only" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Defines if the class is read-only.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="properties"> - <xsd:annotation> - <xsd:documentation>Allow for user defined properties to be defined.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="property" type="property"> - <xsd:annotation> - <xsd:documentation>A user defined property.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="inheritance" type="inheritance-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class is related in inheritance and how this inheritance is persisted.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="events" type="event-policy"> - <xsd:annotation> - <xsd:documentation>Defines the persistent events for this class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="querying" type="query-policy"> - <xsd:annotation> - <xsd:documentation>The list of defined queries for the class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="attribute-mappings"> - <xsd:annotation> - <xsd:documentation>The list of mappings that define how the class' attributes are persisted.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="attribute-mapping" type="attribute-mapping"> - <xsd:annotation> - <xsd:documentation>Defines how a attribute is persisted. The attribute mapping definition is extendable to allow for different types of mappings.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="descriptor-type" type="class-descriptor-type"> - <xsd:annotation> - <xsd:documentation>Defines the descriptor type, such as aggregate or independent.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="interfaces" type="interface-policy"> - <xsd:annotation> - <xsd:documentation>Defines the interfaces that this class implements..</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="locking" type="locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines the locking behavior for the class. Such as an optimistic locking policy based on version, timestamp or change set of columns.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="sequencing" type="sequencing-policy"> - <xsd:annotation> - <xsd:documentation>Defines how a generated unique id should be assigned to the class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="caching" type="caching-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class' instances should be cached.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="remote-caching" type="caching-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class' instances should be cached on remote clients.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="history-policy" type="history-policy"> - <xsd:annotation> - <xsd:documentation>Defines how past versions of objects are persisted to the data-store. By default there will be no history policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="returning-policy" type="returning-policy"> - <xsd:annotation> - <xsd:documentation>Defines retuning policy. By default there will be no returning policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="amendment" type="amendment"> - <xsd:annotation> - <xsd:documentation>Allow for the descriptor to be amended or customized through a class API after loading.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="instantiation" type="instantiation-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object instantiation behavoir to be customized</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="copying" type="copy-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object cloning/copying behavoir to be customized.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="query-keys"> - <xsd:annotation> - <xsd:documentation>A list of query keys or aliases for database information. These can be used in queries instead of the database column names.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="query-key" type="query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for querying database information.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="cmp-policy" type="cmp-policy"> - <xsd:annotation> - <xsd:documentation>Place holder of CMP information specific.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="fetch-groups" type="fetch-groups"> - <xsd:annotation> - <xsd:documentation>Contains all pre-defined fetch groups at the descriptor level</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" maxOccurs="1" name="change-policy" type="change-policy"> - <xsd:annotation> - <xsd:documentation>Contains the Change Policy for this descriptor</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - <xsd:attribute fixed="10" name="schema-major-version" type="xsd:integer" /> - <xsd:attribute fixed="0" name="schema-minor-version" type="xsd:integer" /> - </xsd:complexType> - <xsd:simpleType name="class-descriptor-type"> - <xsd:annotation> - <xsd:documentation>Defines the class descriptor type.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="independent" /> - <xsd:enumeration value="aggregate" /> - <xsd:enumeration value="aggregate-collection" /> - <xsd:enumeration value="composite" /> - <xsd:enumeration value="composite" /> - <xsd:enumeration value="interface" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="interface-policy"> - <xsd:annotation> - <xsd:documentation>Specify the interfaces that a class descriptor implements, or the implemention class for an interface descriptor.</xsd:documentation> - <xsd:documentation>Optionally a set of public interfaces for the class can be specified. This allows the interface to be used to refer to the implementation class.</xsd:documentation> - <xsd:documentation>If two classes implement the same interface, an interface descriptor should be defined for the interface.</xsd:documentation> - <xsd:documentation>This can also be used to define inheritance between interface descriptors.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="interface" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified interface class name.</xsd:documentation> - <xsd:documentation>Example: <class xmlns="http://www.eclipse.org/eclipselink/xsds/persistence">example.employee.api.Employee</class></xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="implementor-descriptor" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified class name of the implementation class for which this interface is the public interface.</xsd:documentation> - <xsd:documentation>This can be used if the interface has only a single implementor.</xsd:documentation> - <xsd:documentation>Example: <class xmlns="http://www.eclipse.org/eclipselink/xsds/persistence">example.employee.impl.Employee</class></xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="copy-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object cloning/copying behavoir to be customized.</xsd:documentation> - </xsd:annotation> - </xsd:complexType> - <xsd:complexType name="instantiation-copy-policy"> - <xsd:annotation> - <xsd:documentation>Creates a copying through creating a new instance to copy into.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="copy-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="clone-copy-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object cloning/copying behavoir to be customized through a clone method.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="copy-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the clone method on the object, i.e. 'clone'</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="instantiation-policy"> - <xsd:annotation> - <xsd:documentation>Allow the object instantiation behavoir to be customized.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the method on the factory to instantiate the object instance.'</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="factory-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified factory class name.'</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="factory-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the method to instantiate the factory class.'</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="amendment"> - <xsd:annotation> - <xsd:documentation>Specifies a class and static method to be called to allow for the descriptor to be amended or customized through a class API after loading.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="amendment-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation> The fully qualified name of the amendment class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="amendment-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the static amendment method on the class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="relational-class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Defines a class mapping to a relational database table(s).</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="class-mapping-descriptor"> - <xsd:sequence> - <xsd:element minOccurs="0" name="tables"> - <xsd:annotation> - <xsd:documentation>The list of the tables the class is persisted to. Typically a class is persisted to a single table, but multiple tables can be defined.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="table" type="table"> - <xsd:annotation> - <xsd:documentation>The list of tables that the class is persisted to. This is typically a single table but can be multiple, or empty for inheritance or aggregated classes.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="foreign-keys-for-multiple-table" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>Allow the foreign key field references to be define for multiple table descriptors.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="multiple-table-join-criteria" type="criteria"> - <xsd:annotation> - <xsd:documentation>For complex multiple table join conditions an expression may be provided instead of the table foreign key information.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy.</xsd:documentation> - </xsd:annotation> - </xsd:complexType> - <xsd:complexType name="version-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on a numeric version field/column that tracks changes and the version to an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="locking-policy"> - <xsd:sequence> - <xsd:element name="version-field" type="field"> - <xsd:annotation> - <xsd:documentation>The name and optionally the table of the column that the attribute is stored into.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="store-version-in-cache" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the version value should be stored in the cache, or if it will be stored in the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="timestamp-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on timestamp version column that tracks changes and the version to an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="version-locking-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" default="false" name="server-time" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the timestamp should be obtained locally or from the database server.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="all-fields-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on comparing the original read values of all fields of the object with the current state of the values in the database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="locking-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="changed-fields-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on comparing the original read values of only the changed fields of the object with the current state of the values in the database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="locking-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="selected-fields-locking-policy"> - <xsd:annotation> - <xsd:documentation>Defines an optimistic locking policy based on comparing the original read values of a specified set of fields of the object with the current state of the values in the database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="locking-policy"> - <xsd:sequence> - <xsd:element name="fields"> - <xsd:annotation> - <xsd:documentation>Specify the set of fields to compare on update and delete.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="sequencing-policy"> - <xsd:annotation> - <xsd:documentation>Defines how a database generated unique id should be assigned to the class.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="sequence-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify the name of the sequence generator. This could be the name of a sequence object, or a row value in a sequence table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="sequence-field" type="field"> - <xsd:annotation> - <xsd:documentation>Specify the field/column that the generated sequence id is assigned to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:simpleType name="cache-type"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid caching types.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="none" /> - <xsd:enumeration value="full" /> - <xsd:enumeration value="cache" /> - <xsd:enumeration value="weak-reference" /> - <xsd:enumeration value="soft-reference" /> - <xsd:enumeration value="soft-cache-weak-reference" /> - <xsd:enumeration value="hard-cache-weak-reference" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="caching-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class' instances should be cached and how object identity should be maintained.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="soft-cache-weak-reference" name="cache-type" type="cache-type"> - <xsd:annotation> - <xsd:documentation>Specify the type of caching, such as LRU, weak reference or none.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="100" name="cache-size" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specify the initial or maximum size of the cache.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="always-refresh" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to always refresh cached objects on queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="only-refresh-cache-if-newer-version" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to refresh if the cached object is an older version.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="disable-cache-hits" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Disable obtaining cache hits on primary key queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="always-conform" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to always conform queries within a transaction.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="isolated" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if objects of this type should be isolated from the shared cache.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="isolate-new-data-after-transaction" name="unitofwork-isolation-level" type="unitofwork-isolation-level"> - <xsd:annotation> - <xsd:documentation>Specify how the unit of work should be isolated to the session cache.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="cache-invalidation-policy" type="cache-invalidation"> - <xsd:annotation> - <xsd:documentation>Defines the cache invalidation policy. By default there will be no cache invalidation policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="change-set" name="cache-sync-type" type="cache-sync-type"> - <xsd:annotation> - <xsd:documentation>The type of cache synchronization to be used with this descripor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="cache-invalidation" abstract="true"> - <xsd:annotation> - <xsd:documentation>Abstract superclass for cache invalidation policies.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="false" name="update-read-time-on-update" type="xsd:boolean" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="no-expiry-cache-invalidation-policy"> - <xsd:annotation> - <xsd:documentation>Cache invalidation policy where objects in the cache do not expire.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="cache-invalidation" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="time-to-live-cache-invalidation-policy"> - <xsd:annotation> - <xsd:documentation>Cache invalidation policy where objects live a specific number of milliseconds after they are read.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="cache-invalidation"> - <xsd:sequence> - <xsd:element name="time-to-live" type="xsd:long" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="daily-cache-invalidation-policy"> - <xsd:annotation> - <xsd:documentation>Cache invalidation Policy where objects expire at a specific time every day</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="cache-invalidation"> - <xsd:sequence> - <xsd:element name="expiry-time" type="xsd:dateTime" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="history-policy"> - <xsd:annotation> - <xsd:documentation>Defines how past versions of objects are to be persisted to the data-store.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="true" name="handle-writes" type="xsd:boolean" /> - <xsd:element minOccurs="0" default="false" name="use-database-time" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="history-tables"> - <xsd:annotation> - <xsd:documentation>Defines the names of the mirroring historical tables.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="history-table" type="history-table" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="start-fields"> - <xsd:annotation> - <xsd:documentation>Defines the start fields for each historical table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="start-field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="end-fields"> - <xsd:annotation> - <xsd:documentation>Defines the end fields for each historical table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="end-field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="history-table"> - <xsd:annotation> - <xsd:documentation>Each entry is a source (descriptor) to history table name association.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" default="" name="source" type="xsd:string" /> - <xsd:element minOccurs="1" name="history" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="returning-policy"> - <xsd:annotation> - <xsd:documentation>Defines retuning policy. By default there will be no returning policy.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="1" name="returning-field-infos"> - <xsd:annotation> - <xsd:documentation>Lists the fields to be returned together with the flags defining returning options</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="returning-field-info" type="returning-field-info" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="returning-field-info"> - <xsd:annotation> - <xsd:documentation>Field to be returned together with type and the flags defining returning options. At least one of insert, update should be true.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the target referenced class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The field to be returned.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="insert" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Indicates whether the field should be retuned after Insert.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="insert-mode-return-only" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>If insert==true, indicates whether the field should not be inserted (true). If insert==false - ignored.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="update" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Indicates whether the field should be retuned after Insert.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="inheritance-policy"> - <xsd:annotation> - <xsd:documentation>Defines how the class is related in inheritance and how this inheritance is persisted.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="parent-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the parent/superclass of the class being persisted. The class name must be full qualified with its package.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="read-subclasses-on-queries" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Define if subclasses of the class should be returned on queries, or only the exact class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="all-subclasses-view" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optionally specify the name of a view that joins all of the subclass' tables.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="use-class-name-as-indicator" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the fully qualified class name should be used as the class type indicator.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-extraction-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of a method on the class that takes the class' row as argument a computed that class type to be used to instantiate from the row.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-indicator-field" type="field"> - <xsd:annotation> - <xsd:documentation>The name of the type field/column that the class type is stored into.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-indicator-mappings" type="class-indicator-mappings"> - <xsd:annotation> - <xsd:documentation>The set of class indicator values and the subclasses they map to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="class-extractor" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of a class that implements a class extractor interface.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="only-instances-criteria" type="criteria"> - <xsd:annotation> - <xsd:documentation>The criteria that filters out all sibling and subclass instances on queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="all-subclasses-criteria" type="criteria"> - <xsd:annotation> - <xsd:documentation>The criteria that filters out sibling instances on queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="outer-join-subclasses" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>For inheritance queries specify if all subclasses should be outer joined, instead of a query per subclass.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="qname-inheritance-policy"> - <xsd:annotation> - <xsd:documentation>Extends inheritance policy. Allows for prefixed names to be resolved at runtime to find the approriate class</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="inheritance-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="class-indicator-mappings"> - <xsd:annotation> - <xsd:documentation>The set of class indicator values and the subclasses they map to.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="class-indicator-mapping"> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the class the type maps to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="class-indicator" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>The field value used to define the class type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="event-policy"> - <xsd:annotation> - <xsd:documentation>Defines the persistent events for this class.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="event-listeners"> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="event-listener" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of an event listener class that implements the descriptor event listener interface.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="post-build-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after building the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="pre-write-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before writing the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-write-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after writing the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="pre-insert-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before inserting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-insert-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after inserting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="pre-update-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before updating the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-update-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after updating the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="pre-delete-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before deleting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-delete-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after deleting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="about-to-insert-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before inserting the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="about-to-update-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed before updating the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-clone-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after cloning the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-merge-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after merging the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="post-refresh-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Method executed after refreshing the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="query-policy"> - <xsd:annotation> - <xsd:documentation>The list of defined queries and query properties for the class.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="queries"> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="query" type="query"> - <xsd:annotation> - <xsd:documentation>A query definition for the class' instances.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="timeout" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifies a timeout to apply to all queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="check-cache" name="existence" type="existence-policy"> - <xsd:annotation> - <xsd:documentation>Allow the behavoir used to determine if an insert or update should occur for an object to be customized.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="insert-query" type="insert-object-query"> - <xsd:annotation> - <xsd:documentation>Custom insert query. This overide the default insert behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="update-query" type="update-object-query"> - <xsd:annotation> - <xsd:documentation>Custom update query. This overide the default update behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-query" type="delete-object-query"> - <xsd:annotation> - <xsd:documentation>Custom delete query. This overide the default delete behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="does-exist-query" type="does-exist-query"> - <xsd:annotation> - <xsd:documentation>Custom does exist query. This overide the default delete behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="read-object-query" type="read-object-query"> - <xsd:annotation> - <xsd:documentation>Custom read object query. This overide the default read behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="read-all-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Custom read all query. This overide the default read all behavoir for usage with stored procedures or custom calls.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:simpleType name="existence-policy"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid existence policies for determining if an insert or update should occur for an object.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="check-cache" /> - <xsd:enumeration value="check-database" /> - <xsd:enumeration value="assume-existence" /> - <xsd:enumeration value="assume-non-existence" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for querying database information.</xsd:documentation> - </xsd:annotation> - <xsd:attribute name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query-key alias name.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - </xsd:complexType> - <xsd:simpleType name="cache-sync-type"> - <xsd:annotation> - <xsd:documentation>The type of cache synchronization to use with a descriptor.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="invalidation" /> - <xsd:enumeration value="no-changes" /> - <xsd:enumeration value="change-set-with-new-objects" /> - <xsd:enumeration value="change-set" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:simpleType name="unitofwork-isolation-level"> - <xsd:annotation> - <xsd:documentation>Specify how the unit of work isolated from the session cache.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="use-session-cache-after-transaction" /> - <xsd:enumeration value="isolate-new-data-after-transaction" /> - <xsd:enumeration value="isolate-cache-after-transaction" /> - <xsd:enumeration value="isolate-cache-always" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="direct-query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for a database column.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="query-key"> - <xsd:sequence> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The field/column being aliased.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="relationship-query-key" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines an alias for a join to another class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="query-key"> - <xsd:sequence> - <xsd:element name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the target referenced class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:choice> - <xsd:element name="foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key join condition between the source and target class' tables.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="criteria" type="criteria"> - <xsd:annotation> - <xsd:documentation>The join criteria between the source and target class' tables.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:choice> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="one-to-one-query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for a 1-1 join to another class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-query-key" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="one-to-many-query-key"> - <xsd:annotation> - <xsd:documentation>Defines an alias for a 1-m join from another class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent> - <xsd:extension base="relationship-query-key" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-direct-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping from an attirbute to a simple field datatype, i.e. String, Number, Date.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The name and optionally the table of the field/column that the attribute is stored into.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="null-value" type="xsd:anySimpleType" minOccurs="0"> - <xsd:annotation> - <xsd:documentation>Optionally specify a value that null data values should be converted to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="converter" type="value-converter" minOccurs="0"> - <xsd:annotation> - <xsd:documentation>Optionally specify how the data value should be converted to the object value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="attribute-classification" type="xsd:string" minOccurs="0"/> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="attribute-mapping"> - <xsd:annotation> - <xsd:documentation>Defines how a attribute is persisted. The attribute mapping definition is extendable to allow for different types of mappings.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="attribute-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the attribute. This is the implementation class attribute name.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="read-only" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the attribute is read-only.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="get-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the get method for the attribute.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="set-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the set method for the attribute.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="properties"> - <xsd:annotation> - <xsd:documentation>Allow for user defined properties to be defined.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="property" type="property"> - <xsd:annotation> - <xsd:documentation>A user defined property.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="direct-mapping"> - <xsd:annotation> - <xsd:documentation>Defines how a simple attribute is persisted.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent> - <xsd:extension base="abstract-direct-mapping"> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-direct-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping from an attirbute to a simple field datatype, i.e. String, Number, Date.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent> - <xsd:extension base="abstract-direct-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="is-cdata" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="null-policy" type="abstract-null-policy" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-direct-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping from an attirbute to a simple field datatype, i.e. String, Number, Date.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-direct-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="field-transformation" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a field transformation for a transformation mapping</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="field" type="field" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="method-based-field-transformation"> - <xsd:complexContent mixed="false"> - <xsd:extension base="field-transformation"> - <xsd:sequence> - <xsd:element name="method" type="xsd:string" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="transformer-based-field-transformation"> - <xsd:complexContent mixed="false"> - <xsd:extension base="field-transformation"> - <xsd:sequence> - <xsd:element name="transformer-class" type="xsd:string" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-transformation-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a transformation mapping that uses Java code to transform between the data and object values.</xsd:documentation> - <xsd:documentation>This can be used if a single attribute maps to multiple fields, or field only mappings or attribute only mappings.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="attribute-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the attribute transformation defined in the domain class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="attribute-transformer" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The class name of the attribute transformer. Used in place of attribute-transformation.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="mutable" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy" /> - <xsd:element minOccurs="0" name="field-transformations"> - <xsd:annotation> - <xsd:documentation>The field transformations.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field-transformation" type="field-transformation" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="transformation-mapping"> - <xsd:annotation> - <xsd:documentation>This can be used if a single attribute maps to multiple fields, or field only mappings or attribute only mappings.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-transformation-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-transformation-mapping"> - <xsd:annotation> - <xsd:documentation>This can be used if a single attribute maps to multiple fields, or field only mappings or attribute only mappings.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-transformation-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-transformation-mapping"> - <xsd:annotation> - <xsd:documentation>This can be used if a single attribute maps to multiple fields, or field only mappings or attribute only mappings.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-transformation-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="aggregate-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a relationship where the target object is strictly privately owned by the source object and stores within the source objects row</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified class name of the target class of the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="allow-null" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if a row of all nulls should be interpreted as null.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="field-translations"> - <xsd:annotation> - <xsd:documentation>Allow for the mapping to use different field names than the descriptor.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field-translation"> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="source-field" type="field"> - <xsd:annotation> - <xsd:documentation>The field in the source descriptor's table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="target-field" type="field"> - <xsd:annotation> - <xsd:documentation>The field in the aggregate descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="relationship-mapping"> - <xsd:annotation> - <xsd:documentation>Defines how a relationship between two classes is persisted.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified class name of the target class of the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="private-owned" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the target objects are privately owned dependent objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cascade-persist" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the create operation should be cascaded to the referenced object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cascade-merge" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the create operation should be cascaded to the referenced object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cascade-refresh" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the refresh operation should be cascaded to the referenced object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="cascade-remove" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the remove operation should be cascaded to the referenced object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="one-to-one-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-1 relationship from the source instance to the target instance.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key in the source class' table that defines the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="foreign-key-fields"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-object-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-one-to-one-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-1 relationship from the source instance to the target instance.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="one-to-one-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="one-to-many-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-m relationship from the source instance to the target instances.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="target-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key in the target class' table that defines the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="delete-all-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the related objects can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-one-to-many-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-m relationship from the source instance to the target instances.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="source-foreign-key-fields"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="target-foreign-key-fields"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="foreign-key-grouping-element" type="field" /> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="delete-all-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the related objects can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a collection of simple types relationship from the source instance to a set of simple data values.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="data-read-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target data values.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="reference-table" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the reference table that stores the source primary key and the data values.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="direct-field" type="field"> - <xsd:annotation> - <xsd:documentation>The field/column in the reference table that stores the data values.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="reference-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key in the reference table that defines the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="value-converter" type="value-converter"> - <xsd:annotation> - <xsd:documentation>Optionally specify how the data value should be converted to the object value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="insert-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to insert a row into the reference table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to delete a row from the reference table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the rows from the reference table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="session-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name session that defines the reference table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="history-policy" type="history-policy"> - <xsd:annotation> - <xsd:documentation>Defines how past versions of this attribute are persisted to the data-store. By default there will be no history policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-map-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a map relationship from the source instance to a set of key values pairs of simple data values.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="direct-collection-mapping"> - <xsd:sequence> - <xsd:element name="direct-key-field" type="field"> - <xsd:annotation> - <xsd:documentation>The field/column in the reference table that sores the map key data value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="key-converter" type="value-converter"> - <xsd:annotation> - <xsd:documentation>Optionally specify how the key data value should be converted to the object value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="aggregate-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-m relationship from the source instance to the target instances where the target instances are strictly privately owned by the source object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="target-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key in the target class' table that defines the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="delete-all-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the related objects can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="many-to-many-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a m-m relationship from the source instance to the target instances.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="relation-table" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the relation table that stores the source/target primary keys.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="source-relation-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key from the relational table to the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="target-relation-foreign-key" type="foreign-key"> - <xsd:annotation> - <xsd:documentation>The foreign key from the relational table to the target class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-all-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="insert-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to insert a row into the relation table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to delete a row from the relation table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="delete-all-query" type="data-modify-query"> - <xsd:annotation> - <xsd:documentation>A query to delete all of the rows from the relation table can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="history-policy" type="history-policy"> - <xsd:annotation> - <xsd:documentation>Defines how past versions of this attribute are persisted to the data-store. By default there will be no history policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="join-fetch" type="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Specify to always join the related objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="variable-one-to-one-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-1 relationship from the source instance to the target instance that may be of several types related through an interface.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="bidirectional-target-attribute" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>For bi-directional relationships the target inverse relationship can be defined.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="batch-reading" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify to optimize reads for the class by batching the reads to this relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="indirection" type="indirection-policy"> - <xsd:annotation> - <xsd:documentation>The indirection policy to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="selection-query" type="read-object-query"> - <xsd:annotation> - <xsd:documentation>Specify the query to use to select the target objects.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="type-field" type="field"> - <xsd:annotation> - <xsd:documentation>Specify the column to store the class type of the related object into.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="foreign-key-fields"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The set of foreign key fields populated by this relationship in the source class' table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element name="foreign-key-to-query-key"> - <xsd:annotation> - <xsd:documentation>The list of source/target column/query key references relating a foreign key in one table to the query keys defining a primary or unique key value in the other interface descriptor.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="query-key-reference"> - <xsd:annotation> - <xsd:documentation>The reference of a source table foreign key and a target interface descriptor query key.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element name="source-field" type="field"> - <xsd:annotation> - <xsd:documentation>The foreign key field/column name in the source table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="target-query-key" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query key name of the target interface descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="class-indicator-mappings" type="class-indicator-mappings"> - <xsd:annotation> - <xsd:documentation>The set of class indicator values and the subclasses they map to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a container/collection type.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="collection-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the collection implementation class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="sorted-collection-container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a sorted collection type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="comparator-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the comparitor, used to compare objects in sorting the collection.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="list-container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a list collection type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="map-container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a map container type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="map-key-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the method to call on the target objects to get the key value for the map.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-map-container-policy"> - <xsd:annotation> - <xsd:documentation>Defines a direct map container type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="scrollable-cursor-policy"> - <xsd:annotation> - <xsd:documentation>Defines a scrollable cursor container type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="cursored-stream-policy"> - <xsd:annotation> - <xsd:documentation>Defines a cursored stream container type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="container-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="indirection-policy" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a deferred read indirection mechanism.</xsd:documentation> - </xsd:annotation> - </xsd:complexType> - <xsd:complexType name="value-holder-indirection-policy"> - <xsd:annotation> - <xsd:documentation>Defines usage of value holders to implement indirection.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="indirection-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="proxy-indirection-policy"> - <xsd:annotation> - <xsd:documentation>Defines usage of proxies to implement indirection.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="indirection-policy" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="transparent-collection-indirection-policy"> - <xsd:annotation> - <xsd:documentation>Defines usage of transparent collections to implement indirection.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="indirection-policy"> - <xsd:sequence> - <xsd:element minOccurs="0" name="collection-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the collection interface to use, i.e. List, Set, Map.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="map-key-method" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the method to call on the target objects to get the key value for the map.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="container-indirection-policy"> - <xsd:annotation> - <xsd:documentation>Defines usage of a user defined container to implement indirection.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="indirection-policy"> - <xsd:sequence> - <xsd:element name="container-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the container implementer to use.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-list-converter"> - <xsd:annotation> - <xsd:documentation>List converter</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="value-converter"> - <xsd:sequence> - <xsd:element minOccurs="0" name="object-class-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the list's element type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="typesafe-enumeration-converter"> - <xsd:annotation> - <xsd:documentation>Typesafe Enumeration conversion</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="value-converter" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="type-conversion-converter"> - <xsd:annotation> - <xsd:documentation>Specifies the data type and an object type of the attribute to convert between.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="value-converter"> - <xsd:sequence> - <xsd:element minOccurs="0" name="object-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the attribute type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="data-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the attributes storage data type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="serialized-object-converter"> - <xsd:annotation> - <xsd:documentation>Uses object serialization to convert between the object and data type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="value-converter"> - <xsd:sequence> - <xsd:element minOccurs="0" name="data-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specifies the fully qualified class name of the attributes storage data type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-type-converter"> - <xsd:annotation> - <xsd:documentation>Specifies a mapping of values from database values used in the field and object values used in the attribute.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="value-converter"> - <xsd:sequence> - <xsd:element minOccurs="0" name="default-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>An optional default value can be specified. This value is used if a database type is not found in the type mapping.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="type-mappings"> - <xsd:annotation> - <xsd:documentation>Specifies the mapping of values. Both the object and database values must be unique.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="type-mapping" type="type-mapping"> - <xsd:annotation> - <xsd:documentation>Defines the object and data value mapping.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="attribute-only-type-mappings"> - <xsd:annotation> - <xsd:documentation>Specifies a mapping of additional values that map non-unique data values to a unique attribute value.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="type-mapping" type="type-mapping"> - <xsd:annotation> - <xsd:documentation>Defines the object and data value mapping.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="type-mapping"> - <xsd:annotation> - <xsd:documentation>Define an object and data value mapping.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="object-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>Specifies the value to use in the object's attribute.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="data-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>Specifies the value to use in the database field.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="database-query" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query/interaction against a database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="query"> - <xsd:sequence> - <xsd:element minOccurs="0" default="true" name="maintain-cache" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the query should bypass the cache completely.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="bind-all-parameters" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the query should use paramater binding for arguments, or print the arguments in-line.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="cache-statement" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the queries statement should be cached, this must be used with parameter binding.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="timeout" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifies a timeout to cancel the query in if the request takes too long to complete.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="prepare" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the query should prepare and cache its generated SQL, or regenerate the SQL on each execution.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="call" type="criteria"> - <xsd:annotation> - <xsd:documentation>For static calls the SQL or Stored Procedure call definition can be specified.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="join-fetch-type"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid join fetch options.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="none" /> - <xsd:enumeration value="inner-join" /> - <xsd:enumeration value="outer-join" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:simpleType name="cascade-policy"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid cascade policies.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="none" /> - <xsd:enumeration value="private" /> - <xsd:enumeration value="all" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="value-read-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for reading a single value.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="direct-read-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-read-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for reading a collection of values.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="data-read-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="data-read-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for reading raw data.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="read-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="read-query" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query for reading.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query"> - <xsd:sequence> - <xsd:element minOccurs="0" default="false" name="cache-query-results" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specifies if the query should cache the query results to avoid future executions.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="max-rows" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifies the maximum number of rows to fetch, results will be trunctate on the database to this size.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="first-result" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifies where to start the cursor in a result set returned from the database. Results prior to this number will not be built into objects</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="fetch-size" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>Specifiess the number of rows to fetch from the database on each result set next operation.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="query-result-cache-policy" type="query-result-cache-policy"> - <xsd:annotation> - <xsd:documentation>Specify how the query results should be cached.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="query-result-cache-policy"> - <xsd:annotation> - <xsd:documentation>Defines how a query's results should be cached.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="invalidation-policy" type="cache-invalidation"> - <xsd:annotation> - <xsd:documentation>Defines the cache invalidation policy. By default there will be no cache invalidation policy.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="100" name="maximum-cached-results" type="xsd:integer"> - <xsd:annotation> - <xsd:documentation>This defines the number of query result sets that will be cached. The LRU query results will be discarded when the max size is reached.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="data-modify-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for manipulating data.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-modify-query" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query for modifying an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="update-object-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for updating an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-modify-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="insert-object-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for inserting an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-modify-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="delete-object-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for deleting an object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-modify-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="does-exist-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for determining if an object exists.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="existence-check" type="existence-check"> - <xsd:annotation> - <xsd:documentation>The existence check option.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="existence-check"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid existence check options.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="check-cache" /> - <xsd:enumeration value="check-database" /> - <xsd:enumeration value="assume-existence" /> - <xsd:enumeration value="assume-non-existence" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="delete-all-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for deleting a criteria of objects.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="database-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-level-read-query" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query for objects (as apposed to data).</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="read-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="reference-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The full qualified name of the class of objects being queried.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="refresh" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the query should refresh any cached objects from the database.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="remote-refresh" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the query should refresh any remotely cached objects from the server.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="cascade-policy" type="cascade-policy"> - <xsd:annotation> - <xsd:documentation>Specifies if the queries settings (such as refresh, maintain-cache) should apply to the object's relationship queries.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="primary-key" name="cache-usage" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify how the query should interact with the cache.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="lock-mode" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify if the query should lock the resulting rows on the database.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="none" name="distinct-state" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify if the query should filter distinct results.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="in-memory-querying"> - <xsd:annotation> - <xsd:documentation>The in memory querying policy.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element default="ignore-exceptions-return-conformed" name="policy" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify how indirection or unconformable expressions should be treating with in-memory querying and conforming.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" default="true" name="use-default-fetch-group" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the default fetch group should be used for the query.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="fetch-group" type="fetch-group"> - <xsd:annotation> - <xsd:documentation>Allow the query to partially fetch the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="fetch-group-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify a pre-defined named fetch group to allow the query to partially fetch the object.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="use-exclusive-connection" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if the exclusive connection (VPD) should be used for the query.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="joined-attribute-expressions"> - <xsd:annotation> - <xsd:documentation>Specifies the attributes being joined.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Represents an expression for joining</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="read-only" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Specify if objects resulting from the query are read-only, and will not be registered in the unit of work.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="outer-join-subclasses" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>For inheritance queries specify if all subclasses should be outer joined, instead of a query per subclass.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="read-all-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for a set of objects.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-level-read-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="batch-read-attribute-expressions"> - <xsd:annotation> - <xsd:documentation>Specifies all attributes for batch reading.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Represents an expression for batch reading</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="order-by-expressions"> - <xsd:annotation> - <xsd:documentation>Sets the order expressions for the query.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Represents an expression for ordering</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="read-object-query"> - <xsd:annotation> - <xsd:documentation>Defines a query for a single object.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="object-level-read-query" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="report-query"> - <xsd:annotation> - <xsd:documentation>Query for information about a set of objects instead of the objects themselves.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="read-all-query"> - <xsd:sequence> - <xsd:element minOccurs="0" name="return-choice" type="return-choice"> - <xsd:annotation> - <xsd:documentation>Simplifies the result by only returning the first result, first value, or all attribute values.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="retrieve-primary-keys" type="retrieve-primary-keys"> - <xsd:annotation> - <xsd:documentation>Indicates wether the primary key values should also be retrieved for the reference class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="report-items"> - <xsd:annotation> - <xsd:documentation>Items to be selected, these could be attributes or aggregate functions.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="item" type="report-item"> - <xsd:annotation> - <xsd:documentation>Represents an item requested</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="group-by-expressions"> - <xsd:annotation> - <xsd:documentation>Sets GROUP BY expressions for the query.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Represents an expression for grouping</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="return-choice"> - <xsd:annotation> - <xsd:documentation>Simplifies the result by only returning the first result, first value, or all attribute values.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="return-single-result" /> - <xsd:enumeration value="return-single-value" /> - <xsd:enumeration value="return-single-attribute" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:simpleType name="retrieve-primary-keys"> - <xsd:annotation> - <xsd:documentation>Indicates wether the primary key values should also be retrieved for the reference class.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string"> - <xsd:enumeration value="full-primary-key" /> - <xsd:enumeration value="first-primary-key" /> - <xsd:enumeration value="no-primary-key" /> - </xsd:restriction> - </xsd:simpleType> - <xsd:complexType name="report-item"> - <xsd:annotation> - <xsd:documentation>Represents an item requested in ReportQuery.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Name given for item, can be used to retieve value from result.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="attribute-expression" type="expression"> - <xsd:annotation> - <xsd:documentation>Expression (partial) that describes the attribute wanted.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="expression" abstract="true"> - <xsd:annotation> - <xsd:documentation>Defines a query filter expression tree.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="relation-expression"> - <xsd:annotation> - <xsd:documentation>Defines a relation expression that compares to expressions through operators such as equal, lessThan, etc..</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="left" type="expression" /> - <xsd:element name="right" type="expression" /> - </xsd:sequence> - <xsd:attribute name="operator" type="operator" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="logic-expression"> - <xsd:annotation> - <xsd:documentation>Defines a expression composed of two sub-expressions joined through an operator such as AND, OR.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="left" type="expression" /> - <xsd:element name="right" type="expression" /> - </xsd:sequence> - <xsd:attribute name="operator" type="operator" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="function-expression"> - <xsd:annotation> - <xsd:documentation>Defines a expression composed of a function applied to a list of sub-expressions.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element minOccurs="0" name="arguments"> - <xsd:annotation> - <xsd:documentation>The list of function arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="expression"> - <xsd:annotation> - <xsd:documentation>Defines an argument expression.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - <xsd:attribute name="function" type="operator" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="constant-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression value. If the value is null the value tag can is absent.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element minOccurs="0" name="value" type="xsd:anySimpleType" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="query-key-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression query-key.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="base" type="expression" /> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string" /> - <xsd:attribute name="any-of" type="xsd:boolean" /> - <xsd:attribute name="outer-join" type="xsd:boolean" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="field-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression field.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="field" type="field" /> - <xsd:element name="base" type="expression" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="parameter-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression parameter.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression"> - <xsd:sequence> - <xsd:element name="parameter" type="field" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="base-expression"> - <xsd:annotation> - <xsd:documentation>Defines an expression builder/base.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="expression" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:simpleType name="operator"> - <xsd:annotation> - <xsd:documentation>Defines the set of valid operators.</xsd:documentation> - </xsd:annotation> - <xsd:restriction base="xsd:string" /> - </xsd:simpleType> - <xsd:complexType name="sql-call"> - <xsd:annotation> - <xsd:documentation>Defines an SQL query language string.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="sql" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The full SQL query string. Arguments can be specified through #arg-name tokens in the string.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="ejbql-call"> - <xsd:annotation> - <xsd:documentation>Defines an EJB-QL query language string.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="ejbql" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The EJB-QL query string.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="stored-procedure-call"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure invocation definition.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="procedure-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the stored procedure.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="cursor-output-procedure" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Define the call to use a cursor output parameter to define the result set.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="arguments"> - <xsd:annotation> - <xsd:documentation>The list of input and output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="procedure-argument"> - <xsd:annotation> - <xsd:documentation>Defines an argument to the procedure. The order of the arguments must match the procedure arguments if not named.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="optional-arguments"> - <xsd:annotation> - <xsd:documentation>The list of optional arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="field"> - <xsd:annotation> - <xsd:documentation>Defines an optional argument.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="stored-function-call"> - <xsd:annotation> - <xsd:documentation>Defines a stored function invocation definition.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="stored-procedure-call"> - <xsd:sequence> - <xsd:element minOccurs="1" name="stored-function-result" type="procedure-output-argument"> - <xsd:annotation> - <xsd:documentation>The return value of the stored-function.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="procedure-argument"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure call argument.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="procedure-argument-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The stored procedure name of the argument. For indexed argument the name is not required.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="argument-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query name of the argument. This is the name of the argument as define in the query.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="procedure-argument-type" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The fully qualified name of the argument class type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="procedure-argument-sqltype" type="xsd:int"> - <xsd:annotation> - <xsd:documentation>The JDBC int type of the argument, as defined in java.jdbc.Types</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="procedure-argument-sqltype-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the type if procedure-argument-sqltype is STRUCT or ARRAY</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="argument-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>The procedure argument value maybe be specified if not using a query argument.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="procedure-output-argument"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure call output argument.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="procedure-argument" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="procedure-inoutput-argument"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure call output argument.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="procedure-argument"> - <xsd:sequence> - <xsd:element name="output-argument-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query name of the argument. This is the name of the argument as define in the query.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-stored-procedure-call"> - <xsd:annotation> - <xsd:documentation>Defines a stored procedure invocation definition whose arguments contain at least one Oracle PL/SQL type that has no JDBC representation (e.g. BOOLEAN, PLS_INTEGER, PL/SQL record).</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="procedure-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the stored procedure.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="cursor-output-procedure" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Define the call to use a cursor output parameter to define the result set.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="arguments"> - <xsd:annotation> - <xsd:documentation>The list of input and output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="plsql-procedure-argument-type"> - <xsd:annotation> - <xsd:documentation>Defines an argument to the procedure.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="optional-arguments"> - <xsd:annotation> - <xsd:documentation>The list of optional arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="field"> - <xsd:annotation> - <xsd:documentation>Defines an optional argument.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-stored-function-call"> - <xsd:annotation> - <xsd:documentation>Defines a stored function invocation definition.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="plsql-stored-procedure-call"> - <xsd:sequence> - <xsd:element minOccurs="1" name="stored-function-result" type="plsql-procedure-argument-type"> - <xsd:annotation> - <xsd:documentation>The return value of the stored-function.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-procedure-argument-type" abstract="true"> - <xsd:sequence> - <xsd:element name="name" type="xsd:string" /> - <xsd:element minOccurs="0" name="index" type="xsd:string" /> - <xsd:element minOccurs="0" name="direction" type="xsd:string" /> - </xsd:sequence> - </xsd:complexType> - <xsd:complexType name="jdbc-type"> - <xsd:complexContent mixed="false"> - <xsd:extension base="plsql-procedure-argument-type"> - <xsd:sequence> - <xsd:choice> - <xsd:element minOccurs="0" name="length" type="xsd:string" /> - <xsd:sequence> - <xsd:element name="precision" type="xsd:string" /> - <xsd:element name="scale" type="xsd:string" /> - </xsd:sequence> - </xsd:choice> - </xsd:sequence> - <xsd:attribute name="type-name" type="xsd:string" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-type"> - <xsd:complexContent mixed="false"> - <xsd:extension base="plsql-procedure-argument-type"> - <xsd:attribute name="type-name" type="xsd:string" /> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-record"> - <xsd:complexContent mixed="false"> - <xsd:extension base="plsql-procedure-argument-type"> - <xsd:sequence> - <xsd:element name="type-name" type="xsd:string" /> - <xsd:element minOccurs="0" name="compatible-type" type="xsd:string" /> - <xsd:element minOccurs="0" name="java-type" type="xsd:string" /> - <xsd:element minOccurs="0" name="fields"> - <xsd:annotation> - <xsd:documentation>The list of fields.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="plsql-procedure-argument-type"> - <xsd:annotation> - <xsd:documentation>Defines an argument to the procedure.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="plsql-collection"> - <xsd:complexContent mixed="false"> - <xsd:extension base="plsql-procedure-argument-type"> - <xsd:sequence> - <xsd:element name="type-name" type="xsd:string" /> - <xsd:element minOccurs="0" name="compatible-type" type="xsd:string" /> - <xsd:element minOccurs="0" name="java-type" type="xsd:string" /> - <xsd:element minOccurs="0" name="nested-type" type="plsql-procedure-argument-type" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Defines a class mapping to an EIS record data structure.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="class-mapping-descriptor"> - <xsd:sequence> - <xsd:element name="datatype" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the record structure name the descriptor maps to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="namespace-resolver" type="namespace-resolver"> - <xsd:annotation> - <xsd:documentation>The namespace resolver for the descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="mapped-interaction"> - <xsd:annotation> - <xsd:documentation>Defines an EIS interaction utilizing MappedRecord.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="function-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the function.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-result-path" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the input result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="output-result-path" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the output result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-arguments"> - <xsd:annotation> - <xsd:documentation>The list of input arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="output-arguments"> - <xsd:annotation> - <xsd:documentation>The list of output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-interaction"> - <xsd:annotation> - <xsd:documentation>Defines an EIS interaction utilizing XML records.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="function-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the function.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-record-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name to use for the input record, if required by the adapter.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-root-element-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the output result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-result-path" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the input result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="output-result-path" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optional root key if the output result is not at the record root.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-arguments"> - <xsd:annotation> - <xsd:documentation>The list of input arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="output-arguments"> - <xsd:annotation> - <xsd:documentation>The list of output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="indexed-interaction"> - <xsd:annotation> - <xsd:documentation>Defines an EIS interaction utilizing Indexed records.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="criteria"> - <xsd:sequence> - <xsd:element name="function-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the function.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="input-arguments"> - <xsd:annotation> - <xsd:documentation>The list of input arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - <xsd:element minOccurs="0" name="output-arguments"> - <xsd:annotation> - <xsd:documentation>The list of output arguments.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="argument" type="interaction-argument" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="interaction-argument"> - <xsd:annotation> - <xsd:documentation>Defines an interaction argument.</xsd:documentation> - </xsd:annotation> - <xsd:sequence> - <xsd:element minOccurs="0" name="argument-value" type="xsd:anySimpleType"> - <xsd:annotation> - <xsd:documentation>The procedure argument value maybe be specified if not using a query argument.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - <xsd:attribute name="name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The interaction name of the argument. For indexed arguments the name is not required.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - <xsd:attribute name="argument-name" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The query name of the argumen. This is the name of the argument as define in the query, or the descriptor field name.</xsd:documentation> - </xsd:annotation> - </xsd:attribute> - </xsd:complexType> - <xsd:complexType name="object-relational-class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Defines a class mapping to a Structure type in an object-relational database.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relational-class-mapping-descriptor"> - <xsd:sequence> - <xsd:element minOccurs="0" name="structure" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the object structure type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="field-order"> - <xsd:annotation> - <xsd:documentation>The ordered list of the field defined in the structure.</xsd:documentation> - </xsd:annotation> - <xsd:complexType> - <xsd:sequence> - <xsd:element maxOccurs="unbounded" name="field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="nested-table-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-m/m-m relationship that makes use of the object-relational nested-table type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The field/column in the source table that stores the nested-table.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="structure" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify the object-relational type name of the nested-table type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="array-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a collection of primitive/simple type values using the object-relational array type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-direct-collection-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="structure" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify the object-relational type name of the structure type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-array-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a collection of object-types using the object-relational array type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-collection-mapping"> - <xsd:sequence> - <xsd:element name="structure" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Specify the object-relational type name of the structure type.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="structure-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a structure of object-types using the object-relational structure type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-object-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="reference-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a reference to another object-type using the object-relational reference type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="relationship-mapping"> - <xsd:sequence> - <xsd:element name="field" type="field"> - <xsd:annotation> - <xsd:documentation>The field in the source type that stores the reference.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="object-relational-field"> - <xsd:annotation> - <xsd:documentation>Defines an ObjectRelationalDatabaseField</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="field"> - <xsd:sequence> - <xsd:element minOccurs="0" name="nested-type-field" type="field" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="direct-xml-type-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a direct mapping to an Oracle XDB XML Type.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="direct-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="read-whole-document" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-composite-direct-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a direct collection mapping for an XML list of elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element name="field" type="field" /> - <xsd:element minOccurs="0" name="value-converter" type="value-converter"> - <xsd:annotation> - <xsd:documentation>Optionally specify how the data value should be converted to the object value.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="value-converter-class" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>Optionally specify a user defined converter class.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-collection-reference-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-M relationship from the source XML element to the target XML element based on a key.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="xml-object-reference-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="containerpolicy" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element name="uses-single-node" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="reuse-container" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-object-reference-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a 1-1 relationship from the source XML element to the target XML element based on one or more keys.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="aggregate-object-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="source-to-target-key-field-association" type="foreign-key" /> - <xsd:element minOccurs="0" name="source-to-target-key-fields"> - <xsd:complexType> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="field" type="field" /> - </xsd:sequence> - </xsd:complexType> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-composite-direct-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a direct collection mapping for an XML list of elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-direct-collection-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="is-cdata" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="null-policy" type="abstract-null-policy" /> - <xsd:element minOccurs="0" name="reuse-container" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-composite-direct-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a direct collection mapping for an XML list of elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-direct-collection-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-composite-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite collection mapping for an XML list of nested elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="reference-class" type="xsd:string" /> - <xsd:element name="field" type="field" /> - <xsd:element minOccurs="0" name="container" type="container-policy"> - <xsd:annotation> - <xsd:documentation>Defines the collection type to use for the relationship.</xsd:documentation> - </xsd:annotation> - </xsd:element> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-composite-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite collection mapping for an XML list of nested elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-collection-mapping"> - <xsd:sequence> - <xsd:element name="container-attribute" minOccurs="0"/> - <xsd:element name="container-get-method" minOccurs="0"/> - <xsd:element name="container-set-method" minOccurs="0"/> - <xsd:element name="keep-as-element-policy" type="xsd:string" minOccurs="0"/> - <xsd:element minOccurs="0" name="reuse-container" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-composite-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite collection mapping for an XML list of nested elements.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-collection-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="abstract-composite-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite object mapping for an XML nested element.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="reference-class" type="xsd:string" /> - <xsd:element name="field" type="field" /> - <xsd:element name="container-attribute" minOccurs="0"/> - <xsd:element name="container-get-method" minOccurs="0"/> - <xsd:element name="container-set-method" minOccurs="0"/> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-composite-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite object mapping for an XML nested element.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-object-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="null-policy" type="abstract-null-policy" /> - <xsd:element minOccurs="0" name="keep-as-element-policy" type="xsd:string" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="eis-composite-object-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a composite object mapping for an XML nested element.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="abstract-composite-object-mapping" /> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-class-mapping-descriptor"> - <xsd:annotation> - <xsd:documentation>Defines a class mapping to an XML element.</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="class-mapping-descriptor"> - <xsd:sequence> - <xsd:element minOccurs="0" maxOccurs="unbounded" name="default-root-element" type="xsd:string"> - <xsd:annotation> - <xsd:documentation>The name of the element the descriptor maps to.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="default-root-element-field" type="node"> - <xsd:annotation> - <xsd:documentation>The XMLField representing the default root element of the descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="should-preserve-document" type="xsd:boolean"> - <xsd:annotation> - <xsd:documentation>Indicates if nodes should be cached to preserve unmapped data</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="namespace-resolver" type="namespace-resolver"> - <xsd:annotation> - <xsd:documentation>The namespace resolver for the descriptor.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" name="schema" type="schema-reference"> - <xsd:annotation> - <xsd:documentation>The location of the XML Schema.</xsd:documentation> - </xsd:annotation> - </xsd:element> - <xsd:element minOccurs="0" default="false" name="result-always-xml-root" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-any-collection-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a collection to an xs:any declaration or xs:anyType element</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" name="field" type="field" /> - <xsd:element minOccurs="0" name="container" type="container-policy" /> - <xsd:element minOccurs="0" default="false" name="use-xml-root" type="xsd:boolean" /> - <xsd:element minOccurs="0" name="keep-as-element-policy" type="xsd:string" /> - <xsd:element minOccurs="0" name="reuse-container" type="xsd:boolean" /> - </xsd:sequence> - </xsd:extension> - </xsd:complexContent> - </xsd:complexType> - <xsd:complexType name="xml-any-attribute-mapping"> - <xsd:annotation> - <xsd:documentation>Defines a mapping of a collection to an xs:any declaration or xs:anyType element</xsd:documentation> - </xsd:annotation> - <xsd:complexContent mixed="false"> - <xsd:extension base="attribute-mapping"> - <xsd:sequence> - <xsd:element minOccurs="0" nam |