Apache Geronimo >  Index >  Development >  XML Schemas >  Apache Geronimo v2.1 XML Schemas User List | Dev List | Wiki | Issue Tracker  
  Overview
Home
License
ASF
Project Policies
Downloads
Documentation
News Archive
  Search
Powered by Google Search
  Community
Events
Get Involved
Committers
Mailing Lists
Discussion Forums
IRC
FAQ
Wiki
Found a Bug?
Service and Support
ASF Sponsorship
ASF Thanks!
  Development
Javadoc
XML Schemas
Source Code
Coding Standards
Issue Tracker
Related Projects
Sample Applications
  Subprojects
Development Tools
GBuild
GShell
XBean

Documentation for persistence 1.0

Table of Contents

top

Schema Document Properties

Target Namespace http://java.sun.com/xml/ns/persistence
Version 1.0
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Documentation @(#)persistence_1_0.xsd 1.0 Feb 9 2006

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. Copyright 2005-2007 Sun Microsystems, Inc. All rights reserved. The contents of this file are subject to the terms of either the GNU General Public License Version 2 only ("GPL") or the Common Development and Distribution License("CDDL") (collectively, the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific language governing permissions and limitations under the License. When distributing the software, include this License Header Notice in each file and include the License file at glassfish/bootstrap/legal/LICENSE.txt. Sun designates this particular file as subject to the "Classpath" exception as provided by Sun in the GPL Version 2 section of the License file that accompanied this code. If applicable, add the following below the License Header, with the fields enclosed by brackets [] replaced by your own identifying information: "Portions Copyrighted [year] [name of copyright owner]" Contributor(s): If you wish your version of this file to be governed by only the CDDL or only the GPL Version 2, indicate your decision by adding "[Contributor] elects to include this software in this distribution under the [CDDL or GPL Version 2] license." If you don't indicate a single choice of license, a recipient has the option to distribute your version of this file under either the CDDL, the GPL Version 2 or to extend the choice of license to its licensees as provided above. However, if you add GPL Version 2 code and therefore, elected the GPL Version 2 license, then the option applies only if the new code is made subject to such option by the copyright holder.

This is the XML Schema for the persistence configuration file. The file must be named "META-INF/persistence.xml" in the persistence archive. Persistence configuration files must indicate the persistence schema by using the persistence namespace: http://java.sun.com/xml/ns/persistence and indicate the version of the schema by using the version element as shown below: <persistence xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd" version="1.0"> ... </persistence>

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
persistence http://java.sun.com/xml/ns/persistence
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema targetNamespace="http://java.sun.com/xml/ns/persistence" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0">
...
</xsd:schema>
top

Global Declarations

Element: persistence

Name persistence
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<persistence:persistence
version="1.0 [1]">
<persistence:persistence-unit
name=" xsd:string [1]

'Name used in code to reference this persistence unit.'

"
transaction-type=" persistence:persistence-unit-transaction-type [0..1]

'Type of transactions used by EntityManagers from this persistence unit.'

"> [0..*]
<persistence:description> xsd:string </persistence:description> [0..1]

'Textual description of this persistence unit.'

<persistence:provider> xsd:string </persistence:provider> [0..1]

'Provider class that supplies EntityManagers for this persistence unit.'

<persistence:jta-data-source> xsd:string </persistence:jta-data-source> [0..1]

'The container-specific name of the JTA datasource to use.'

<persistence:non-jta-data-source> xsd:string </persistence:non-jta-data-source> [0..1]

'The container-specific name of a non-JTA datasource to use.'

<persistence:mapping-file> xsd:string </persistence:mapping-file> [0..*]

'File containing mapping information. Loaded as a resource by the persistence provider.'

<persistence:jar-file> xsd:string </persistence:jar-file> [0..*]

'Jar file that should be scanned for entities. Not applicable to Java SE persistence units.'

<persistence:class> xsd:string </persistence:class> [0..*]

'Class to scan for annotations. It should be annotated with either @Entity, @Embeddable or @MappedSuperclass.'

<persistence:exclude-unlisted-classes> xsd:boolean </persistence:exclude-unlisted-classes> [0..1]

'When set to true then only listed classes and jars will be scanned for persistent classes, otherwise the enclosing jar or directory will also be scanned. Not applicable to Java SE persistence units.'

<persistence:properties> [0..1]

'A list of vendor-specific properties.'


<persistence:property
name=" xsd:string [1]"
value=" xsd:string [1]"/> [0..*]

'A name-value pair.'

</persistence:properties>
</persistence:persistence-unit>
</persistence:persistence>
Diagram
h-405625473 h-1652106579
Schema Component Representation
<xsd:element name="persistence">
<xsd:complexType>
<xsd:sequence>
<-- **************************************************** -->
<xsd:element name="persistence-unit" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<-- **************************************************** -->
<xsd:element name="description" type=" xsd:string " minOccurs="0"/>
<-- **************************************************** -->
<xsd:element name="provider" type=" xsd:string " minOccurs="0"/>
<-- **************************************************** -->
<xsd:element name="jta-data-source" type=" xsd:string " minOccurs="0"/>
<-- **************************************************** -->
<xsd:element name="non-jta-data-source" type=" xsd:string " minOccurs="0"/>
<-- **************************************************** -->
<xsd:element name="mapping-file" type=" xsd:string " minOccurs="0" maxOccurs="unbounded"/>
<-- **************************************************** -->
<xsd:element name="jar-file" type=" xsd:string " minOccurs="0" maxOccurs="unbounded"/>
<-- **************************************************** -->
<xsd:element name="class" type=" xsd:string " minOccurs="0" maxOccurs="unbounded"/>
<-- **************************************************** -->
<xsd:element name="exclude-unlisted-classes" type=" xsd:boolean " default="false" minOccurs="0"/>
<-- **************************************************** -->
<xsd:element name="properties" minOccurs="0">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="property" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:attribute name="name" type=" xsd:string " use="required"/>
<xsd:attribute name="value" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<-- **************************************************** -->
<xsd:attribute name="name" type=" xsd:string " use="required"/>
<-- **************************************************** -->
<xsd:attribute name="transaction-type" type=" persistence:persistence-unit-transaction-type "/>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="version" type=" persistence:versionType " fixed="1.0" use="required"/>
</xsd:complexType>
</xsd:element>
top

Global Definitions

Simple Type: persistence-unit-transaction-type

Super-types: xsd:token < persistence-unit-transaction-type (by restriction)
Sub-types: None
Name persistence-unit-transaction-type
Used by (from the same schema document) Element persistence
Content
  • Base XSD Type: token
  • value comes from list: {'JTA'|'RESOURCE_LOCAL'}
Documentation public enum TransactionType { JTA, RESOURCE_LOCAL };
Diagram
Schema Component Representation
<xsd:simpleType name="persistence-unit-transaction-type">
<xsd:restriction base=" xsd:token ">
<xsd:enumeration value="JTA"/>
<xsd:enumeration value="RESOURCE_LOCAL"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: versionType

Super-types: xsd:token < versionType (by restriction)
Sub-types: None
Name versionType
Used by (from the same schema document) Element persistence
Content
  • Base XSD Type: token
  • pattern = [0-9]+(\.[0-9]+)*
Diagram
Schema Component Representation
<xsd:simpleType name="versionType">
<xsd:restriction base=" xsd:token ">
<xsd:pattern value="[0-9]+(\.[0-9]+)*"/>
</xsd:restriction>
</xsd:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

  • The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
  • Model group information are shown in gray, e.g. Start Choice ... End Choice.
  • For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
  • If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
  • Otherwise, the type of the element/attribute is displayed.
    • If the element/attribute's type is in the schema, a link is provided to it.
    • For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
  • If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.
Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top

Generated by <oXygen/> XML Editor using a modified version of xs3p that adds schema diagrams and chunking support. Last modified:

Copyright © 2003-2008, The Apache Software Foundation