You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by pp...@apache.org on 2008/07/28 19:10:39 UTC
svn commit: r680401 - /openjpa/trunk/openjpa-project/src/doc/manual/
Author: ppoddar
Date: Mon Jul 28 10:10:38 2008
New Revision: 680401
URL: http://svn.apache.org/viewvc?rev=680401&view=rev
Log:
OPENJPA-619: Typographical errors
Modified:
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_mapping.xml
openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_meta.xml
openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_pc.xml
openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_query.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_caching.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_conf.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_logging.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_runtime.xml
openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_slice.xml
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=680401&r1=680400&r2=680401&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 Mon Jul 28 10:10:38 2008
@@ -125,7 +125,7 @@
<para>
You can retrieve the <classname>EntityTransaction</classname> associated with an
<classname>EntityManager</classname> through the <methodname>getTransaction
-</methodname> method. Note that most most JPA implementations can
+</methodname> method. Note that most JPA implementations can
integrate with an application server's managed transactions. If you take
advantage of this feature, you will control transactions by declarative
demarcation or through the Java Transaction API (JTA) rather than through the
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=680401&r1=680400&r2=680401&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 Mon Jul 28 10:10:38 2008
@@ -204,9 +204,9 @@
When a persistence context ends, previously-managed entities become <emphasis>
detached</emphasis>. A detached entity is no longer under the control of the
<classname>EntityManager</classname>, and no longer has access to datastore
-resources. We discuss detachment is detail in
+resources. We discuss detachment in detail in
<xref linkend="jpa_overview_em_lifecycle"/>. For now, it is sufficient to
-know that detachment as has two obvious consequences:
+know that detachment has two obvious consequences:
</para>
<orderedlist>
<listitem>
@@ -234,8 +234,9 @@
</para>
</note>
<para>
-Injected <classname>EntityManager</classname>s have use a <emphasis>transaction
-</emphasis>, while <classname> EntityManager</classname>s obtained through the
+Injected <classname>EntityManager</classname>s have a <emphasis>transaction
+</emphasis> persistence context,
+while <classname> EntityManager</classname>s obtained through the
<classname>EntityManagerFactory</classname> have an <emphasis>extended
</emphasis> persistence context. We describe these persistence context types
below.
@@ -395,7 +396,7 @@
close it to free these resources. When an <classname>EntityManagerFactory
</classname> closes, all <classname>EntityManager</classname>s from that
factory, and by extension all entities managed by those <classname>
-EntityManager</classname> s, become invalid. Attempting to close an <classname>
+EntityManager</classname>s, become invalid. Attempting to close an <classname>
EntityManagerFactory</classname> while one or more of its <classname>
EntityManager</classname>s has an active transaction may result in an
<classname>IllegalStateException</classname>.
Modified: openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_mapping.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_mapping.xml?rev=680401&r1=680400&r2=680401&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_mapping.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_mapping.xml Mon Jul 28 10:10:38 2008
@@ -973,7 +973,7 @@
</itemizedlist>
<note>
<para>
-OpenJPA allows you to use describe one of OpenJPA's built-in generator
+OpenJPA allows you to use one of OpenJPA's built-in generator
implementations in the <literal>sequenceName</literal> property. You can also
set the <literal>sequenceName</literal> to <literal>system</literal> to use the
system sequence defined by the <link linkend="openjpa.Sequence"><literal>
@@ -3317,7 +3317,7 @@
</secondary>
</indexterm>
<para>
-Sometimes a a logical record is spread over multiple database tables. JPA
+Sometimes a logical record is spread over multiple database tables. JPA
calls a class' declared table the <emphasis>primary</emphasis>
table, and calls other tables that make up a logical record <emphasis>secondary
</emphasis> tables. You can map any persistent field to a secondary table. Just
@@ -4017,7 +4017,7 @@
<listitem>
<para>
<literal>JoinColumn[] joinColumns</literal>: Array of <classname>JoinColumn
-</classname> sshowing how to associate join table records with the owning row in
+</classname> showing how to associate join table records with the owning row in
the primary table. This property mirrors the <literal>pkJoinColumns</literal>
property of the <classname> SecondaryTable</classname> annotation in
functionality. See <xref linkend="jpa_overview_mapping_secondary"/> to
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=680401&r1=680400&r2=680401&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 Mon Jul 28 10:10:38 2008
@@ -756,7 +756,7 @@
The previous section showed you how to declare your identity fields with the
<classname>Id</classname> annotation. It is often convenient to allow the
persistence implementation to assign a unique value to your identity fields
-automatically. JPA includes the the <classname>GeneratedValue</classname>
+automatically. JPA includes the <classname>GeneratedValue</classname>
annotation for this purpose. It has the following properties:
</para>
<itemizedlist>
Modified: openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_pc.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_pc.xml?rev=680401&r1=680400&r2=680401&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_pc.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/jpa_overview_pc.xml Mon Jul 28 10:10:38 2008
@@ -1347,7 +1347,7 @@
<para>
<classname>ExcludeSuperclassListeners</classname>: This annotation will cause
OpenJPA to skip invoking any listeners declared in superclasses. The XML
-equivalent is empty the <literal>exclude-superclass-listeners</literal> element.
+equivalent is the empty <literal>exclude-superclass-listeners</literal> element.
</para>
</listitem>
</itemizedlist>
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=680401&r1=680400&r2=680401&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 Mon Jul 28 10:10:38 2008
@@ -167,7 +167,7 @@
SELECT x FROM Magazine x WHERE x.price <> 3.00
</programlisting>
<para>
-This query returns all Magazines whose price is not equals to 3.00.
+This query returns all Magazines whose price is not equal to 3.00.
</para>
<para>
You can group expressions together using parentheses in order to specify how
@@ -309,7 +309,7 @@
</title>
<para>
Relations between objects can be traversed using Java-like syntax. For example,
-if the Magazine class has a field named "publisher" or type Company, that
+if the Magazine class has a field named "publisher" of type Company, that
relation can be queried as follows:
</para>
<programlisting>
@@ -338,7 +338,7 @@
<para>
This query says that for each <classname>Magazine</classname><literal> x
</literal>, traverse the <literal>articles</literal> relation and check each
-<classname>Article</classname><literal>y</literal>, and pass the filter if
+<classname>Article</classname> <literal>y</literal>, and pass the filter if
<literal>y</literal>'s <literal>authorName</literal> field is equal to "John
Doe". In short, this query will return all magazines that have any articles
written by John Doe.
@@ -1580,7 +1580,7 @@
</literal> clause of a query. All identification variables must be declared in
the <literal>FROM</literal> clause. Identification variables cannot be declared
in other clauses. An identification variable must not be a reserved identifier
-or have the same name as any entity in the same persistence unit: Identification
+or have the same name as any entity in the same persistence unit. Identification
variables are case insensitive. An identification variable evaluates to a value
of the type of the expression used in declaring the variable. For example,
consider the previous query: <programlisting>SELECT DISTINCT mag FROM Magazine mag JOIN mag.articles art JOIN art.author auth WHERE auth.firstName = 'John'
@@ -1955,9 +1955,9 @@
literal that includes a single quote is represented by two single quotes--for
example: 'literal''s'. String literals in queries, like Java String literals,
use unicode character encoding. The use of Java escape notation is not supported
-in query string literals Exact numeric literals support the use of Java integer
+in query string literals. Exact numeric literals support the use of Java integer
literal syntax as well as SQL exact numeric literal syntax. Approximate literals
-support the use Java floating point literal syntax as well as SQL approximate
+support the use of Java floating point literal syntax as well as SQL approximate
numeric literal syntax. Enum literals support the use of Java enum literal
syntax. The enum class name must be specified. Appropriate suffixes may be used
to indicate the specific type of a numeric literal in accordance with the Java
@@ -2126,8 +2126,8 @@
</listitem>
<listitem>
<para>
-Logical operators: <literal>NOT</literal><literal>AND</literal><literal>OR
-</literal>
+Logical operators: <literal>NOT</literal>, <literal>AND</literal>,
+<literal>OR</literal>
</para>
</listitem>
</itemizedlist>
@@ -2676,7 +2676,7 @@
of a query is an entity abstract schema type, a state-field type, the result of
an aggregate function, the result of a construction operation, or some sequence
of these. The result type of the <literal>SELECT</literal> clause is defined by
-the the result types of the select_expressions contained in it. When multiple
+the result types of the select_expressions contained in it. When multiple
select_expressions are used in the <literal>SELECT</literal> clause, the result
of the query is of type Object[], and the elements in this result correspond in
order to the order of their specification in the <literal>SELECT</literal>
@@ -2724,7 +2724,7 @@
JPQL Constructor Expressions
</title>
<para>
-in the <literal>SELECT</literal> Clause A constructor may be used in the
+A constructor may be used in the
<literal>SELECT</literal> list to return one or more Java instances. The
specified class is not required to be an entity or to be mapped to the database.
The constructor name must be fully qualified.
@@ -2755,7 +2755,7 @@
JPQL Aggregate Functions
</title>
<para>
-in the <literal>SELECT</literal> Clause The result of a query may be the result
+The result of a query may be the result
of an aggregate function applied to a path expression. The following aggregate
functions can be used in the <literal>SELECT</literal> clause of a query:
<literal>AVG</literal>, <literal>COUNT</literal>, <literal>MAX</literal>,
@@ -2811,7 +2811,7 @@
JPQL Aggregate Examples
</title>
<para>
-Examples The following query returns the average price of all magazines:
+The following query returns the average price of all magazines:
<programlisting>SELECT AVG(mag.price) FROM Magazine mag</programlisting> The
following query returns the sum total cost of all the prices from all the
magazines published by 'Larry': <programlisting>SELECT SUM(mag.price) FROM Publisher pub JOIN pub.magazines mag pub.firstName = 'Larry'
@@ -2870,7 +2870,7 @@
JPQL Bulk Update and Delete
</title>
<para>
-Operations Bulk update and delete operations apply to entities of a single
+Bulk update and delete operations apply to entities of a single
entity class (together with its subclasses, if any). Only one entity abstract
schema type may be specified in the <literal>FROM</literal> or <literal>UPDATE
</literal> clause. The syntax of these operations is as follows:
Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_caching.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_caching.xml?rev=680401&r1=680400&r2=680401&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_caching.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_caching.xml Mon Jul 28 10:10:38 2008
@@ -341,7 +341,7 @@
</programlisting>
<para>
Most caches are of limited size. Pinning an identity to the cache ensures that
-the cache will will not kick the data for the corresponding instance out of the
+the cache will not kick the data for the corresponding instance out of the
cache, unless you manually evict it. Note that even after manual eviction, the
data will get pinned again the next time it is fetched from the store. You can
only remove a pin and make the data once again available for normal cache
@@ -501,7 +501,7 @@
</listitem>
<listitem>
<para>
-Caching is not used when the the data cache does not have any cached data for an
+Caching is not used when the data cache does not have any cached data for an
id in a query result.
</para>
</listitem>
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=680401&r1=680400&r2=680401&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 Mon Jul 28 10:10:38 2008
@@ -162,7 +162,7 @@
defaults. The given value can be the path to a file, or the resource name of a
file somewhere in the <literal>CLASSPATH</literal>. OpenJPA will search the
given location as well as the location prefixed by <filename> META-INF/
-</filename>. Thus, to point a OpenJPA tool at <filename>
+</filename>. Thus, to point an OpenJPA tool at <filename>
META-INF/my-persistence.xml</filename>, you can use:
</para>
<programlisting>
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=680401&r1=680400&r2=680401&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 Mon Jul 28 10:10:38 2008
@@ -268,7 +268,7 @@
<listitem>
<para>
<literal>DiagnosticContext</literal>: A string that will be prepended to all
-log messages. If this is not supplied and a <literal>openjpa.Id</literal>
+log messages. If this is not supplied and an <literal>openjpa.Id</literal>
property value is available, that value will be used.
</para>
</listitem>
Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml?rev=680401&r1=680400&r2=680401&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml Mon Jul 28 10:10:38 2008
@@ -476,7 +476,7 @@
</para>
</entry>
<entry colname="desc">
-If you are using a <link linkend="openjpa.jdbc.SchemaFactory"><literal>
+If you are using an <link linkend="openjpa.jdbc.SchemaFactory"><literal>
openjpa.jdbc.SchemaFactory</literal></link> setting of something other than
the default of <literal>dynamic</literal>, consider switching back. While other
factories can ensure that object-relational mapping information is valid when
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=680401&r1=680400&r2=680401&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 Mon Jul 28 10:10:38 2008
@@ -427,7 +427,7 @@
<emphasis>Java 5 class redefinition</emphasis>: if you are running your
application in a Java 5 environment, and you specify the OpenJPA javaagent,
OpenJPA will use Java 5 class redefinition to redefine any persistent classes
-that are not enhanced by thet OpenJPA javaagent. Aside from the requirement
+that are not enhanced by the OpenJPA javaagent. Aside from the requirement
that you specify a javaagent on the command line, this behavior is exactly the
same as the Java 6 class retransformation behavior. Of course, since the
OpenJPA javaagent performs enhancement by default, this will only be available
@@ -1547,7 +1547,7 @@
org.apache.openjpa.persistence.Factory</classname></ulink> annotation
contains the name of a method that will be invoked to instantiate the field from
the external form stored in the database. Specify a static method name. The
-method will will be invoked with the externalized value and must return an
+method will be invoked with the externalized value and must return an
instance of the field type. The method can also take an optional
<ulink url="../javadoc/org/apache/openjpa/kernel/StoreContext.html"><classname>
StoreContext</classname></ulink> parameter for access to a persistence context.
Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_runtime.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_runtime.xml?rev=680401&r1=680400&r2=680401&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_runtime.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_runtime.xml Mon Jul 28 10:10:38 2008
@@ -32,11 +32,11 @@
<para>
Internally, OpenJPA does not adhere to any persistence specification. The
OpenJPA kernel has its own set of APIs and components. Specifications like JPA
-and JDO are simply different "personalities" that can OpenJPA's native kernel
+and JDO are simply different "personalities" that OpenJPA's native kernel
can adopt.
</para>
<para>
-As a OpenJPA user, you will not normally see beneath
+As an OpenJPA user, you will not normally see beneath
OpenJPA's JPA personality. OpenJPA allows you to access its feature set without
leaving the comfort of JPA. Where OpenJPA goes beyond standard JPA
functionality, we have crafted JPA-specific APIs to each OpenJPA extension for
@@ -1649,21 +1649,21 @@
You can use JPA <literal>SequenceGenerator</literal>s to describe any built-in
<classname>Seq</classname>s or your own <classname>Seq</classname>
implementation. Set the <literal>sequenceName</literal> attribute to a plugin
-string describing your choice.
-</para>
-
-<blockquote>
-<para>
-If specifying your own class name, you must include parentheses at the end of
+string describing your choice.
+</para>
+
+<blockquote>
+<para>
+If specifying your own class name, you must include parentheses at the end of
the class name, even if you have no plugin properties to configure.
-(E.g., <literal>sequenceName="com.example.SeqImpl()"</literal>.
-</para>
-</blockquote>
-
-<para>
+(E.g., <literal>sequenceName="com.example.SeqImpl()"</literal>.
+</para>
+</blockquote>
+
+<para>
See <xref linkend="jpa_overview_mapping_sequence"/> in the JPA Overview for
details on defining <literal>SequenceGenerator</literal>s.
-</para>
+</para>
<para>
See <xref linkend="ref_guide_conf_plugins"/> for plugin string formatting.
Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_slice.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_slice.xml?rev=680401&r1=680400&r2=680401&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_slice.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_slice.xml Mon Jul 28 10:10:38 2008
@@ -530,7 +530,7 @@
Any OpenJPA property can be configured for each individual slice. The property name
is of the form <code>openjpa.slice.[Logical slice name].[OpenJPA Property Name]</code>.
For example, <code>openjpa.slice.One.ConnectionURL</code> where <code>One</code>
- is the logical slice name and <code>ConnectionURL</code> is a OpenJPA property
+ is the logical slice name and <code>ConnectionURL</code> is an OpenJPA property
name.
</para>
<para>