You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by mt...@apache.org on 2011/04/03 21:58:03 UTC
svn commit: r1088391 - in /openjpa/trunk/openjpa-project/src/doc/manual:
jpa_overview_query.xml migration_considerations.xml ref_guide_dbsetup.xml
ref_guide_meta.xml
Author: mtylenda
Date: Sun Apr 3 19:58:03 2011
New Revision: 1088391
URL: http://svn.apache.org/viewvc?rev=1088391&view=rev
Log:
OPENJPA-1932: Documentation update: Add missing example titles, fix typos.
Modified:
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/ref_guide_dbsetup.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml
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=1088391&r1=1088390&r2=1088391&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 Sun Apr 3 19:58:03 2011
@@ -359,7 +359,7 @@ SELECT x FROM Magazine x inner join x.ar
</title>
<para>
Similar to relation traversal, nested embeddable objects can be traversed using Java-like syntax.
-For example, if the <classname>Compony</classname> class has a field named "address" of
+For example, if the <classname>Company</classname> class has a field named "address" of
an embeddable type <classname>Address</classname>,
and the <classname>Address</classname> has a field named "geocode" of
an embeddable type <classname>Geocode</classname>,
@@ -375,7 +375,7 @@ entity. Modifications to these embeddabl
</para>
</note>
<para>
-Traverse into embeddable's state field is also allowed as shown in the following query:
+Traversal into embeddable's state field is also allowed as shown in the following query:
</para>
<programlisting>
SELECT c.address.geocode.latitude FROM Company c WHERE c.name = 'Random House'
@@ -944,6 +944,9 @@ openjpa.*
</listitem>
</itemizedlist>
<example id="multi-hints-example">
+ <title>
+ Setting Multiple Similar Query Hints
+ </title>
<programlisting>
...
Query q = em.createQuery(.....);
@@ -1897,7 +1900,7 @@ used as identification variables or resu
<note>
<para>
It is recommended that other SQL reserved
-words also not be as identification variables in queries because they may be
+words also not be used as identification variables in queries because they may be
used as reserved identifiers in future releases of the specification.
</para>
</note>
@@ -2238,7 +2241,7 @@ the <literal>FROM</literal> clause and a
</para>
<para>
The main use case for this generalized style of join is when a join condition does not involve
-a foreign key relationship that is mapped to an entity relationship. For Example,
+a foreign key relationship that is mapped to an entity relationship, for example:
</para>
<programlisting>SELECT c FROM Customer c, Employee e WHERE c.hatsize = e.shoesize</programlisting>
<para>
@@ -2579,7 +2582,7 @@ WHERE c.name = 'Smith'
AND o.submissionDate < {d '2008-12-31'}
</programlisting>
<para>
-Date, time, and timestamp literals are passed as it to the JDBC driver
+Date, time, and timestamp literals are passed as is to the JDBC driver
in use.
</para>
<para>
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=1088391&r1=1088390&r2=1088391&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/migration_considerations.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/migration_considerations.xml Sun Apr 3 19:58:03 2011
@@ -37,7 +37,7 @@
use of compatibility options. If your application uses a
version 1.0 persistence.xml, compatibility options will be set
appropriately to maintain backward compatibility. OpenJPA 2.0
- applications using a version 2.0 persistence.xml and require
+ applications using a version 2.0 persistence.xml and requiring
OpenJPA 1.x.x compatibility may need to configure the
appropriate compatibility options to get the desired behavior.
</para>
@@ -90,7 +90,7 @@
In the 1.x.x release, the detach operation
is recursively cascaded to all referenced
entities. In 2.0, the detach operation is
- only cascade to those entities for which
+ only cascaded to those entities for which
Cascade=detach has been specified.
</para>
</listitem>
@@ -98,7 +98,7 @@
</para>
<para>
Applications that use a 1.0 persistence.xml will
- automatically maintain OpenJPA 1.0 behavior. It is
+ automatically maintain OpenJPA 1.x.x behavior. It is
possible for a version 2.0 application to revert back to
the 1.x.x behavior for some of these items by setting the
openjpa.Compatibility property as follows:
@@ -179,7 +179,7 @@
on the classpath (both client and server containers);
when entities are deserialized the OpenJPA runtime must
be the exact same revision as used to serialize the
- entities due to the $proxy classes using dynamically
+ entities due to the proxy classes using dynamically
generated serialVersionUID values.
</para>
<para>
@@ -227,10 +227,10 @@
</title>
<!-- See OPENJPA-1223 and OPENJPA-1163 for details. -->
<para>
- The default behavior of openJPA in tracking collections is that
+ The default behavior of OpenJPA in tracking collections is that
if the number of modifications to the collection exceeds the
- current number of elements in collection then openJPA will
- disable tracking the collections. Added a Compatibility
+ current number of elements in collection then OpenJPA will
+ disable tracking the collections. OpenJPA 2.0 added a compatibility
property to disable turning off the collection tracking.
</para>
<para>
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=1088391&r1=1088390&r2=1088391&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 Sun Apr 3 19:58:03 2011
@@ -479,11 +479,14 @@ As mentioned above, the JTA and Non-JTA
at EntityManagerFactory creation. Either the JPA standard properties (
<literal>javax.persistence.jtaDataSource</literal>, <literal>java.persistence.nonJtaDataSource</literal>)
or their OpenJPA specific equivalents (<literal>openjpa.ConnectionFactoryName</literal>,
-<literal>openjpa.ConnectionFactory2Name</literal>) may be used. One usecase for this function is to
+<literal>openjpa.ConnectionFactory2Name</literal>) may be used. One use case for this function is to
store production connection information in configuration files but override the value when testing.
</para>
<para>
<example>
+ <title>
+ Setting DataSource at Runtime
+ </title>
<programlisting>Map<Object,Object> props = new HashMap<Object,Object>();
props.put("javax.persistence.jtaDataSource", "jdbc/myDataSource");
props.put("javax.persistence.nonJtaDataSource", "jdbc/myNonJTADataSource");
Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml?rev=1088391&r1=1088390&r2=1088391&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml Sun Apr 3 19:58:03 2011
@@ -136,6 +136,9 @@ scanned for annotated JPA entities.
<title>Metadata Repository</title>
<example id="ref_guide_meta_repo">
+ <title>
+ Setting the Preload Property on Metadata Repository
+ </title>
<programlisting>
<property name="openjpa.MetaDataRepository" value="Preload=true"/>
</programlisting>