You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by dw...@apache.org on 2009/07/29 22:33:17 UTC

svn commit: r799063 - in /openjpa/trunk/openjpa-project/src/doc/manual: jpa_overview_criteria.xml jpa_overview_em.xml jpa_overview_emfactory.xml jpa_overview_persistence.xml jpa_overview_query.xml

Author: dwoods
Date: Wed Jul 29 20:33:16 2009
New Revision: 799063

URL: http://svn.apache.org/viewvc?rev=799063&view=rev
Log:
OPENJPA-890 Fix some typos/wording/formatting

Modified:
    openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_criteria.xml
    openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_em.xml
    openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_emfactory.xml
    openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_persistence.xml
    openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_query.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=799063&r1=799062&r2=799063&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 Wed Jul 29 20:33:16 2009
@@ -88,7 +88,7 @@
 		the domain objects and some variable. For example, to select the
 		Customers whose name is <emphasis>John Doe</emphasis> and has 
 		orders that are not yet delivered, you can build the predicate and set  
-		it to the query definition as
+		it to the query definition as:
 		<programlisting>
 qdef.where(customer.get("name").equal("John Doe")
       .and(order.get("status").equal(OrderStatus.DELIVERED).not()));
@@ -96,16 +96,16 @@
 		The <methodname>select()</methodname> method defines the result of the
 		query. If left unspecified, the select projection is assumed to be the
 		root domain object. However, you can specify the selected projections
-		explicitly as a list 
+		explicitly as a list:
 		<programlisting>
 qdef.select(customer.get("name"), order.get("status"));
 		</programlisting>
-		Attribute of a domain object is specified by navigating via 
+		An attribute of a domain object is specified by navigating via 
 		<methodname>get(String attr)</methodname>. The attribute 
 		<emphasis>should</emphasis> refer
 		to a valid persistent property of the receiving domain object, however
 		no such validation is enforced during the construction of the query 
-		definition. All validation is deferred till query is actually executed.
+		definition. All validation is deferred until the query is actually executed.
     	</para>
     </section> 
     
@@ -143,11 +143,11 @@
     an equivalent JPQL query string via the extended OpenJPAQueryBuilder API.
     <programlisting>
     	public interface OpenJPAQueryBuilder extends QueryBuilder {
-			/**
-		 	 * Gets equivalent JPQL String for the given QueryDefinition.
-	 		*/
-			public String toJPQL(QueryDefinition qdef);
-		}
+		/**
+	 	 * Gets equivalent JPQL String for the given QueryDefinition.
+ 		*/
+		public String toJPQL(QueryDefinition qdef);
+	}
 	</programlisting>
     
     </para>

Modified: openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_em.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_em.xml?rev=799063&r1=799062&r2=799063&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_em.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_em.xml Wed Jul 29 20:33:16 2009
@@ -1020,7 +1020,7 @@
 </programlisting>
         <para>
 <emphasis>Native</emphasis> queries are queries in the datastore's native
-language. For relational databases, this the Structured Query Language (SQL).
+language. For relational databases, this is the Structured Query Language (SQL).
 <xref linkend="jpa_overview_sqlquery"/> elaborates on JPA's
 native query support.
         </para>

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=799063&r1=799062&r2=799063&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 Wed Jul 29 20:33:16 2009
@@ -309,7 +309,7 @@
 // transaction
 Magazine mag3 = em.find(Magazine.class, magId);
 assertTrue(mag3 != mag1 &amp;&amp; mag3 != mag2);
-Magazine mag4 = em.find(Magazine.class (magId);
+Magazine mag4 = em.find(Magazine.class, magId);
 assertTrue(mag4 == mag3);
 ...
 
@@ -357,10 +357,10 @@
 // same persistence context active within the transaction
 Magazine mag3 = em.find(Magazine.class, magId);
 assertTrue(mag3 == mag1);
-Magazine mag4 = em.find(Magazine.class (magId);
+Magazine mag4 = em.find(Magazine.class, magId);
 assertTrue(mag4 == mag1);
 
-em.getTransaction.commit ();
+em.getTransaction.commit();
 
 // when the transaction commits, instance still managed
 Magazine mag5 = em.find(Magazine.class, magId);

Modified: openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_persistence.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_persistence.xml?rev=799063&r1=799062&r2=799063&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_persistence.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_persistence.xml Wed Jul 29 20:33:16 2009
@@ -67,7 +67,7 @@
     <para>
 Within a container, you will typically use <emphasis>injection</emphasis> to
 access an <classname>EntityManagerFactory</classname>. Applications operating
-of a container, however, can use the
+outside of a container, however, can use the
 <ulink url="http://java.sun.com/javaee/5/docs/api/javax/persistence/Persistence.html">
 <classname>Persistence</classname></ulink> class to obtain <classname>
 EntityManagerFactory</classname> objects in a vendor-neutral fashion.

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=799063&r1=799062&r2=799063&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 Wed Jul 29 20:33:16 2009
@@ -115,7 +115,7 @@
             </para>
             <note>
                 <para>
-When selecting entities, you can optional use the keyword <literal>object
+When selecting entities, you can optionally use the keyword <literal>object
 </literal>. The clauses <literal>select x</literal> and <literal>SELECT
 OBJECT(x)</literal> are synonymous.
                 </para>
@@ -622,7 +622,7 @@
 public Query setParameter(String name, Object value);
 </programlisting>
             <para>
-Named parameter are denoted by prefixing an arbitrary name with a colon in your
+Named parameters are denoted by prefixing an arbitrary name with a colon in your
 JPQL string. You can then populate the <classname> Query</classname> object with
 parameter values using the method above. Like the positional parameter method,
 this method returns the <classname>Query</classname> instance for optional
@@ -810,7 +810,7 @@
                  </title>
 <programlisting>
 ...
-@NamedQuery(name=" magsOverPrice",
+@NamedQuery(name="magsOverPrice",
 query="SELECT x FROM Magazine x WHERE x.price > ?1",
 hints={ @QueryHint  (name="openjpa.hint.OptimizeResultCount", value="2"),
         @QueryHint (name="openjpa.FetchPlan.ReadLockMode",value="WRITE")} )
@@ -1242,7 +1242,7 @@
 This query navigates over the association-field authors of the
 abstract schema type <literal>Magazine</literal> to find articles, and uses the
 state-field <literal>published</literal> of <literal>Article</literal> to select
-those magazines that have at least one article that is published. Although
+those magazines that have at least one article that is not published. Although
 predefined reserved identifiers, such as <literal>DISTINCT</literal>, <literal>
 FROM</literal>, <literal>AS</literal>, <literal>JOIN</literal>, <literal>
 WHERE</literal>, and <literal>FALSE</literal> appear in upper case in this 
@@ -2217,10 +2217,11 @@
 </programlisting> The rules for unknown and <literal>NULL</literal> values in
 comparison operations apply. See <xref linkend="jpa_langref_null_values"/>
 . Examples are: <programlisting>p.age BETWEEN 15 and 19</programlisting> is
-equivalent to <programlisting>p.age &gt;= 15 AND p.age &lt;= 19</programlisting>
+equivalent to: <programlisting>p.age &gt;= 15 AND p.age &lt;= 19</programlisting>
                 </para>
                 <para>
-<programlisting>p.age NOT BETWEEN 15 and 19</programlisting> is equivalent to
+The following expression:
+<programlisting>p.age NOT BETWEEN 15 and 19</programlisting> excludes the range, and is equivalent to:
 <programlisting>p.age &lt; 15 OR p.age &gt; 19</programlisting>
                 </para>
             </section>