From commits-return-8690-apmail-openjpa-commits-archive=openjpa.apache.org@openjpa.apache.org Sat Apr 09 19:03:00 2011 Return-Path: Delivered-To: apmail-openjpa-commits-archive@www.apache.org Received: (qmail 90094 invoked from network); 9 Apr 2011 19:03:00 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 9 Apr 2011 19:03:00 -0000 Received: (qmail 55360 invoked by uid 500); 9 Apr 2011 19:03:00 -0000 Delivered-To: apmail-openjpa-commits-archive@openjpa.apache.org Received: (qmail 55317 invoked by uid 500); 9 Apr 2011 19:03:00 -0000 Mailing-List: contact commits-help@openjpa.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@openjpa.apache.org Delivered-To: mailing list commits@openjpa.apache.org Received: (qmail 55310 invoked by uid 99); 9 Apr 2011 19:03:00 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 09 Apr 2011 19:03:00 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 09 Apr 2011 19:02:55 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 188952388A39; Sat, 9 Apr 2011 19:02:34 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1090649 - /openjpa/trunk/openjpa-project/src/doc/manual/ Date: Sat, 09 Apr 2011 19:02:33 -0000 To: commits@openjpa.apache.org From: mtylenda@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110409190234.188952388A39@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: mtylenda Date: Sat Apr 9 19:02:33 2011 New Revision: 1090649 URL: http://svn.apache.org/viewvc?rev=1090649&view=rev Log: OPENJPA-1932: Documentation update: remove Java 5 references, improve formatting and wording, point out that getSupportedProperties is an OpenJPA extension (no longer in the JPA 2.0 spec), remove link to criteria API draft (criteria API is in the final 2.0 spec). Modified: openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_criteria.xml openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_meta.xml openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_query.xml openjpa/trunk/openjpa-project/src/doc/manual/migration_considerations.xml openjpa/trunk/openjpa-project/src/doc/manual/openjpa_legal.xml openjpa/trunk/openjpa-project/src/doc/manual/properties_info.xml openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_logging.xml openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml Modified: openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_criteria.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_criteria.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_criteria.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_criteria.xml Sat Apr 9 19:02:33 2011 @@ -38,7 +38,7 @@ - JPA 2.0 Specification introduces a new API to define queries dynamically + JPA 2.0 specification introduces a new API to define queries dynamically via construction of an object-based javax.persistence.CriteriaQuery instance, rather than string-based approach used in JPQL (Java Persistence Query Language). @@ -116,7 +116,7 @@ Root<Order> order = customer.join(
Executing a CriteriaQuery - A CriteriaQuery is executed in a similar fashion of a string-based JPQL + A CriteriaQuery is executed in a similar fashion to a string-based JPQL query via the EntityManager and Query interfaces. EntityManager em = ... @@ -130,12 +130,6 @@ List result = query.getResultList(); - The JPA 2.0 Specification on Criteria API can be found at - - public draft. - - - A developerworks article explains details and further usage of Criteria API and its OpenJPA extensions. @@ -145,18 +139,18 @@ List result = query.getResultList(); Extension to Criteria API Criteria API has provided an alternative means to string-based JPQL to - execute a query. However, JPA 2.0 Specification has not explicitly specified + execute a query. However, JPA 2.0 specification has not explicitly specified any equivalence between a dynamically constructed CriteriaQuery and a JPQL string. OpenJPA provides a mechanism to convert a CriteriaQuery to an equivalent JPQL query string via the extended OpenJPACriteriaQuery API. - public interface OpenJPACriteriaQuery extends CriteriaQuery { - /** - * Gets equivalent JPQL String for the given CriteriaQuery. - */ - public String toCQL(); - } - +public interface OpenJPACriteriaQuery extends CriteriaQuery { + /** + * Gets equivalent JPQL String for the given CriteriaQuery. + */ + public String toCQL(); +} +
@@ -197,7 +191,7 @@ The Annotation Processor recognizes the -Aopenjpa.naming=class name : fully-qualified name of a class implementing org.apache.openjpa.meta.MetaDataFactory that determines the name of a meta-class given the name of the original persistent Java entity class. Defaults to -org.apache.openjpa.persistence.PersistenceMetaDataFactory which appends a underscore character +org.apache.openjpa.persistence.PersistenceMetaDataFactory which appends an underscore character (_) to the original Java class name. @@ -205,7 +199,7 @@ the name of a meta-class given the name -Aopenjpa.header=<url> : A url whose content will appear as comment header to the generated file(s). Recognizes special value ASL for Apache Source License header as comment. - By default, adds a OpenJPA proprietary text as comment block. + By default, adds an OpenJPA proprietary text as comment block. Modified: openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml Sat Apr 9 19:02:33 2011 @@ -446,7 +446,7 @@ public PersistenceUnitUtil getPersistenc The EntityManagerFactory method -getPersistenceUnitUtil to provide access to a +getPersistenceUnitUtil provides access to a PersistenceUnitUtil utility. PersistenceUnitUtil can be used to obtain the identity of a managed object and determine the load state of the entity or one of its attributes. If the object is not @@ -461,7 +461,7 @@ if (puUtil.getIdentifier(deptEntity) == throw new Exception("Identity is not valid."); } if (!puUtil.isLoaded(deptEntity, "employees")) { - throw new Exception("Employees not loaded.") + throw new Exception("Employees not loaded."); } Modified: openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_meta.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_meta.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_meta.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_meta.xml Sat Apr 9 19:02:33 2011 @@ -65,7 +65,7 @@ simply reflecting on the persistent clas annotations -Persistence metadata is specified using either the Java 5 annotations defined in +Persistence metadata is specified using either the Java annotations defined in the javax.persistence package, XML mapping files, or a mixture of both. In the latter case, XML declarations override conflicting annotations. If you choose to use XML metadata, the XML files must be available Modified: openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_query.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_query.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_query.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_query.xml Sat Apr 9 19:02:33 2011 @@ -882,7 +882,7 @@ To specify an isolation level, specify a Other Fetchplan Hints -Any property of an OpenJPA FetchPlan can be changed using a hint by using a name of the form "openjpa.FetchPlan."<property name>.Valid property names include : +Any property of an OpenJPA FetchPlan can be changed using a hint by using a name of the form "openjpa.FetchPlan."<property name>. Valid property names include: MaxFetchDepth, FetchBatchSize, LockTimeOut, EagerFetchMode, SubclassFetchMode and Isolation. Modified: openjpa/trunk/openjpa-project/src/doc/manual/migration_considerations.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/migration_considerations.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/migration_considerations.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/migration_considerations.xml Sat Apr 9 19:02:33 2011 @@ -50,8 +50,8 @@ 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. + support the getProperties() method defined in the + JPA 2.0 specification.
Modified: openjpa/trunk/openjpa-project/src/doc/manual/openjpa_legal.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/openjpa_legal.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/openjpa_legal.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/openjpa_legal.xml Sat Apr 9 19:02:33 2011 @@ -77,7 +77,7 @@ The openjpa-all aggregate JAR includes s Apache Geronimo project (JMS 1.1, JTA 1.1 and JPA 2.0 spec APIs) - JCP JSR-317 JPA 2.0 Schemas + JCP JSR-317 JPA 2.0 schemas SERP project Modified: openjpa/trunk/openjpa-project/src/doc/manual/properties_info.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/properties_info.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/properties_info.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/properties_info.xml Sat Apr 9 19:02:33 2011 @@ -19,7 +19,7 @@ --> 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 +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 @@ -28,24 +28,35 @@ are two different keys for the same prop There are two methods that can be used to retrieve information related to properties: + +public Map<String,Object> getProperties(); +public Set<String> getSupportedProperties(); + - getProperties() - This method provides a list of current + getProperties - 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 + set, the key defined by the 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 + getSupportedProperties - Returns a set of + supported property keys. This includes keys defined by the JPA + specification as well as keys specific to OpenJPA. + If a property has more than one key, all possible keys will be returned. + + + The getSupportedProperties method is an OpenJPA + extension to the JPA specification. + + Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml Sat Apr 9 19:02:33 2011 @@ -303,7 +303,7 @@ java org.apache.openjpa.enhance.Applicat Because OpenJPA is a highly customizable environment, many configuration properties relate to the creation and configuration of system plugins. Plugin -properties have a syntax very similar to that of Java 5 annotations. They allow +properties have a syntax very similar to that of Java annotations. They allow you to specify both what class to use for the plugin and how to configure the public fields or bean properties of the instantiated plugin instance. The easiest way to describe the plugin syntax is by example: @@ -396,8 +396,8 @@ default JDBC store. -Few of the properties recognized by OpenJPA have been standardized in JPA 2.0 -Specification using equivalent names. These properties can be specified either +A few of the properties recognized by OpenJPA have been standardized in JPA 2.0 +specification using equivalent names. These properties can be specified either by the JPA standard key or equivalent OpenJPA key. Specifying the same key once as JPA standard key and again as equivalent OpenJPA key in the same configuration, however, is not allowed. The following table lists these standard JPA properties @@ -4234,7 +4234,7 @@ implementation is The default behavior of certain OpenJPA API methods can evolve to align with the behaviors defined in JPA specification. To maintain backward compatibility, OpenJPA allows configuration -options such that while the default behavior changes to align with current JPA Specification, the +options such that while the default behavior changes to align with current JPA specification, the previous behaviors can always be emulated. @@ -4253,13 +4253,13 @@ JPA 2.0 detach() sema before detach. -A user application running with OpenJPA that is compliant to a specific version of JPA of specification, -the older behavior can be emulated by configuring OpenJPA Compatibility options. +A user application running with OpenJPA that is compliant to a specific version of JPA specification +can emulate the older behavior by configuring OpenJPA compatibility options. For example, openjpa.Compatibility=FlushBeforeDetach=false,CopyOnDetach=true -will emulate the older behavior of detach even when running with OpenJPA that are -compliant to JPA 2.0 Specification. The configuration can also be set to a different version of the specification. +will emulate the older behavior of detach even when running with OpenJPA that is +compliant to JPA 2.0 specification. The configuration can also be set to a different version of the specification. For example, openjpa.Specification="JPA 1.0" configuration setting will emulate -default OpenJPA behavior as it were for JPA Specification version 1.0. Setting via +default OpenJPA behavior as it were for JPA specification version 1.0. Setting openjpa.Specification is a shorthand for more fine-grained control available via openjpa.Compatibility. Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_dbsetup.xml Sat Apr 9 19:02:33 2011 @@ -3909,7 +3909,7 @@ the operation will fail. Delimited Identifiers Support -OpenJPA provides support for delimited identifiers as defined in the 2.0 JPA specification. +OpenJPA provides support for delimited identifiers as defined in the JPA 2.0 specification. Identifiers can either be automatically delimited or individually manually delimited. To have OpenJPA automatically delimit identifiers, add the <delimited-identifiers/> tag Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_logging.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_logging.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_logging.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_logging.xml Sat Apr 9 19:02:33 2011 @@ -278,7 +278,7 @@ For example, when loading an application following will be sent to the openjpa.Runtime channel: -2107 INFO [main] openjpa.Runtime - Starting OpenJPA 0.9.7 +2107 INFO [main] openjpa.Runtime - Starting OpenJPA 2.2.0 The default logging system accepts the following parameters: Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml?rev=1090649&r1=1090648&r2=1090649&view=diff ============================================================================== --- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml (original) +++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml Sat Apr 9 19:02:33 2011 @@ -2286,7 +2286,7 @@ default fetch group or in any other acti fields that will be eagerly loaded from the database. -JPA FetchPlan methods: +OpenJPA FetchPlan methods: public FetchPlan addField(String field); @@ -2318,7 +2318,6 @@ publisher. - Extended Path Lookup To include the fields defined in a super class by the subclass or to distinguish between fields that are defined in both super- and subclass, set setExtendedPathLookup(boolean) on FetchPlan