diff --git a/openjpa-project/src/doc/manual/jpa_overview_em.xml b/openjpa-project/src/doc/manual/jpa_overview_em.xml index 7e3c18314..564761246 100644 --- a/openjpa-project/src/doc/manual/jpa_overview_em.xml +++ b/openjpa-project/src/doc/manual/jpa_overview_em.xml @@ -1025,6 +1025,20 @@ language. For relational databases, this the Structured Query Language (SQL). native query support. +
+ + Retrieving Properties Information + + + + EntityManager + + + properties information + + + &properties_info.xml; +
Closing diff --git a/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml b/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml index 61825682c..33e40a819 100644 --- a/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml +++ b/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml @@ -372,6 +372,20 @@ em.close(); </example> </section> </section> + <section id="jpa_overview_emf_properties"> + <title> + Retrieving Properties Information + + + + EntityManagerFactory + + + properties information + + + &properties_info.xml; +
Closing the EntityManagerFactory diff --git a/openjpa-project/src/doc/manual/manual.xml b/openjpa-project/src/doc/manual/manual.xml index e53e59548..fe2f1e45a 100644 --- a/openjpa-project/src/doc/manual/manual.xml +++ b/openjpa-project/src/doc/manual/manual.xml @@ -31,8 +31,8 @@ <!ENTITY jpa_overview_emfactory.xml SYSTEM "jpa_overview_emfactory.xml"> <!ENTITY jpa_overview_em.xml SYSTEM "jpa_overview_em.xml"> <!ENTITY jpa_overview_trans.xml SYSTEM "jpa_overview_trans.xml"> - <!ENTITY jpa_overview_query.xml SYSTEM "jpa_overview_query.xml"> - <!ENTITY jpa_overview_criteria.xml SYSTEM "jpa_overview_criteria.xml"> + <!ENTITY jpa_overview_query.xml SYSTEM "jpa_overview_query.xml"> + <!ENTITY jpa_overview_criteria.xml SYSTEM "jpa_overview_criteria.xml"> <!ENTITY jpa_overview_sqlquery.xml SYSTEM "jpa_overview_sqlquery.xml"> <!ENTITY jpa_overview_mapping.xml SYSTEM "jpa_overview_mapping.xml"> <!ENTITY jpa_overview_conclusion.xml SYSTEM "jpa_overview_conclusion.xml"> @@ -47,13 +47,15 @@ <!ENTITY ref_guide_deploy.xml SYSTEM "ref_guide_deploy.xml"> <!ENTITY ref_guide_runtime.xml SYSTEM "ref_guide_runtime.xml"> <!ENTITY ref_guide_caching.xml SYSTEM "ref_guide_caching.xml"> - <!ENTITY ref_guide_remote.xml SYSTEM "ref_guide_remote.xml"> + <!ENTITY ref_guide_remote.xml SYSTEM "ref_guide_remote.xml"> <!ENTITY ref_guide_slice.xml SYSTEM "ref_guide_slice.xml"> <!ENTITY ref_guide_integration.xml SYSTEM "ref_guide_integration.xml"> <!ENTITY ref_guide_optimization.xml SYSTEM "ref_guide_optimization.xml"> <!ENTITY samples_guide.xml SYSTEM "samples_guide.xml"> <!ENTITY jpa_resources.xml SYSTEM "jpa_resources.xml"> <!ENTITY supported_databases.xml SYSTEM "supported_databases.xml"> + <!ENTITY migration_considerations.xml SYSTEM "migration_considerations.xml"> + <!ENTITY properties_info.xml SYSTEM "properties_info.xml"> ]> <book id="manual"> <bookinfo> @@ -76,8 +78,8 @@ &jpa_overview_emfactory.xml; &jpa_overview_em.xml; &jpa_overview_trans.xml; - &jpa_overview_query.xml; - &jpa_overview_criteria.xml; + &jpa_overview_query.xml; + &jpa_overview_criteria.xml; &jpa_overview_sqlquery.xml; &jpa_overview_mapping.xml; &jpa_overview_conclusion.xml; @@ -103,7 +105,7 @@ &ref_guide_deploy.xml; &ref_guide_runtime.xml; &ref_guide_caching.xml; - &ref_guide_remote.xml; + &ref_guide_remote.xml; &ref_guide_slice.xml; &ref_guide_integration.xml; &ref_guide_optimization.xml; @@ -118,4 +120,5 @@ &jpa_resources.xml; &supported_databases.xml; + &migration_considerations.xml; </book> diff --git a/openjpa-project/src/doc/manual/migration_considerations.xml b/openjpa-project/src/doc/manual/migration_considerations.xml new file mode 100644 index 000000000..2b2912a44 --- /dev/null +++ b/openjpa-project/src/doc/manual/migration_considerations.xml @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<appendix id="migration_considerations"> + <title> + Migration Considerations + +
+ + JPA 2.0 + +
+ + Incompatibilities + + + The following list indicates changes that are incompatible between + OpenJPA 1.x.x releases and the 2.0 release. Some of these may + require application changes. + + + + The OpenJPAEntityManagerFactory interface getProperties() + method was changed to return a Map instead of a + Properties object. This change was made in order to + support the getProperties() method defined in the 2.0 + JPA specification. + + + + +
+
+ diff --git a/openjpa-project/src/doc/manual/openjpa_intro.xml b/openjpa-project/src/doc/manual/openjpa_intro.xml index bab425e1d..7df6879e5 100644 --- a/openjpa-project/src/doc/manual/openjpa_intro.xml +++ b/openjpa-project/src/doc/manual/openjpa_intro.xml @@ -75,6 +75,33 @@ opportunities OpenJPA provides. Later, you can use the guide when you need details on a specific aspect of OpenJPA. + + + Appendices + + + + The appendix JPA Resources + provides links to other resources. + + + + + The appendix + Supported Databases provides information on + databases supported by OpenJPA. + + + + + The appendix + Migration Considerations provides information + related to migration to a different release. + + + + +
diff --git a/openjpa-project/src/doc/manual/properties_info.xml b/openjpa-project/src/doc/manual/properties_info.xml new file mode 100644 index 000000000..1e0b5d8e7 --- /dev/null +++ b/openjpa-project/src/doc/manual/properties_info.xml @@ -0,0 +1,51 @@ + + + +There are two sets of properties that may be specified: those that +are specific to openjpa and those that have been defined by the JPA +specification. In some cases, two properties may be equivalent, but +have different keys. For example, openjpa.LockTimeout + and javax.persistence.lock.timeout +are two different keys for the same property. + + +There are two methods that can be used to retrieve information related to +properties: + + + + getProperties() - This method provides a list of current + properties. If a property has more than one key, the key + that will be returned is the one that was used when the + property was set. If the property was not explicitly + set, the key defined by JPA specification will be returned + with the default value. + + + + + getSupportedProperties() - This method returns a set of + property keys. See the javadoc in the latest JPA + specification for the definition of the set. If a property + has more than one key, all possible keys will be returned. + + + +