Apache
/
openjpa
mirror of https://github.com/apache/openjpa.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix javadocs links 

git-svn-id: https://svn.apache.org/repos/asf/openjpa/trunk@1834587 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Francesco Chicchiriccò 2018-06-28 09:32:40 +00:00
parent 74c5980a94
commit 66a0a1499c
22 changed files with 340 additions and 340 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
openjpa-project/src/doc/manual/jpa_overview_arch.xml
View File

@ -305,7 +305,7 @@ additional details on JPA exceptions.
<note>
<para>
All exceptions thrown by OpenJPA implement
<ulink url="../javadoc/org/apache/openjpa/util/ExceptionInfo.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/util/ExceptionInfo.html"><classname>
org.apache.openjpa.util.ExceptionInfo</classname></ulink> to provide you with
additional error information.
</para>

2
openjpa-project/src/doc/manual/jpa_overview_em.xml
View File

@ -45,7 +45,7 @@ an ellipsis (...) are overloaded to take multiple parameter types.
<para>
OpenJPA extends the standard <classname>EntityManager</classname> interface with
the
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>org.apache.openjpa.persistence.OpenJPAEntityManager</classname>
</ulink> interface to provide additional functionality.
</para>

4
openjpa-project/src/doc/manual/jpa_overview_emfactory.xml
View File

@ -41,7 +41,7 @@ EntityManager</classname> instances for application use.
<para>
OpenJPA extends the standard <classname>EntityManagerFactory</classname>
interface with the
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManagerFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManagerFactory.html">
<classname>OpenJPAEntityManagerFactory</classname></ulink> to provide additional
functionality.
</para>
@ -162,7 +162,7 @@ createEntityManager</methodname>:
<para>
<literal>openjpa.&lt;property&gt;</literal>, where <emphasis>&lt;property&gt;
</emphasis> is any JavaBean property of the
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>
org.apache.openjpa.persistence.OpenJPAEntityManager</classname></ulink>.
</para>

2
openjpa-project/src/doc/manual/jpa_overview_meta.xml
View File

@ -1037,7 +1037,7 @@ http://www.ics.uci.edu/~ejw/authoring/uuid-guid/</ulink>
</itemizedlist>
<para>
These string constants are defined in
<ulink url="../javadoc/org/apache/openjpa/persistence/Generator.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/Generator.html">
<classname>org.apache.openjpa.persistence.Generator</classname></ulink>.
</para>
<para>

2
openjpa-project/src/doc/manual/jpa_overview_persistence.xml
View File

@ -59,7 +59,7 @@
<note>
<para>
OpenJPA also includes the
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAPersistence.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAPersistence.html">
<classname>OpenJPAPersistence</classname></ulink> helper class to provide
additional utility methods.
</para>

2
openjpa-project/src/doc/manual/jpa_resources.xml
View File

@ -41,7 +41,7 @@ javax.persistence Javadoc</ulink>
</listitem>
<listitem>
<para>
<ulink url="../javadoc/index.html">OpenJPA Javadoc</ulink>
<ulink url="../../apidocs/index.html">OpenJPA Javadoc</ulink>
</para>
</listitem>
</itemizedlist>

4
openjpa-project/src/doc/manual/migration_considerations.xml
View File

@ -110,7 +110,7 @@
</para>
<para>
In addition, a new method has been provided on the
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>OpenJPAEntityManager</classname></ulink>
interface to return a copy of the entity:
<programlisting>
@ -399,7 +399,7 @@
<para>
Additionally, if the <literal>CACHE</literal> clause has to be emitted in sequence definition,
this can be accomplished by overriding the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/DBDictionary.html#getCreateSequenceSQL(org.apache.openjpa.jdbc.schema.Sequence)">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/DBDictionary.html#getCreateSequenceSQL(org.apache.openjpa.jdbc.schema.Sequence)">
<methodname>DBDictionary.getCreateSequenceSQL</methodname></ulink> method.
</para>
</listitem>

18
openjpa-project/src/doc/manual/ref_guide_caching.xml
View File

@ -282,7 +282,7 @@ public class Employee {
</para>
</example>
<para>
See the <ulink url="../javadoc/org/apache/openjpa/persistence/DataCache.html">
See the <ulink url="../../apidocs/org/apache/openjpa/persistence/DataCache.html">
<classname>org.apache.openjpa.persistence.DataCache</classname></ulink> Javadoc
for more information on the <classname>DataCache</classname> annotation.
</para>
@ -472,7 +472,7 @@ is defaulted to <literal>concurrent</literal> though explicitly mentioned in thi
<para>
The <literal>org.apache.openjpa.datacache</literal> package defines OpenJPA's
data caching framework. While you may use this framework directly (see its
<ulink url="../javadoc/org/apache/openjpa/datacache/package-summary.html">
<ulink url="../../apidocs/org/apache/openjpa/datacache/package-summary.html">
Javadoc</ulink> for details), its APIs are meant primarily for service
providers. In fact, <xref linkend="ref_guide_cache_extension"/> below has
tips on how to use this package to extend OpenJPA's caching service yourself.
@ -482,7 +482,7 @@ Rather than use the low-level <literal>org.apache.openjpa.datacache</literal>
package APIs, JPA users should typically access the data cache through the JPA
standard <classname>javax.persistence.Cache</classname> interface, or OpenJPA's
high-level
<ulink url="../javadoc/org/apache/openjpa/persistence/StoreCache.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/StoreCache.html">
<classname>org.apache.openjpa.persistence.StoreCache</classname></ulink> facade.
</para>
<para>
@ -605,7 +605,7 @@ cache.evict(Magazine.class, changedMag.getId());
</example>
<para>
See the <classname>StoreCache</classname>
<ulink url="../javadoc/org/apache/openjpa/persistence/StoreCache.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/StoreCache.html">
Javadoc</ulink> for information on additional functionality it provides. Also,
<xref linkend="ref_guide_runtime"/> discusses OpenJPA's other extensions
to the standard set of JPA runtime interfaces.
@ -652,7 +652,7 @@ oem.evict(changedMag); // will evict from data cache also
<para>
Number of requests to read and write requests and hit ratio of the
data cache is available via
<ulink url="../javadoc/org/apache/openjpa/datacache/CacheStatistics.html">
<ulink url="../../apidocs/org/apache/openjpa/datacache/CacheStatistics.html">
<classname>org.apache.openjpa.datacache.CacheStatistics</classname></ulink>
interface. The collection of cache statistics is disabled by default and needs to be enabled on a per cache basis. By default
all counts returned from the CacheStatistics interface will return 0.
@ -750,7 +750,7 @@ execution time is fully traversed.
</para>
<para>
OpenJPA exposes a high-level interface to the query cache through the
<ulink url="../javadoc/org/apache/openjpa/persistence/QueryResultCache.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/QueryResultCache.html">
<classname>org.apache.openjpa.persistence.QueryResultCache</classname></ulink>
class. You can access this class through the <classname>
OpenJPAEntityManagerFactory</classname>.
@ -1187,7 +1187,7 @@ their parsed form. This property accepts the following aliases:
</entry>
<entry colname="notes">
The default option. Uses a
<ulink url="../javadoc/org/apache/openjpa/util/CacheMap.html">
<ulink url="../../apidocs/org/apache/openjpa/util/CacheMap.html">
<literal>CacheMap</literal></ulink> to store compilation data.
<literal>CacheMap</literal> maintains a fixed number of cache entries, and an
optional soft reference map for entries that are moved out of the LRU space.
@ -1251,7 +1251,7 @@ optionally collected as
<programlisting>
&lt;property name="openjpa.jdbc.QuerySQLCache" value="true(EnableStatistics=true)"&gt;
</programlisting>
The <ulink url="../javadoc/org/apache/openjpa/kernel/QueryStatistics.html">
The <ulink url="../../apidocs/org/apache/openjpa/kernel/QueryStatistics.html">
<code>QueryStatistics</code></ulink> can be accessed via <code>PreparedQueryCache.getStatistics()</code>.
</para>
@ -1280,7 +1280,7 @@ The <ulink url="../javadoc/org/apache/openjpa/kernel/QueryStatistics.html">
</entry>
<entry colname="notes">
The default option. Uses a
<ulink url="../javadoc/org/apache/openjpa/util/CacheMap.html">
<ulink url="../../apidocs/org/apache/openjpa/util/CacheMap.html">
<literal>CacheMap</literal></ulink> to store SQL string.
<literal>CacheMap</literal> maintains a fixed number of cache entries, and an
optional soft reference map for entries that are moved out of the LRU space.

250
openjpa-project/src/doc/manual/ref_guide_conf.xml
View File

@ -131,14 +131,14 @@ configuration resource to use, and to override any property.
<para>
Internally, the OpenJPA runtime environment and development
tools manipulate property settings through a general
<ulink url="../javadoc/org/apache/openjpa/lib/conf/Configuration.html">
<ulink url="../../apidocs/org/apache/openjpa/lib/conf/Configuration.html">
<classname>Configuration</classname></ulink> interface, and in particular its
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html">
<classname>OpenJPAConfiguration</classname></ulink> and
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html">
<classname>JDBCConfiguration</classname></ulink> subclasses. For advanced
customization, OpenJPA's extended runtime interfaces and its development tools
allow you to access these interfaces directly. See the <ulink url="../javadoc/">
allow you to access these interfaces directly. See the <ulink url="../../apidocs/">
Javadoc</ulink> for details.
</para>
</note>
@ -463,7 +463,7 @@ openjpa.AggregateListeners</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAggregateListeners()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAggregateListeners()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getAggregateListeners
</methodname></ulink>
</para>
@ -477,7 +477,7 @@ AggregateListeners</literal>
<para>
<emphasis role="bold">Description:</emphasis> A comma-separated list of plugin
strings (see <xref linkend="ref_guide_conf_plugins"/>) describing custom
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/exps/JDBCAggregateListener.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/exps/JDBCAggregateListener.html">
<classname> org.apache.openjpa.jdbc.kernel.exps.JDBCAggregateListener
</classname></ulink>s to make available to all queries, in addition to the
standard set of listeners. See <xref linkend="ref_guide_enterprise_queryext"/>
@ -511,7 +511,7 @@ standard set of listeners. See <xref linkend="ref_guide_enterprise_queryext"/>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAutoClear()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAutoClear()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getAutoClear
</methodname></ulink>
</para>
@ -558,7 +558,7 @@ transaction.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAutoDetach()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getAutoDetach()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getAutoDetach
</methodname></ulink>
</para>
@ -604,7 +604,7 @@ managed objects after the transaction and/or the context ends e.g. typical batch
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getBrokerFactory()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getBrokerFactory()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getBrokerFactory
</methodname></ulink>
</para>
@ -622,7 +622,7 @@ BrokerFactory</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/kernel/BrokerFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/kernel/BrokerFactory.html">
<classname>org.apache.openjpa.kernel.BrokerFactory</classname></ulink> type to
use.
</para>
@ -650,7 +650,7 @@ use.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getBrokerImpl()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getBrokerImpl()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getBrokerImpl
</methodname></ulink>
</para>
@ -664,7 +664,7 @@ BrokerImpl</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/kernel/Broker.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/kernel/Broker.html"><classname>
org.apache.openjpa.kernel.Broker</classname></ulink> type to use at runtime. See
<xref linkend="ref_guide_runtime_broker_extension"/> on for details.
</para>
@ -684,7 +684,7 @@ org.apache.openjpa.kernel.Broker</classname></ulink> type to use at runtime. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getCallbackOptionsInstance()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getCallbackOptionsInstance()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getCallbackOptionsInstance</methodname></ulink>
</para>
<para>
@ -739,7 +739,7 @@ properties related to callbacks. The plug-in supports two boolean properties:
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getClassResolver()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getClassResolver()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getClassResolver
</methodname></ulink>
</para>
@ -753,7 +753,7 @@ ClassResolver</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/util/ClassResolver.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/util/ClassResolver.html"><classname>
org.apache.openjpa.util.ClassResolver</classname></ulink> implementation to use
for class name resolution. You may wish to plug in your own resolver if you have
special classloading needs.
@ -779,7 +779,7 @@ special classloading needs.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getCompatibility()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getCompatibility()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getCompatibility
</methodname></ulink>
</para>
@ -818,7 +818,7 @@ openjpa.ConnectionDriverName</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionDriverName()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionDriverName()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionDriverName
</methodname></ulink>
@ -860,7 +860,7 @@ openjpa.Connection2DriverName</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2DriverName()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2DriverName()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2DriverName
</methodname></ulink>
@ -903,7 +903,7 @@ openjpa.ConnectionFactory</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory
</methodname></ulink>
</para>
@ -943,7 +943,7 @@ openjpa.ConnectionFactory2</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2
</methodname></ulink>
</para>
@ -983,7 +983,7 @@ openjpa.ConnectionFactoryName</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryName()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryName()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryName
</methodname></ulink>
@ -1024,7 +1024,7 @@ openjpa.ConnectionFactory2Name</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2Name()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2Name()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2Name
</methodname></ulink>
@ -1065,7 +1065,7 @@ openjpa.ConnectionFactoryMode</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryMode()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryMode()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryMode
</methodname></ulink>
@ -1110,7 +1110,7 @@ openjpa.ConnectionFactoryProperties</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryProperties()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactoryProperties()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactoryProperties
</methodname></ulink>
@ -1152,7 +1152,7 @@ openjpa.ConnectionFactory2Properties</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2Properties()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionFactory2Properties()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionFactory2Properties
</methodname></ulink>
@ -1195,7 +1195,7 @@ openjpa.ConnectionPassword</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionPassword()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionPassword()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionPassword
</methodname></ulink>
</para>
@ -1235,7 +1235,7 @@ openjpa.Connection2Password</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2Password()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2Password()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2Password
</methodname></ulink>
</para>
@ -1277,7 +1277,7 @@ openjpa.ConnectionProperties</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionProperties()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionProperties()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionProperties
</methodname></ulink>
@ -1319,7 +1319,7 @@ openjpa.Connection2Properties</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2Properties()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2Properties()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2Properties
</methodname></ulink>
@ -1362,7 +1362,7 @@ alternate connection factory used for unmanaged connections. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionURL()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionURL()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionURL
</methodname></ulink>
</para>
@ -1401,7 +1401,7 @@ ConnectionURL</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2URL()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2URL()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2URL
</methodname></ulink>
</para>
@ -1443,7 +1443,7 @@ openjpa.ConnectionUserName</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionUserName()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionUserName()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionUserName
</methodname></ulink>
</para>
@ -1483,7 +1483,7 @@ openjpa.Connection2UserName</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2UserName()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnection2UserName()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getConnection2UserName
</methodname></ulink>
</para>
@ -1525,7 +1525,7 @@ openjpa.ConnectionRetainMode</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionRetainMode()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getConnectionRetainMode()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getConnectionRetainMode
</methodname></ulink>
@ -1566,7 +1566,7 @@ sessions. See <xref linkend="ref_guide_dbsetup_retain"/> for details.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCache()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCache()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCache
</methodname></ulink>
</para>
@ -1580,7 +1580,7 @@ DataCache</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin list string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/datacache/DataCache.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/datacache/DataCache.html"><classname>
org.apache.openjpa.datacache.DataCache</classname></ulink>s to use for data
caching. See <xref linkend="ref_guide_cache_conf"/> for details.
</para>
@ -1608,7 +1608,7 @@ openjpa.DataCacheManager</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheManager()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheManager()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheManager
</methodname></ulink>
</para>
@ -1622,7 +1622,7 @@ DataCacheManager</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/datacache/DataCacheManager.html">
<ulink url="../../apidocs/org/apache/openjpa/datacache/DataCacheManager.html">
<classname>openjpa.datacache.DataCacheManager</classname></ulink> that manages
the system data caches. See <xref linkend="ref_guide_cache"/> for details
on data caching.
@ -1651,7 +1651,7 @@ openjpa.DataCacheMode</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheMode()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheMode()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheMode
</methodname></ulink>
</para>
@ -1663,7 +1663,7 @@ DataCacheMode</literal>
<emphasis role="bold">Default: </emphasis><literal>DataCacheMode.UNSPECIFIED (see javadoc for details)</literal>
</para>
<para>
<emphasis role="bold">Description:</emphasis>Determines which entities will be included in the DataCache. May be any of the values defined in <ulink url="../javadoc/org/apache/openjpa/datacache/DataCacheMode.html"/>.
<emphasis role="bold">Description:</emphasis>Determines which entities will be included in the DataCache. May be any of the values defined in <ulink url="../../apidocs/org/apache/openjpa/datacache/DataCacheMode.html"/>.
</para>
</section>
@ -1690,7 +1690,7 @@ openjpa.DataCacheTimeout</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheTimeout()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDataCacheTimeout()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDataCacheTimeout
</methodname></ulink>
</para>
@ -1735,7 +1735,7 @@ classes. See <xref linkend="ref_guide_cache_conf"/> for details.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfigurationImpl.html#getDetachState()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfigurationImpl.html#getDetachState()">
<methodname>org.apache.openjpa.conf.OpenJPAConfigurationImpl.getDetachState
</methodname></ulink>
</para>
@ -1787,7 +1787,7 @@ openjpa.DynamicDataStructs</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDynamicDataStructs()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDynamicDataStructs()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicDataStructs
</methodname></ulink>
</para>
@ -1819,7 +1819,7 @@ memory and speed optimization over time.
</para>
<para>
<emphasis role="bold">Configuration API: </emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDynamicEnhancementAgent()">org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicEnhancementAgent</ulink>
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getDynamicEnhancementAgent()">org.apache.openjpa.conf.OpenJPAConfiguration.getDynamicEnhancementAgent</ulink>
</para>
<para>
<emphasis role="bold">Resource adaptor config property:</emphasis>
@ -1864,7 +1864,7 @@ memory and speed optimization over time.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFetchBatchSize()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFetchBatchSize()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getFetchBatchSize
</methodname></ulink>
</para>
@ -1901,7 +1901,7 @@ runtime. See <xref linkend="ref_guide_dbsetup_lrs"/> for details.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getEncryptionProvider()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getEncryptionProvider()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getEncryptionProvider</methodname>
</ulink>
</para>
@ -1915,7 +1915,7 @@ runtime. See <xref linkend="ref_guide_dbsetup_lrs"/> for details.
<para>
<emphasis role="bold">Description:</emphasis> A plugin list string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/lib/encryption/EncryptionProvider.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/lib/encryption/EncryptionProvider.html"><classname>
org.apache.openjpa.lib.encryption.EncryptionProvider</classname></ulink>s to use for connection password
encryption. See <xref linkend="ref_guide_encryption"/> for details.
</para>
@ -1940,7 +1940,7 @@ encryption. See <xref linkend="ref_guide_encryption"/> for details.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFetchGroups()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFetchGroups()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getFetchGroups
</methodname></ulink>
</para>
@ -1982,7 +1982,7 @@ Fetch groups can also be set at runtime. See <xref linkend="ref_guide_fetch"/>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFilterListeners()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFilterListeners()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getFilterListeners
</methodname></ulink>
</para>
@ -1996,7 +1996,7 @@ FilterListeners</literal>
<para>
<emphasis role="bold">Description:</emphasis> A comma-separated list of full
plugin strings (see <xref linkend="ref_guide_conf_plugins"/>) for custom
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html">
<classname> org.apache.openjpa.jdbc.kernel.exps.JDBCFilterListener</classname>
</ulink>s to make available to all queries, in addition to the standard set of
listeners. You can also add filter listeners to individual queries. See
@ -2039,7 +2039,7 @@ openjpa.FlushBeforeQueries</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFlushBeforeQueries()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getFlushBeforeQueries()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getFlushBeforeQueries
</methodname></ulink>
</para>
@ -2071,7 +2071,7 @@ query. See <xref linkend="ref_guide_dbsetup_retain"/> for details.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getIgnoreChanges()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getIgnoreChanges()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getIgnoreChanges
</methodname></ulink>
</para>
@ -2139,7 +2139,7 @@ or flush before running it against the datastore.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#isInitializeEagerly()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#isInitializeEagerly()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.isInitializeEagerly
</methodname></ulink>
</para>
@ -2185,7 +2185,7 @@ openjpa.Instrumentation</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getInstrumentation()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getInstrumentation()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getInstrumentation
</methodname></ulink>
@ -2204,7 +2204,7 @@ Instrumentation</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing one or more instances of
<ulink url="../javadoc/org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html">
<ulink url="../../apidocs/org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html">
<classname>org.apache.openjpa.lib.instrumentation.InstrumentationProvider</classname></ulink> and
specific instruments to enable. See <xref linkend="ref_guide_instrumentation"/> for details.
</para>
@ -2233,7 +2233,7 @@ specific instruments to enable. See <xref linkend="ref_guide_instrumentation"/>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getInverseManager()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getInverseManager()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getInverseManager
</methodname></ulink>
</para>
@ -2251,7 +2251,7 @@ InverseManager</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing a
<ulink url="../javadoc/org/apache/openjpa/kernel/InverseManager.html">
<ulink url="../../apidocs/org/apache/openjpa/kernel/InverseManager.html">
<classname>org.apache.openjpa.kernel.InverseManager</classname></ulink> to use
for managing bidirectional relations upon a flush. See
<xref linkend="ref_guide_inverses"/> for usage documentation.
@ -2280,7 +2280,7 @@ for managing bidirectional relations upon a flush. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLockManager()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLockManager()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getLockManager
</methodname></ulink>
</para>
@ -2298,7 +2298,7 @@ LockManager</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing a
<ulink url="../javadoc/org/apache/openjpa/kernel/LockManager.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/kernel/LockManager.html"><classname>
org.apache.openjpa.kernel.LockManager</classname></ulink> to use for acquiring
locks on persistent instances during transactions. See
<xref linkend="ref_guide_locking_lockmgr"/> for more information.
@ -2327,7 +2327,7 @@ locks on persistent instances during transactions. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLockTimeout()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getLockTimeout()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getLockTimeout
</methodname></ulink>
</para>
@ -2366,7 +2366,7 @@ for an object lock before throwing an exception, or -1 for no limit. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/lib/conf/Configuration.html#getLog()">
<ulink url="../../apidocs/org/apache/openjpa/lib/conf/Configuration.html#getLog()">
<methodname>org.apache.openjpa.lib.conf.Configuration.getLog</methodname>
</ulink>
</para>
@ -2385,7 +2385,7 @@ for an object lock before throwing an exception, or -1 for no limit. See
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing a
<ulink url="../javadoc/org/apache/openjpa/lib/log/LogFactory.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/lib/log/LogFactory.html"><classname>
org.apache.openjpa.lib.log.LogFactory</classname></ulink> to use for logging.
For details on logging, see <xref linkend="ref_guide_logging"/>.
</para>
@ -2416,7 +2416,7 @@ For details on logging, see <xref linkend="ref_guide_logging"/>.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getManagedRuntime()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getManagedRuntime()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getManagedRuntime
</methodname></ulink>
</para>
@ -2430,7 +2430,7 @@ ManagedRuntime</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/ee/ManagedRuntime.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/ee/ManagedRuntime.html"><classname>
org.apache.openjpa.ee.ManagedRuntime</classname></ulink> implementation to use
for obtaining a reference to the <classname>TransactionManager</classname> in an
enterprise environment.
@ -2451,7 +2451,7 @@ enterprise environment.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMapping()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMapping()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMapping</methodname>
</ulink>
</para>
@ -2490,7 +2490,7 @@ object-to-datastore mapping to use.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMaxFetchDepth()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMaxFetchDepth()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMaxFetchDepth
</methodname></ulink>
</para>
@ -2530,7 +2530,7 @@ traverse when eager fetching. Use -1 for no limit. Defaults to no limit. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMetaDataFactory()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMetaDataFactory()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMetaDataFactory
</methodname></ulink>
</para>
@ -2544,7 +2544,7 @@ MetaDataFactory</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/meta/MetaDataFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/meta/MetaDataFactory.html">
<classname>openjpa.meta.MetaDataFactory</classname></ulink> to use to store and
retrieve metadata for your persistent classes. See
<xref linkend="ref_guide_meta_factory"/> for details.
@ -2574,7 +2574,7 @@ retrieve metadata for your persistent classes. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMetaDataRepository()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMetaDataRepository()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMetaDataRepository
</methodname></ulink>
</para>
@ -2588,7 +2588,7 @@ MetaDataRepository</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/meta/MetaDataRepository.html">
<ulink url="../../apidocs/org/apache/openjpa/meta/MetaDataRepository.html">
<classname>openjpa.meta.MetaDataRepository</classname></ulink> to use to store and
retrieve metadata for your persistent classes. See
<xref linkend="ref_guide_meta_repository"/> for details.
@ -2620,7 +2620,7 @@ retrieve metadata for your persistent classes. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMultithreaded()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getMultithreaded()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getMultithreaded
</methodname></ulink>
</para>
@ -2660,7 +2660,7 @@ will be accessed by multiple threads at once.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOptimistic()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOptimistic()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getOptimistic
</methodname></ulink>
</para>
@ -2699,7 +2699,7 @@ pessimistic (datastore) transactional modes.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOptimizeIdCopy()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOptimizeIdCopy()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getOptimizeIdCopy
</methodname></ulink>
</para>
@ -2748,7 +2748,7 @@ openjpa.OrphanedKeyAction</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOrphanedKeyAction()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getOrphanedKeyAction()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getOrphanedKeyAction
</methodname></ulink>
</para>
@ -2766,7 +2766,7 @@ OrphanedKeyAction</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing a
<ulink url="../javadoc/org/apache/openjpa/event/OrphanedKeyAction.html">
<ulink url="../../apidocs/org/apache/openjpa/event/OrphanedKeyAction.html">
<classname>org.apache.openjpa.event.OrphanedKeyAction</classname></ulink> to
invoke when OpenJPA discovers an orphaned datastore key. See
<xref linkend="ref_guide_orphan"/> for details.
@ -2787,7 +2787,7 @@ openjpa.NontransactionalRead</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getNontransactionalRead()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getNontransactionalRead()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getNontransactionalRead
</methodname></ulink>
@ -2819,7 +2819,7 @@ openjpa.NontransactionalWrite</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getNontransactionalWrite()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getNontransactionalWrite()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getNontransactionalWrite
</methodname></ulink>
@ -2860,7 +2860,7 @@ will take effect on the next transaction.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getProxyManager()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getProxyManager()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getProxyManager
</methodname></ulink>
</para>
@ -2874,7 +2874,7 @@ ProxyManager</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing a
<ulink url="../javadoc/org/apache/openjpa/util/ProxyManager.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/util/ProxyManager.html"><classname>
org.apache.openjpa.util.ProxyManager</classname></ulink> to use for proxying
mutable second class objects. See
<xref linkend="ref_guide_pc_scos_proxy_custom"/> for details.
@ -2896,7 +2896,7 @@ mutable second class objects. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getPostLoadOnMerge()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getPostLoadOnMerge()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getPostLoadOnMerge
</methodname></ulink>
@ -2941,7 +2941,7 @@ mutable second class objects. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getQueryCache()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getQueryCache()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getQueryCache
</methodname></ulink>
</para>
@ -2955,7 +2955,7 @@ QueryCache</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/datacache/QueryCache.html">
<ulink url="../../apidocs/org/apache/openjpa/datacache/QueryCache.html">
<classname>org.apache.openjpa.datacache.QueryCache</classname></ulink>
implementation to use for caching of queries loaded from the data store. See
<xref linkend="ref_guide_cache_query"/> for details.
@ -3019,7 +3019,7 @@ query compilation. See <xref linkend="ref_guide_cache_querycomp"/> for details.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getReadLockLevel()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getReadLockLevel()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getReadLockLevel
</methodname></ulink>
</para>
@ -3079,7 +3079,7 @@ openjpa.RemoteCommitProvider</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRemoteCommitProvider()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRemoteCommitProvider()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getRemoteCommitProvider
</methodname></ulink>
@ -3094,7 +3094,7 @@ RemoteCommitProvider</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/event/RemoteCommitProvider.html">
<ulink url="../../apidocs/org/apache/openjpa/event/RemoteCommitProvider.html">
<classname>org.apache.openjpa.event.RemoteCommitProvider</classname></ulink>
implementation to use for distributed event notification. See
<xref linkend="ref_guide_event_conf"/> for more information.
@ -3115,7 +3115,7 @@ implementation to use for distributed event notification. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRestoreState()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRestoreState()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getRestoreState
</methodname></ulink>
</para>
@ -3150,7 +3150,7 @@ to their pre-transaction values when a rollback occurs.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRetainState()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRetainState()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getRetainState
</methodname></ulink>
</para>
@ -3189,7 +3189,7 @@ openjpa.RetryClassRegistration</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRetryClassRegistration()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRetryClassRegistration()">
<methodname>
org.apache.openjpa.conf.OpenJPAConfiguration.getRetryClassRegistration
</methodname></ulink>
@ -3218,7 +3218,7 @@ serious problems.
</para>
<para>
<emphasis role="bold">Configuration API: </emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRuntimeUnenhancedClasses()">org.apache.openjpa.conf.OpenJPAConfiguration.getRuntimeUnenhancedClasses</ulink>
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getRuntimeUnenhancedClasses()">org.apache.openjpa.conf.OpenJPAConfiguration.getRuntimeUnenhancedClasses</ulink>
</para>
<para>
<emphasis role="bold">Resource adaptor config property:</emphasis>
@ -3270,7 +3270,7 @@ openjpa.SavepointManager</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getSavepointManager()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getSavepointManager()">
org.apache.openjpa.conf.OpenJPAConfiguration.getSavepointManager</ulink>
</para>
<para>
@ -3287,7 +3287,7 @@ SavepointManager
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing a
<ulink url="../javadoc/org/apache/openjpa/kernel/SavepointManager.html">
<ulink url="../../apidocs/org/apache/openjpa/kernel/SavepointManager.html">
<classname>org.apache.openjpa.kernel.SavepointManager</classname></ulink> to
use for managing transaction savepoints. See
<xref linkend="ref_guide_savepoints"/> for details.
@ -3308,7 +3308,7 @@ use for managing transaction savepoints. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getSequence()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getSequence()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getSequence
</methodname></ulink>
</para>
@ -3322,7 +3322,7 @@ Sequence</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/kernel/Seq.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/kernel/Seq.html"><classname>
org.apache.openjpa.kernel.Seq</classname></ulink> implementation to use for the
system sequence. See <xref linkend="ref_guide_sequence"/> for more
information.
@ -3343,7 +3343,7 @@ information.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getSpecificationInstance()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getSpecificationInstance()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getSpecificationInstance
</methodname></ulink>
</para>
@ -3388,7 +3388,7 @@ See <xref linkend="ref_guide_spec_compatibility"/> for more information.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getTransactionMode()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getTransactionMode()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getTransactionMode
</methodname></ulink>
</para>
@ -3431,7 +3431,7 @@ use. You can override this setting per-session.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getUseTCCLinSelectNew()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getUseTCCLinSelectNew()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getUseTCCLinSelectNew
</methodname></ulink>
</para>
@ -3478,7 +3478,7 @@ use. You can override this setting per-session.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getWriteLockLevel()">
<ulink url="../../apidocs/org/apache/openjpa/conf/OpenJPAConfiguration.html#getWriteLockLevel()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getWriteLockLevel
</methodname></ulink>
</para>
@ -3546,7 +3546,7 @@ openjpa.jdbc.ConnectionDecorators</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getConnectionDecorators()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getConnectionDecorators()">
<methodname>
org.apache.openjpa.jdbc.conf.JDBCConfiguration.getConnectionDecorators
</methodname></ulink>
@ -3561,7 +3561,7 @@ ConnectionDecorators</literal>
<para>
<emphasis role="bold">Description:</emphasis> A comma-separated list of plugin
strings (see <xref linkend="ref_guide_conf_plugins"/>) describing
<ulink url="../javadoc/org/apache/openjpa/lib/jdbc/ConnectionDecorator.html">
<ulink url="../../apidocs/org/apache/openjpa/lib/jdbc/ConnectionDecorator.html">
<classname>org.apache.openjpa.lib.jdbc.ConnectionDecorator</classname></ulink>
instances to install on the connection factory. These decorators can wrap
connections passed from the underlying <classname>DataSource</classname> to add
@ -3594,7 +3594,7 @@ openjpa.jdbc.DBDictionary</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getDBDictionary()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getDBDictionary()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getDBDictionary
</methodname></ulink>
</para>
@ -3611,7 +3611,7 @@ openjpa.ConnectionDriverName</literal></link>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/DBDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/DBDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.DBDictionary</classname></ulink> to use
for database interaction. OpenJPA typically auto-configures the dictionary based
on the JDBC URL, but you may have to set this property explicitly if you are
@ -3644,7 +3644,7 @@ openjpa.jdbc.DriverDataSource</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getDriverDataSource()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getDriverDataSource()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getDriverDataSource
</methodname></ulink>
</para>
@ -3662,7 +3662,7 @@ DriverDataSource</literal>
<para>
<emphasis role="bold">Description:</emphasis> The alias or full class name of
the
<ulink url="../javadoc/org/apache/openjpa/jdbc/schema/DriverDataSource.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/schema/DriverDataSource.html">
<classname>org.apache.openjpa.jdbc.schema.DriverDataSource</classname></ulink>
implementation to use to wrap JDBC Driver classes with javax.sql.DataSource
instances. The <classname>org.apache.openjpa.jdbc.schema.AutoDriverDataSource</classname> implementation is the default and will select either the DBCPDriverDataSource or SimpleDriverDataSource based on if Apache Commons DBCP is available
@ -3693,7 +3693,7 @@ openjpa.jdbc.EagerFetchMode</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getEagerFetchMode()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getEagerFetchMode()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getEagerFetchMode
</methodname></ulink>
</para>
@ -3737,7 +3737,7 @@ openjpa.jdbc.FetchDirection</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getFetchDirection()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getFetchDirection()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getFetchDirection
</methodname></ulink>
</para>
@ -3781,7 +3781,7 @@ openjpa.jdbc.JDBCListeners</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getJDBCListeners()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getJDBCListeners()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getJDBCListeners
</methodname></ulink>
</para>
@ -3795,7 +3795,7 @@ JDBCListeners</literal>
<para>
<emphasis role="bold">Description:</emphasis> A comma-separated list of plugin
strings (see <xref linkend="ref_guide_conf_plugins"/>) describing
<ulink url="../javadoc/org/apache/openjpa/lib/jdbc/JDBCListener.html">
<ulink url="../../apidocs/org/apache/openjpa/lib/jdbc/JDBCListener.html">
<classname>org.apache.openjpa.lib.jdbc.JDBCListener</classname></ulink> event
listeners to install. These listeners will be notified on various JDBC-related
events.
@ -3824,7 +3824,7 @@ events.
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getLRSSize()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getLRSSize()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getLRSSize
</methodname></ulink>
</para>
@ -3868,7 +3868,7 @@ openjpa.jdbc.MappingDefaults</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getMappingDefaults()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getMappingDefaults()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getMappingDefaults
</methodname></ulink>
</para>
@ -3882,7 +3882,7 @@ MappingDefaults</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/MappingDefaults.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/MappingDefaults.html">
<classname>org.apache.openjpa.jdbc.meta.MappingDefaults</classname></ulink> to
use to define default column names, table names, and constraints for your
persistent classes. See <xref linkend="ref_guide_mapping_factory"/> for
@ -3912,7 +3912,7 @@ openjpa.jdbc.MappingFactory</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getMappingFactory()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getMappingFactory()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getMappingFactory
</methodname></ulink>
</para>
@ -3926,7 +3926,7 @@ MappingFactory</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/meta/MetaDataFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/meta/MetaDataFactory.html">
<classname>org.apache.openjpa.meta.MetaDataFactory</classname></ulink> to use to
store and retrieve object-relational mapping information for your persistent
classes. See <xref linkend="ref_guide_mapping_factory"/> for details.
@ -3991,7 +3991,7 @@ openjpa.jdbc.ResultSetType</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getResultSetType()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getResultSetType()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getResultSetType
</methodname></ulink>
</para>
@ -4030,7 +4030,7 @@ when fetching result lists. This property can also be varied at runtime. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSchema()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSchema()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSchema
</methodname></ulink>
</para>
@ -4070,7 +4070,7 @@ openjpa.jdbc.SchemaFactory</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSchemaFactory()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSchemaFactory()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSchemaFactory
</methodname></ulink>
</para>
@ -4089,7 +4089,7 @@ others
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/jdbc/schema/SchemaFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/schema/SchemaFactory.html">
<classname>org.apache.openjpa.jdbc.schema.SchemaFactory</classname></ulink> to
use to store and retrieve information about the database schema. See
<xref linkend="ref_guide_schema_info_factory"/> for details.
@ -4113,7 +4113,7 @@ use to store and retrieve information about the database schema. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSchemas()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSchemas()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSchemas
</methodname></ulink>
</para>
@ -4153,7 +4153,7 @@ schemas and/or tables used for your persistent data. See
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSQLFactory()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSQLFactory()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSQLFactory
</methodname></ulink>
</para>
@ -4167,7 +4167,7 @@ SQLFactory</literal>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/SQLFactory.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/SQLFactory.html"><classname>
org.apache.openjpa.jdbc.sql.SQLFactory</classname></ulink> to use to abstract
common SQL constructs.
</para>
@ -4203,7 +4203,7 @@ openjpa.jdbc.SubclassFetchMode</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSubclassFetchMode()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSubclassFetchMode()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSubclassFetchMode
</methodname></ulink>
</para>
@ -4247,7 +4247,7 @@ openjpa.jdbc.SynchronizeMappings</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSynchronizeMappings()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getSynchronizeMappings()">
<methodname>
org.apache.openjpa.jdbc.conf.JDBCConfiguration.getSynchronizeMappings
</methodname></ulink>
@ -4297,7 +4297,7 @@ openjpa.jdbc.TransactionIsolation</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getTransactionIsolation()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getTransactionIsolation()">
<methodname>
org.apache.openjpa.jdbc.conf.JDBCConfiguration.getTransactionIsolation
</methodname></ulink>
@ -4344,7 +4344,7 @@ openjpa.jdbc.UpdateManager</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getUpdateManager()">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html#getUpdateManager()">
<methodname>org.apache.openjpa.jdbc.conf.JDBCConfiguration.getUpdateManager
</methodname></ulink>
</para>
@ -4362,11 +4362,11 @@ batching-constraint</literal>, <literal>batching-operation-order</literal>
</para>
<para>
<emphasis role="bold">Description:</emphasis> The full class name of the
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/UpdateManager.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/UpdateManager.html">
<classname>org.apache.openjpa.jdbc.kernel.UpdateManager</classname></ulink> to
use to flush persistent object changes to the datastore. The provided default
implementation is
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/BatchingConstraintUpdateManager">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/BatchingConstraintUpdateManager">
<classname>org.apache.openjpa.jdbc.kernel.BatchingConstraintUpdateManager</classname>
</ulink>.

52
openjpa-project/src/doc/manual/ref_guide_dbsetup.xml
View File

@ -694,7 +694,7 @@ configuration properties.
<para>
If OpenJPA cannot detect what type of database you are using, or if you are
using an unsupported database, you will have to tell OpenJPA what
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/DBDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/DBDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.DBDictionary</classname></ulink> to use.
The <classname>DBDictionary</classname> abstracts away the differences between
databases. You can plug a dictionary into OpenJPA using the
@ -713,7 +713,7 @@ below. If you are using an unsupported database, you may have to write your own
</indexterm>
<literal>access</literal>: Dictionary for Microsoft Access. This is an alias
for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/AccessDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/AccessDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.AccessDictionary</classname></ulink>
class.
</para>
@ -726,7 +726,7 @@ class.
</primary>
</indexterm>
<literal>db2</literal>: Dictionary for IBM's DB2 database. This is an alias for
the <ulink url="../javadoc/org/apache/openjpa/jdbc/sql/DB2Dictionary.html">
the <ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/DB2Dictionary.html">
<classname>org.apache.openjpa.jdbc.sql.DB2Dictionary</classname></ulink> class.
</para>
</listitem>
@ -739,7 +739,7 @@ the <ulink url="../javadoc/org/apache/openjpa/jdbc/sql/DB2Dictionary.html">
</indexterm>
<literal>derby</literal>: Dictionary for the Apache Derby database. This is an
alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/DerbyDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/DerbyDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.DerbyDictionary</classname> class.
</ulink>
</para>
@ -753,7 +753,7 @@ alias for the
</indexterm>
<literal>empress</literal>: Dictionary for Empress database This is an alias
for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/EmpressDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/EmpressDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.EmpressDictionary</classname></ulink>
class.
</para>
@ -767,7 +767,7 @@ class.
</indexterm>
<literal>foxpro</literal>: Dictionary for Microsoft Visual FoxPro. This is an
alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/FoxProDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/FoxProDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.FoxProDictionary</classname></ulink>
class.
</para>
@ -781,7 +781,7 @@ class.
</indexterm>
<literal>h2</literal>: Dictionary for the H2 Database Engine. This is an
alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/H2Dictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/H2Dictionary.html">
<classname>org.apache.openjpa.jdbc.sql.H2Dictionary</classname></ulink> class.
</para>
</listitem>
@ -794,7 +794,7 @@ alias for the
</indexterm>
<literal>hsql</literal>: Dictionary for the Hypersonic SQL database. This is an
alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/HSQLDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/HSQLDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.HSQLDictionary</classname></ulink> class.
</para>
</listitem>
@ -807,7 +807,7 @@ alias for the
</indexterm>
<literal>informix</literal>: Dictionary for the Informix database. This is an
alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/InformixDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/InformixDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.InformixDictionary</classname></ulink>
class.
</para>
@ -820,7 +820,7 @@ class.
</primary>
</indexterm>
<literal>ingres</literal>: Dictionary for Ingres. This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/IngresDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/IngresDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.IngresDictionary</classname></ulink>
class.
</para>
@ -834,7 +834,7 @@ class.
</indexterm>
<literal>jdatastore</literal>: Dictionary for Borland JDataStore. This is an
alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/JDataStoreDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/JDataStoreDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.JDataStoreDictionary</classname></ulink>
class.
</para>
@ -848,7 +848,7 @@ class.
</indexterm>
<literal>mariadb</literal>: Dictionary for the MariaDB database. This is an alias
for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/MariaDBDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/MariaDBDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.MariaDBDictionary</classname></ulink>
class.
</para>
@ -862,7 +862,7 @@ class.
</indexterm>
<literal>mysql</literal>: Dictionary for the MySQL database. This is an alias
for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/MySQLDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/MySQLDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.MySQLDictionary</classname></ulink>
class.
</para>
@ -875,7 +875,7 @@ class.
</primary>
</indexterm>
<literal>oracle</literal>: Dictionary for Oracle. This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/OracleDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/OracleDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.OracleDictionary</classname></ulink>
class.
</para>
@ -889,7 +889,7 @@ class.
</indexterm>
<literal>pointbase</literal>: Dictionary for Pointbase Embedded database. This
is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/PointbaseDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/PointbaseDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.PointbaseDictionary</classname></ulink>
class.
</para>
@ -902,7 +902,7 @@ class.
</primary>
</indexterm>
<literal>postgres</literal>: Dictionary for PostgreSQL. This is an alias for
the <ulink url="../javadoc/org/apache/openjpa/jdbc/sql/PostgresDictionary.html">
the <ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/PostgresDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.PostgresDictionary</classname></ulink>
class.
</para>
@ -916,7 +916,7 @@ class.
</indexterm>
<literal>soliddb</literal>: Dictionary for IBM's SolidDB database.
This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/SolidDBDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/SolidDBDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.SolidDBDictionary</classname></ulink>
class.
</para>
@ -930,7 +930,7 @@ class.
</indexterm>
<literal>sqlserver</literal>: Dictionary for Microsoft's SQL Server database.
This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/SQLServerDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/SQLServerDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.SQLServerDictionary</classname></ulink>
class.
</para>
@ -943,7 +943,7 @@ class.
</primary>
</indexterm>
<literal>sybase</literal>: Dictionary for Sybase. This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/SybaseDictionary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/SybaseDictionary.html">
<classname>org.apache.openjpa.jdbc.sql.SybaseDictionary</classname></ulink>
class.
</para>
@ -1169,7 +1169,7 @@ generated by the <literal>mappingtool</literal>.
<literal>BooleanRepresentation</literal>:
The overridden default representation for <literal>java.lang.Boolean</literal> or
<literal>boolean</literal> fields in JPA Entities. A
<ulink url="../javadoc/org/apache/openjpa/jdbc/sql/BooleanRepresentation.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/sql/BooleanRepresentation.html">
<classname>org.apache.openjpa.jdbc.sql.BooleanRepresentation</classname></ulink>
describes how Boolean values in entities get mapped into the database by default.
Note that you additionally might need to define the <literal>BooleanTypeName</literal>
@ -5230,7 +5230,7 @@ Oracle, for example, requires names in all upper case.
</indexterm>
<para>
OpenJPA relies on the
<ulink url="../javadoc/org/apache/openjpa/jdbc/schema/SchemaFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/schema/SchemaFactory.html">
<classname>openjpa.jdbc.SchemaFactory</classname></ulink> interface for runtime
schema information. You can control the schema factory OpenJPA uses through the
<literal>openjpa.jdbc.SchemaFactory</literal> property. There are several
@ -5240,7 +5240,7 @@ built-in options to choose from:
<listitem>
<para>
<literal>dynamic</literal>: This is the default setting. It is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/schema/DynamicSchemaFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/schema/DynamicSchemaFactory.html">
<classname>
org.apache.openjpa.jdbc.schema.DynamicSchemaFactory</classname></ulink>. The
<classname>DynamicSchemaFactory</classname> is the most performant
@ -5255,7 +5255,7 @@ that OpenJPA can order its SQL statements to meet them.
<listitem>
<para>
<literal>native</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/schema/LazySchemaFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/schema/LazySchemaFactory.html">
<classname>org.apache.openjpa.jdbc.schema.LazySchemaFactory</classname></ulink>
. As persistent classes are loaded by the application, OpenJPA reads their
metadata and object-relational mapping information. This factory uses the
@ -5277,7 +5277,7 @@ read foreign key information during schema validation.
<listitem>
<para>
<literal>table</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/schema/TableSchemaFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/schema/TableSchemaFactory.html">
<classname>org.apache.openjpa.jdbc.schema.TableSchemaFactory</classname></ulink>
. This schema factory stores schema information as an XML document in a database
table it creates for this purpose. If your JDBC driver doesn't support the
@ -5312,7 +5312,7 @@ holding the schema definition as an XML string. Defaults to <literal>SCHEMA_DEF
<listitem>
<para>
<literal>file</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/schema/FileSchemaFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/schema/FileSchemaFactory.html">
<classname>org.apache.openjpa.jdbc.schema.FileSchemaFactory</classname></ulink>
. This factory is a lot like the <classname>TableSchemaFactory</classname>, and
has the same advantages and disadvantages. Instead of storing its XML schema
@ -5410,7 +5410,7 @@ schemas.
</para>
<para>
You can invoke the schema tool through its Java class,
<ulink url="../javadoc/org/apache/openjpa/jdbc/schema/SchemaTool.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/schema/SchemaTool.html">
<classname>org.apache.openjpa.jdbc.schema.SchemaTool</classname></ulink>. In
addition to the universal flags of the <link linkend="ref_guide_conf">
configuration framework</link>, the schema tool accepts the following command

10
openjpa-project/src/doc/manual/ref_guide_deploy.xml
View File

@ -58,7 +58,7 @@ The JPA Overview describes the <classname>javax.persistence.Persistence
<classname>Persistence</classname> to add additional <classname>
EntityManagerFactory</classname> creation methods. The <classname>
org.apache.openjpa.persistence.OpenJPAPersistence</classname> class
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAPersistence.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAPersistence.html">
Javadoc</ulink> details these extensions.
</para>
<para>
@ -164,7 +164,7 @@ manager for an unrecognized or non-standard application server setup. This is
accomplished through the <link linkend="openjpa.ManagedRuntime"><literal>
openjpa.ManagedRuntime</literal></link> configuration property. This
property describes an
<ulink url="../javadoc/org/apache/openjpa/ee/ManagedRuntime.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/ee/ManagedRuntime.html"><classname>
org.apache.openjpa.ee.ManagedRuntime</classname></ulink> implementation to use
for transaction manager discovery. You can specify your own implementation,
or use one of the built-ins:
@ -173,7 +173,7 @@ or use one of the built-ins:
<listitem>
<para>
<literal>auto</literal>: This is the default. It is an alias for the
<ulink url="../javadoc/org/apache/openjpa/ee/AutomaticManagedRuntime.html">
<ulink url="../../apidocs/org/apache/openjpa/ee/AutomaticManagedRuntime.html">
<classname>org.apache.openjpa.ee.AutomaticManagedRuntime</classname></ulink>
class. This managed runtime is able to automatically integrate with several
common application servers.
@ -182,7 +182,7 @@ common application servers.
<listitem>
<para>
<literal>invocation</literal>: An alias for the
<ulink url="../javadoc/org/apache/openjpa/ee/InvocationManagedRuntime.html">
<ulink url="../../apidocs/org/apache/openjpa/ee/InvocationManagedRuntime.html">
<classname>org.apache.openjpa.ee.InvocationManagedRuntime</classname></ulink>
class. You can configure this runtime to invoke any static
method in order to obtain the appserver's transaction manager.
@ -191,7 +191,7 @@ method in order to obtain the appserver's transaction manager.
<listitem>
<para>
<literal>jndi</literal>: An alias for the
<ulink url="../javadoc/org/apache/openjpa/ee/JNDIManagedRuntime.html">
<ulink url="../../apidocs/org/apache/openjpa/ee/JNDIManagedRuntime.html">
<classname>org.apache.openjpa.ee.JNDIManagedRuntime</classname></ulink>
class. You can configure this runtime to look up the transaction manager at
any JNDI location.

2
openjpa-project/src/doc/manual/ref_guide_encryption.xml
View File

@ -25,7 +25,7 @@
OpenJPA provides an interface for a provider to implement
connection password encryption. Whenever a connection password
is needed, the <methodname>decrypt(String)</methodname> method will be invoked. See
<ulink url="../javadoc/org/apache/openjpa/lib/encryption/EncryptionProvider.html">
<ulink url="../../apidocs/org/apache/openjpa/lib/encryption/EncryptionProvider.html">
<classname>org.apache.openjpa.lib.encryption.EncryptionProvider</classname>
</ulink> for the detailed Javadoc.
</para>

10
openjpa-project/src/doc/manual/ref_guide_instrumentation.xml
View File

@ -114,9 +114,9 @@
<para>
OpenJPA includes built-in support for a JMX Platform MBean provider, but a custom instrumentation
providers can be created by implementing the
<ulink url="../javadoc/org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html">
<ulink url="../../apidocs/org/apache/openjpa/lib/instrumentation/InstrumentationProvider.html">
<classname>InstrumentationProvider</classname></ulink> interface or more simply by extending
<ulink url="../javadoc/org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html">
<ulink url="../../apidocs/org/apache/openjpa/lib/instrumentation/AbstractInstrumentationProvider.html">
<classname>AbstractInstrumentationProvider</classname></ulink>. To use the custom instrumentation provider,
include the class in your classpath and specify the class name as the base value on the
<link linkend="openjpa.Instrumentation"><literal>openjpa.Instrumentation</literal></link> configuration property.
@ -124,12 +124,12 @@
<para>
OpenJPA includes instruments for various caches, but you can also create your own instruments. To
create a custom instrument you need to implement the
<ulink url="../javadoc/org/apache/openjpa/lib/instrumentation/Instrument.html">
<ulink url="../../apidocs/org/apache/openjpa/lib/instrumentation/Instrument.html">
<classname>Instrument</classname></ulink> interface or more simply extend
<ulink url="../javadoc/org/apache/openjpa/lib/instrumentation/AbstractInstrument.html">
<ulink url="../../apidocs/org/apache/openjpa/lib/instrumentation/AbstractInstrument.html">
<classname>AbstractInstrument</classname></ulink>. If you are building a Platform MBean JMX-based
instrument this effort can be simplified by extending
<ulink url="../javadoc/org/apache/openjpa/instrumentation/jmx/JMXInstrument.html">
<ulink url="../../apidocs/org/apache/openjpa/instrumentation/jmx/JMXInstrument.html">
<classname>JMXInstrument</classname></ulink>. If you create your own custom
provider, class name aliases can be registered within the provider to simplify configuration. For example,
the instrument <classname>com.my.app.MySQLInstrument</classname> could be aliased as

2
openjpa-project/src/doc/manual/ref_guide_integration.xml
View File

@ -98,7 +98,7 @@ environment.
All OpenJPA tasks accept a nested <literal>config</literal> element, which
defines the configuration environment in which the specified task will run. The
attributes for the <literal>config</literal> tag are defined by the
<ulink url="../javadoc/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/conf/JDBCConfiguration.html">
<classname>JDBCConfiguration</classname></ulink> bean methods. Note that
excluding the <literal>config</literal> element will cause the Ant task to use
the default system configuration mechanism, such as the configuration defined in

2
openjpa-project/src/doc/manual/ref_guide_logging.xml
View File

@ -549,7 +549,7 @@ logging to a graphical component for GUI applications.
</para>
<para>
A custom logging framework must include an implementation of the
<ulink url="../javadoc/org/apache/openjpa/lib/log/LogFactory.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/lib/log/LogFactory.html"><classname>
org.apache.openjpa.lib.log.LogFactory</classname></ulink> interface. We present
a custom <classname>LogFactory</classname> below.
</para>

132
openjpa-project/src/doc/manual/ref_guide_mapping.xml
View File

@ -66,7 +66,7 @@ their corresponding database schema from your object model. OpenJPA supports
forward mapping through the <emphasis>mapping tool</emphasis>. The next section
presents several common mapping tool use cases. You can invoke the tool through
its Java class,
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/MappingTool"><classname>
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/MappingTool"><classname>
org.apache.openjpa.jdbc.meta.MappingTool</classname></ulink>.
</para>
<note>
@ -502,7 +502,7 @@ proper relations between the persistent classes it creates.
Run the reverse mapping tool on the finished schema file. If you do not supply
the schema file to reverse map, the tool will run directly against the schema in
the database. The tool can be run via its Java class,
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/ReverseMappingTool">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/ReverseMappingTool">
<classname>org.apache.openjpa.jdbc.meta.ReverseMappingTool</classname></ulink>.
</para>
<example id="ref_guide_pc_reverse_reversemappingtool">
@ -689,11 +689,11 @@ OpenJPA is examining.
<para>
<literal>-customizerClass/-cc &lt;class name&gt;</literal>: The full class name
of a
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/ReverseCustomizer.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/ReverseCustomizer.html">
<classname>org.apache.openjpa.jdbc.meta.ReverseCustomizer</classname></ulink>
customization plugin. If you do not specify a reverse customizer of your own,
the system defaults to a
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/PropertiesReverseCustomizer.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/PropertiesReverseCustomizer.html">
<classname>PropertiesReverseCustomizer</classname></ulink>. This customizer
allows you to specify simple customization options in the properties file given
with the <literal>-customizerProperties</literal> flag below. We present the
@ -753,7 +753,7 @@ Your persistent classes are now ready to access your existing schema.
<para>
The <classname>org.apache.openjpa.jdbc.meta.ReverseCustomizer</classname> plugin
interface allows you to customize the reverse mapping process. See the class
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/ReverseCustomizer.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/ReverseCustomizer.html">
Javadoc</ulink> for details on the hooks that this interface provides. Specify
the concrete plugin implementation to use with the <literal>
-customizerClass/-cc</literal> command-line flag, described in the preceding
@ -761,7 +761,7 @@ section.
</para>
<para>
By default, the reverse mapping tool uses a
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/PropertiesReverseCustomizer.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/PropertiesReverseCustomizer.html">
<classname>org.apache.openjpa.jdbc.meta.PropertiesReverseCustomizer</classname>
</ulink>. This customizer allows you to perform relatively simple
customizations through the properties file named with the <literal>
@ -996,7 +996,7 @@ database's tools to bring the schema up-to-date.
The previous sections showed how to use the mapping tool to generate default
mappings. But how does the mapping tool know what mappings to generate? The
answer lies in the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/MappingDefaults.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/MappingDefaults.html">
<classname>org.apache.openjpa.jdbc.meta.MappingDefaults</classname></ulink>
interface. OpenJPA uses an instance of this interface to decide how to name
tables and columns, where to put foreign keys, and generally how to create a
@ -1025,7 +1025,7 @@ OpenJPA includes the following standard implementations:
<para>
<literal>jpa</literal>: Provides defaults in compliance with the JPA standard.
This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/PersistenceMappingDefaults.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/PersistenceMappingDefaults.html">
<classname>org.apache.openjpa.persistence.jdbc.PersistenceMappingDefaults
</classname></ulink> class. This class extends the <classname>
MappingDefaultsImpl</classname> class described below, so it has all the same
@ -1045,7 +1045,7 @@ compatibility with older OpenJPA versions which did not prepend the field name.
<listitem>
<para>
<literal>default</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/MappingDefaultsImpl.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/MappingDefaultsImpl.html">
<classname>org.apache.openjpa.jdbc.meta.MappingDefaultsImpl</classname></ulink>
class. This default implementation is highly configurable. It has the following
properties:
@ -1079,7 +1079,7 @@ classes. You can specify a built-in strategy alias or the full class name of a
You can also use OpenJPA's plugin format (see
<xref linkend="ref_guide_conf_plugins"/>) to pass arguments to the
strategy instance. See the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<literal>org.apache.openjpa.jdbc.meta.strats</literal></ulink> package for
available strategies.
</para>
@ -1093,7 +1093,7 @@ You can also use OpenJPA's plugin format (see
<xref linkend="ref_guide_conf_plugins"/>) to pass arguments to the
strategy instance. Common strategies are <literal>vertical</literal> and
<literal>flat</literal>, the default. See the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<literal>org.apache.openjpa.jdbc.meta.strats</literal></ulink> package for all
available strategies.
</para>
@ -1108,7 +1108,7 @@ version strategy</link>. You can also use OpenJPA's plugin format (see
strategy instance. Common strategies are <literal>none</literal>, <literal>
state-comparison</literal>, <literal> timestamp</literal>, and <literal>
version-number</literal>, the default. See the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<literal>org.apache.openjpa.jdbc.meta.strats</literal></ulink> package for all
available strategies.
</para>
@ -1125,7 +1125,7 @@ strategy instance. Common strategies are <literal>final</literal> for a base
class without subclasses, <literal>none</literal> to use joins to subclass
tables rather than a discriminator column, and <literal> class-name</literal>,
the default. See the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<literal>org.apache.openjpa.jdbc.meta.strats</literal></ulink> package for all
available strategies.
</para>
@ -1379,7 +1379,7 @@ In a non-primary key join, at least one of the target columns is not a primary
key. Once again, OpenJPA supports this join type with the same syntax as a
primary key join. There is one restriction, however: each non-primary key column
you are joining to must be controlled by a field mapping that implements the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/Joinable.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/Joinable.html"><classname>
org.apache.openjpa.jdbc.meta.Joinable</classname></ulink> interface. All built
in basic mappings implement this interface, including basic fields of embedded
objects. OpenJPA will also respect any custom mappings that implement this
@ -1540,7 +1540,7 @@ to map entities using these strategies to the database.
<xref linkend="ref_guide_pc_oid"/> describes how to use datastore identity
in JPA. OpenJPA requires a single numeric primary key column to hold datastore
identity values. The
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/DataStoreIdColumn.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/DataStoreIdColumn.html">
<classname>org.apache.openjpa.persistence.jdbc.DataStoreIdColumn</classname>
</ulink> annotation customizes the datastore identity column. This annotation
has the following properties:
@ -1633,10 +1633,10 @@ public class LogEntry {
OpenJPA supports version fields as defined by the JPA specification, but allows
you to use a surrogate version column in place of a version field if you like.
You map the surrogate version column with the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/VersionColumn.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/VersionColumn.html">
<classname>org.apache.openjpa.persistence.jdbc.VersionColumn</classname></ulink>
annotation. You can also use the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/VersionColumns.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/VersionColumns.html">
<classname>org.apache.openjpa.persistence.jdbc.VersionColumns</classname>
</ulink> annotation to declare an array of <classname>VersionColumn</classname>
values. Each <classname>VersionColumn</classname> has the following properties:
@ -1774,7 +1774,7 @@ OpenJPA makes it easy to create multi-column
specification includes a <classname>Column</classname> annotation, but is
missing a way to declare multiple columns for a single field. OpenJPA remedies
this with the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Columns.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/Columns.html">
<classname>org.apache.openjpa.persistence.jdbc.Columns</classname></ulink>
annotation, which contains an array of <classname>Column</classname> values.
</para>
@ -1803,7 +1803,7 @@ OpenJPA rectifies this by allowing you to declare which <emphasis>attribute
</emphasis> in the related type each join column links to, rather than which
column. If the attribute is mapped differently in various subclass tables,
OpenJPA automatically forms the proper join for the subclass record at hand. The
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/XJoinColumn.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/XJoinColumn.html">
<classname>org.apache.openjpa.persistence.jdbc.XJoinColumn</classname></ulink>
annotation has all the same properties as the standard <classname>JoinColumn
</classname> annotation, but adds an additional <literal>
@ -1813,7 +1813,7 @@ referencedAttributeName</literal> property for this purpose. Simply use a
</para>
<para>
For compound keys, use the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/XJoinColumns.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/XJoinColumns.html">
<classname>org.apache.openjpa.persistence.jdbc.XJoinColumns</classname></ulink>
annotation. The value of this annotation is an array of individual <classname>
XJoinColumn</classname>s.
@ -1833,7 +1833,7 @@ a null embedded object and one with default values for all of its fields.
</para>
<para>
OpenJPA overcomes these shortcomings with the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/EmbeddedMapping.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/EmbeddedMapping.html">
<classname>org.apache.openjpa.persistence.jdbc.EmbeddedMapping</classname>
</ulink> annotation. This annotation has the following properties:
</para>
@ -1885,7 +1885,7 @@ allows you to override multiple mapped superclass mappings.
</para>
<para>
Each
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/MappingOverride.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/MappingOverride.html">
<classname>org.apache.openjpa.persistence.jdbc.MappingOverride</classname>
</ulink> annotation has the following properties:
</para>
@ -2004,7 +2004,7 @@ We explore the annotations below.
</indexterm>
<para>
The
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ContainerTable.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ContainerTable.html">
<classname>org.apache.openjpa.persistence.jdbc.ContainerTable</classname>
</ulink> annotation describes a database table that holds collection (or map)
elements. This annotation has the following properties:
@ -2075,11 +2075,11 @@ of the next sections.
Element join columns are equivalent to standard JPA join columns, except that
they represent a join to a collection or map element entity rather than a direct
relation. You represent an element join column with OpenJPA's
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementJoinColumn.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ElementJoinColumn.html">
<classname>org.apache.openjpa.persistence.jdbc.ElementJoinColumn</classname>
</ulink> annotation. To declare a compound join, enclose an array of <classname>
ElementJoinColumn</classname>s in the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementJoinColumns.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ElementJoinColumns.html">
<classname>org.apache.openjpa.persistence.jdbc.ElementJoinColumns</classname>
</ulink> annotation.
</para>
@ -2112,13 +2112,13 @@ Relational databases do not guarantee that records are returned in insertion
order. If you want to make sure that your collection elements are loaded in the
same order they were in when last stored, you must declare an order column. An
order column can be declared using OpenJPA's
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/OrderColumn">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/OrderColumn">
<classname>org.apache.openjpa.persistence.jdbc.OrderColumn</classname></ulink>
annotation or the JPA 2.0 <classname>javax.persistence.OrderColumn</classname>
annotation or <literal>order-column</literal> orm element as defined in
<xref linkend="jpa_overview_meta_xml"/>.
OpenJPA's
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/OrderColumn">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/OrderColumn">
<classname>org.apache.openjpa.persistence.jdbc.OrderColumn</classname></ulink>
annotation has the following properties:
</para>
@ -2274,11 +2274,11 @@ also use this annotation to represent a map table.
join columns described in
<xref linkend="ref_guide_mapping_jpa_coll_joincols"/> serve for
collection elements. OpenJPA's
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/KeyColumn.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/KeyColumn.html">
<classname>org.apache.openjpa.persistence.jdbc.KeyColumn</classname>
</ulink> annotation represents a map key. To map custom
multi-column keys, use the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/KeyColumns.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/KeyColumns.html">
<classname>org.apache.openjpa.persistence.jdbc.KeyColumns</classname>
</ulink> annotation, whose value is an array of <classname>KeyColumn</classname>s.
</para>
@ -2302,10 +2302,10 @@ also use this annotation to represent a map table.
Key join columns are equivalent to standard JPA
join columns, except that they represent a join to a map key entity rather than a direct relation. You represent
a key join column with OpenJPA's
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/KeyJoinColumn.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/KeyJoinColumn.html">
<classname>org.apache.openjpa.persistence.jdbc.KeyJoinColumn</classname></ulink> annotation. To declare a compound join, enclose an
array of <classname>KeyJoinColumn</classname>s in the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/KeyJoinColumns.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/KeyJoinColumns.html">
<classname>org.apache.openjpa.persistence.jdbc.KeyJoinColumns</classname>
</ulink> annotation.
</para>
@ -2328,7 +2328,7 @@ also use this annotation to represent a map table.
</indexterm>
<para>
The
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/KeyEmbeddedMapping.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/KeyEmbeddedMapping.html">
<classname>org.apache.openjpa.persistence.jdbc.KeyEmbeddedMapping</classname>
</ulink> annotation allows you to map your map field's embedded
key type to your container table. This annotation has exactly
@ -2420,13 +2420,13 @@ presented in the following sections.
</primary>
</indexterm>
<para>
The <ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Index.html">
The <ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/Index.html">
<classname>org.apache.openjpa.persistence.jdbc.Index</classname></ulink>
annotation represents an index on the columns of a field. It is also used within
the <link linkend="ref_guide_mapping_jpa_coll_table"><classname>ContainerTable
</classname></link> annotation to index join columns.
To index the columns of a collection element, use the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementIndex.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ElementIndex.html">
<classname> org.apache.openjpa.persistence.jdbc.ElementIndex</classname></ulink>
annotation. These annotations have the following properties:
</para>
@ -2470,14 +2470,14 @@ to false.
</primary>
</indexterm>
<para>
The <ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ForeignKey.html">
The <ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ForeignKey.html">
<classname>org.apache.openjpa.persistence.jdbc.ForeignKey</classname></ulink>
annotation represents a foreign key on the columns of a field. It is also used
within the <link linkend="ref_guide_mapping_jpa_coll_table"><classname>
ContainerTable</classname></link> annotation to set a database foreign key on
join columns. To set a constraint to the columns of a collection element, use
the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementForeignKey.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ElementForeignKey.html">
<classname> org.apache.openjpa.persistence.jdbc.ElementForeignKey</classname>
</ulink> annotation. These annotations have the following properties:
</para>
@ -2517,7 +2517,7 @@ does not manifest as a database foreign key constraint.
<listitem>
<para>
<literal>ForeignKeyAction deleteAction</literal>: Value from the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ForeignKeyAction.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ForeignKeyAction.html">
<classname>org.apache.openjpa.persistence.jdbc.ForeignKeyAction</classname>
</ulink> enum identifying the desired delete action. Defaults to <literal>
RESTRICT</literal>.
@ -2526,7 +2526,7 @@ RESTRICT</literal>.
<listitem>
<para>
<literal>ForeignKeyAction updateAction</literal>: Value from the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ForeignKeyAction.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ForeignKeyAction.html">
<classname>org.apache.openjpa.persistence.jdbc.ForeignKeyAction</classname>
</ulink> enum identifying the desired update action. Defaults to <literal>
RESTRICT</literal>.
@ -2561,7 +2561,7 @@ to discover existing foreign keys (see
</primary>
</indexterm>
<para>
The <ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Unique.html">
The <ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/Unique.html">
<classname>org.apache.openjpa.persistence.jdbc.Unique</classname></ulink>
annotation represents a unique constraint on the columns of a field. It is more
convenient than using the <literal>uniqueConstraints</literal> property of
@ -2986,7 +2986,7 @@ restrictions.
</para>
<para>
To persist a stream, apply the
<ulink url="../javadoc/org/apache/openjpa/persistence/Persistent.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/Persistent.html">
<classname>org.apache.openjpa.persistence.Persistent</classname></ulink>
annotation to either <classname>java.io.InputStream</classname> or
<classname>java.io.Reader</classname> field.
@ -3119,10 +3119,10 @@ OpenJPA recognizes the following class extensions.
This extension specifies how to eagerly fetch subclass state. It overrides the
global <link linkend="openjpa.jdbc.SubclassFetchMode"><literal>
openjpa.jdbc.SubclassFetchMode</literal></link> property. Set the OpenJPA
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/SubclassFetchMode.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/SubclassFetchMode.html">
<classname>org.apache.openjpa.persistence.jdbc.SubclassFetchMode</classname>
</ulink> annotation to a value from the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/FetchMode.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/FetchMode.html">
<classname>org.apache.openjpa.persistence.jdbc.FetchMode</classname>
</ulink> enum: <literal>JOIN</literal>, <literal>PARALLEL</literal>, or
<literal>NONE</literal>. See <xref linkend="ref_guide_perfpack_eager"/>
@ -3148,7 +3148,7 @@ openjpa.jdbc.SubclassFetchMode</literal></link> property. Set the OpenJPA
</seealso>
</indexterm>
<para>
The <ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Strategy.html">
The <ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/Strategy.html">
<classname>org.apache.openjpa.persistence.jdbc.Strategy</classname></ulink>
class annotation allows you to specify a custom mapping strategy for your class.
See <xref linkend="ref_guide_mapping_custom"/> for information on custom
@ -3175,7 +3175,7 @@ mappings.
</indexterm>
<para>
The
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/DiscriminatorStrategy.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/DiscriminatorStrategy.html">
<classname>org.apache.openjpa.persistence.jdbc.DiscriminatorStrategy</classname>
</ulink> class annotation allows you to specify a custom discriminator strategy.
See <xref linkend="ref_guide_mapping_custom"/> for information on custom
@ -3202,7 +3202,7 @@ mappings.
</indexterm>
<para>
The
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/VersionStrategy.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/VersionStrategy.html">
<classname>org.apache.openjpa.persistence.jdbc.VersionStrategy</classname>
</ulink> class annotation allows you to specify a custom version strategy. See
<xref linkend="ref_guide_mapping_custom"/> for information on custom
@ -3239,10 +3239,10 @@ OpenJPA recognizes the following field extensions.
This extension specifies how to eagerly fetch related objects. It overrides the
global <link linkend="openjpa.jdbc.EagerFetchMode"><literal>
openjpa.jdbc.EagerFetchMode</literal></link> property. Set the OpenJPA
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/EagerFetchMode.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/EagerFetchMode.html">
<classname>org.apache.openjpa.persistence.jdbc.EagerFetchMode</classname>
</ulink> annotation to a value from the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/FetchMode.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/FetchMode.html">
<classname>org.apache.openjpa.persistence.jdbc.FetchMode</classname>
</ulink> enum: <literal>JOIN</literal>, <literal>PARALLEL</literal>, or
<literal>NONE</literal>. See <xref linkend="ref_guide_perfpack_eager"/>
@ -3285,14 +3285,14 @@ OpenJPA defines the following extensions for nonpolymorphic values:
<itemizedlist>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Nonpolymorphic.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/Nonpolymorphic.html">
<classname>org.apache.openjpa.persistence.jdbc.Nonpolymorphic</classname>
</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementNonpolymorphic.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ElementNonpolymorphic.html">
<classname>org.apache.openjpa.persistence.jdbc.ElementNonpolymorphic</classname>
</ulink>
</para>
@ -3300,7 +3300,7 @@ OpenJPA defines the following extensions for nonpolymorphic values:
</itemizedlist>
<para>
The value of these extensions is a constant from the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/NonpolymorphicType.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/NonpolymorphicType.html">
<classname>org.apache.openjpa.persistence.jdbc.NonpolymorphicType</classname>
</ulink> enumeration. The default value, <literal>EXACT</literal>, indicates
that the relation will always be of the exact declared type. A value of
@ -3353,13 +3353,13 @@ array or collection element relations, respectively:
<itemizedlist>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ClassCriteria.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ClassCriteria.html">
<classname>org.apache.openjpa.persistence.jdbc.ClassCriteria</classname></ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementClassCriteria.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/ElementClassCriteria.html">
<classname>org.apache.openjpa.persistence.jdbc.ElementClassCriteria</classname>
</ulink>
</para>
@ -3386,7 +3386,7 @@ array or collection element relations, respectively:
</indexterm>
<para>
OpenJPA's
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Strategy.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/Strategy.html">
<classname>org.apache.openjpa.persistence.jdbc.Strategy</classname></ulink>
extension allows you to specify a custom mapping
strategy or value handler for a field. See
@ -3428,14 +3428,14 @@ strategies.
</title>
<para>
To create a custom class mapping, write an implementation of the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/ClassStrategy.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/ClassStrategy.html">
<classname>org.apache.openjpa.jdbc.meta.ClassStrategy</classname></ulink>
interface. You will probably want to extend one of the existing abstract or
concrete strategies in the <literal>org.apache.openjpa.jdbc.meta.strats
</literal> package.
</para>
<para>
The <ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Strategy.html">
The <ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/Strategy.html">
<classname>org.apache.openjpa.persistence.jdbc.Strategy</classname></ulink>
annotation allows you to declare a custom class mapping strategy in JPA mapping
metadata. Set the value of the annotation to the full class name of your custom
@ -3449,10 +3449,10 @@ OpenJPA's plugin syntax, detailed in <xref linkend="ref_guide_conf_plugins"/>.
</title>
<para>
To define a custom discriminator or version strategy, implement the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/DiscriminatorStrategy.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/DiscriminatorStrategy.html">
<classname>org.apache.openjpa.jdbc.meta.DiscriminatorStrategy</classname>
</ulink> or
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/VersionStrategy.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/VersionStrategy.html">
<classname>org.apache.openjpa.jdbc.meta.VersionStrategy</classname></ulink>
interface, respectively. You might extend one of the existing abstract or
concrete strategies in the <literal>org.apache.openjpa.jdbc.meta.strats
@ -3460,10 +3460,10 @@ concrete strategies in the <literal>org.apache.openjpa.jdbc.meta.strats
</para>
<para>
OpenJPA includes the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/DiscriminatorStrategy.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/DiscriminatorStrategy.html">
<classname>org.apache.openjpa.persistence.jdbc.DiscriminatorStrategy</classname>
</ulink> and
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/VersionStrategy.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/VersionStrategy.html">
<classname>org.apache.openjpa.persistence.jdbc.VersionStrategy</classname>
</ulink> class annotations for declaring a custom discriminator or version
strategy in JPA mapping metadata. Set the string value of these annotations to
@ -3513,7 +3513,7 @@ sections examine each.
Value handlers make it trivial to map any type that you can break down into one
or more simple values. All value handlers implement the <classname>
org.apache.openjpa.jdbc.meta.ValueHandler</classname> interface; see its
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/ValueHandler.html"> Javadoc
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/ValueHandler.html"> Javadoc
</ulink> for details. Also, examine the built-in handlers in the <filename>
src/openjpa/jdbc/meta/strats</filename> directory of your OpenJPA source
distribution. Use these functional implementations as examples when you
@ -3537,7 +3537,7 @@ create your own value handlers.
</indexterm>
<para>
OpenJPA interacts with persistent fields through the
<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/FieldStrategy"><classname>
<ulink url="../../apidocs/org/apache/openjpa/jdbc/meta/FieldStrategy"><classname>
org.apache.openjpa.jdbc.meta.FieldStrategy</classname></ulink> interface. You
can implement this interface yourself to create a custom field strategy, or
extend one of the existing abstract or concrete strategies in the <literal>
@ -3576,7 +3576,7 @@ defaults in detail.
Your other option is to explicitly install a custom value handler or strategy on
a particular field. To do so, specify the full name of your implementation class
in the proper mapping metadata extension. OpenJPA includes the
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Strategy.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/Strategy.html">
<classname>org.apache.openjpa.persistence.jdbc.Strategy</classname></ulink>
annotation. You can configure the named strategy or handler's bean
properties in these extensions using OpenJPA's plugin format (see
@ -3610,7 +3610,7 @@ openjpa.OrphanedKeyAction</literal></link> configuration property controls what
action to take when OpenJPA encounters an orphaned key. You can set this plugin
string (see <xref linkend="ref_guide_conf_plugins"/>) to a custom
implementation of the
<ulink url="../javadoc/org/apache/openjpa/event/OrphanedKeyAction.html">
<ulink url="../../apidocs/org/apache/openjpa/event/OrphanedKeyAction.html">
<classname> org.apache.openjpa.event.OrphanedKeyAction</classname></ulink>
interface, or use one of the built-in options:
</para>
@ -3619,7 +3619,7 @@ interface, or use one of the built-in options:
<para>
<literal>log</literal>: This is the default setting. This option logs a message
for each orphaned key. It is an alias for the
<ulink url="../javadoc/org/apache/openjpa/event/LogOrphanedKeyAction.html">
<ulink url="../../apidocs/org/apache/openjpa/event/LogOrphanedKeyAction.html">
<classname>org.apache.openjpa.event.LogOrphanedKeyAction</classname></ulink>
class, which has the following additional properties:
</para>
@ -3643,7 +3643,7 @@ openjpa.Runtime</literal>.
<literal>exception</literal>: Throw an <classname>
EntityNotFoundException</classname> when OpenJPA discovers an
orphaned key. This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/event/ExceptionOrphanedKeyAction.html">
<ulink url="../../apidocs/org/apache/openjpa/event/ExceptionOrphanedKeyAction.html">
<classname>org.apache.openjpa.event.ExceptionOrphanedKeyAction</classname>
</ulink> class.
</para>
@ -3651,7 +3651,7 @@ orphaned key. This is an alias for the
<listitem>
<para>
<literal>none</literal>: Ignore orphaned keys. This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/event/NoneOrphanedKeyAction.html">
<ulink url="../../apidocs/org/apache/openjpa/event/NoneOrphanedKeyAction.html">
<classname>org.apache.openjpa.event.NoneOrphanedKeyAction</classname></ulink>
class.
</para>

46
openjpa-project/src/doc/manual/ref_guide_meta.xml
View File

@ -45,7 +45,7 @@ The <link linkend="openjpa.MetaDataFactory"><literal>openjpa.MetaDataFactory
</literal></link> configuration property controls metadata loading and storing.
This property takes a plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) describing a concrete
<ulink url="../javadoc/org/apache/openjpa/meta/MetaDataFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/meta/MetaDataFactory.html">
<classname>org.apache.openjpa.meta.MetaDataFactory</classname></ulink>
implementation. A metadata factory can load mapping information as well as
persistence metadata, or it can leave mapping information to a separate
@ -57,7 +57,7 @@ following built-in metadata factories:
<listitem>
<para>
<literal>jpa</literal>: Standard JPA metadata. This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/persistence/PersistenceMetaDataFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/PersistenceMetaDataFactory.html">
<classname>
org.apache.openjpa.persistence.PersistenceMetaDataFactory</classname></ulink>.
</para>
@ -220,7 +220,7 @@ JPA defines <literal>Basic</literal>, <literal>Lob</literal>, <literal>Embedded
</literal>, <literal>ManyToOne</literal>, and <literal>OneToOne</literal>
persistence strategies for direct field values. OpenJPA supports all of these
standard strategies, but adds one of its own: <literal>Persistent</literal>.
The <ulink url="../javadoc/org/apache/openjpa/persistence/Persistent.html">
The <ulink url="../../apidocs/org/apache/openjpa/persistence/Persistent.html">
<classname>org.apache.openjpa.persistence.Persistent</classname></ulink>
metadata annotation can represent any direct field value, including custom
types. It has the following properties:
@ -286,7 +286,7 @@ JPA standardizes support for collections of entities with the <literal>
OneToMany</literal> and <literal>ManyToMany</literal> persistence strategies.
OpenJPA supports these strategies, and may be extended for other strategies as
well. For extended strategies, use the
<ulink url="../javadoc/org/apache/openjpa/persistence/PersistentCollection.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/PersistentCollection.html">
<classname>org.apache.openjpa.persistence.PersistentCollection</classname></ulink> metadata
annotation to represents any persistent collection field. It has the following
properties:
@ -342,7 +342,7 @@ ManyToMany</classname></link>. Defaults to empty array.
<para>
JPA has limited support for maps. If you extend JPA's standard map support to
encompass new mappings, use the
<ulink url="../javadoc/org/apache/openjpa/persistence/PersistentMap.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/PersistentMap.html">
<classname>org.apache.openjpa.persistence.PersistentMap</classname></ulink> metadata
annotation to represent your custom persistent map fields. It has the
following properties:
@ -448,9 +448,9 @@ OpenJPA recognizes the following class extensions:
</seealso>
</indexterm>
<para>
The <ulink url="../javadoc/org/apache/openjpa/persistence/FetchGroups.html">
The <ulink url="../../apidocs/org/apache/openjpa/persistence/FetchGroups.html">
<classname>org.apache.openjpa.persistence.FetchGroups</classname></ulink> and
<ulink url="../javadoc/org/apache/openjpa/persistence/FetchGroup.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/FetchGroup.html">
<classname>org.apache.openjpa.persistence.FetchGroup</classname></ulink>
annotations allow you to define fetch groups in your JPA entities.
<xref linkend="ref_guide_fetch"/> discusses OpenJPA's support for fetch
@ -482,7 +482,7 @@ extensions allow individual classes to override system caching defaults.
</para>
<para>
OpenJPA defines the
<ulink url="../javadoc/org/apache/openjpa/persistence/DataCache.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/DataCache.html">
<classname>org.apache.openjpa.persistence.DataCache</classname></ulink>
annotation for caching information. This annotation has the following
properties:
@ -536,7 +536,7 @@ modifications.
</para>
<para>
OpenJPA defines the
<ulink url="../javadoc/org/apache/openjpa/persistence/DetachedState.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/DetachedState.html">
<classname>org.apache.openjpa.persistence.DetachedState</classname></ulink>
annotation for controlling detached state. When used to annotate a class,
<classname>DetachedState</classname> recognizes the following properties:
@ -611,21 +611,21 @@ JPA entities:
<itemizedlist>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/Dependent.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/Dependent.html">
<classname> org.apache.openjpa.persistence.Dependent</classname></ulink>: Marks
a direct relation as dependent.
</para>
</listitem>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/ElementDependent.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/ElementDependent.html">
<classname> org.apache.openjpa.persistence.ElementDependent</classname></ulink>
: Marks the entity elements of a collection, array, or map field as dependent.
</para>
</listitem>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/KeyDependent.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/KeyDependent.html">
<classname> org.apache.openjpa.persistence.KeyDependent</classname></ulink>:
Marks the key entities in a map field as dependent.
</para>
@ -656,7 +656,7 @@ Marks the key entities in a map field as dependent.
</secondary>
</indexterm>
<para>
The <ulink url="../javadoc/org/apache/openjpa/persistence/LoadFetchGroup.html">
The <ulink url="../../apidocs/org/apache/openjpa/persistence/LoadFetchGroup.html">
<classname>org.apache.openjpa.persistence.LoadFetchGroup</classname></ulink>
annotation specifies a field's load fetch group.
<xref linkend="ref_guide_fetch"/> discusses OpenJPA's support for fetch groups
@ -684,7 +684,7 @@ annotation in particular.
</indexterm>
<para>
This boolean extension, denoted by the OpenJPA
<ulink url="../javadoc/org/apache/openjpa/persistence/LRS.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/persistence/LRS.html"><classname>
org.apache.openjpa.persistence.LRS</classname></ulink> annotation,
indicates that a field should use OpenJPA's special large result set collection
or map proxies. A complete description of large result set proxies is available
@ -712,7 +712,7 @@ in <xref linkend="ref_guide_pc_scos_proxy_lrs"/>.
<para>
This extension names the inverse field in a logical bidirectional relation.
To create a logical bidirectional relation in OpenJPA, use the
<ulink url="../javadoc/org/apache/openjpa/persistence/InverseLogical.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/InverseLogical.html">
<classname>org.apache.openjpa.persistence.InverseLogical</classname></ulink>
annotation. We discuss logical bidirectional relations and this
extension in detail in <xref linkend="ref_guide_inverses"/>.
@ -750,10 +750,10 @@ existing persistent objects; new object fields are always writeable.
</para>
<para>
To mark a field read-only in JPA metadata, set the
<ulink url="../javadoc/org/apache/openjpa/persistence/ReadOnly.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/ReadOnly.html">
<classname>org.apache.openjpa.persistence.ReadOnly</classname></ulink>
annotation to an
<ulink url="../javadoc/org/apache/openjpa/persistence/UpdateAction.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/UpdateAction.html">
<classname>org.apache.openjpa.persistence.UpdateAction</classname></ulink> enum
value. The <classname>UpdateAction</classname> enum includes:
</para>
@ -851,19 +851,19 @@ array, and map elements, and map keys, respectively:
<itemizedlist>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/Type.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/persistence/Type.html"><classname>
org.apache.openjpa.persistence.Type</classname></ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/ElementType.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/ElementType.html">
<classname>org.apache.openjpa.persistence.ElementType</classname></ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/KeyType.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/persistence/KeyType.html"><classname>
org.apache.openjpa.persistence.KeyType</classname></ulink>
</para>
</listitem>
@ -889,7 +889,7 @@ org.apache.openjpa.persistence.KeyType</classname></ulink>
</indexterm>
<para>
The OpenJPA
<ulink url="../javadoc/org/apache/openjpa/persistence/Externalizer.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/Externalizer.html">
<classname>org.apache.openjpa.persistence.Externalizer</classname></ulink>
annotation names a method to transform a field value into a value of
another type. See <xref linkend="ref_guide_pc_extern"/> for details.
@ -915,7 +915,7 @@ another type. See <xref linkend="ref_guide_pc_extern"/> for details.
</indexterm>
<para>
The OpenJPA
<ulink url="../javadoc/org/apache/openjpa/persistence/Factory.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/persistence/Factory.html"><classname>
org.apache.openjpa.persistence.Factory</classname></ulink> annotation
names a method to re-create a field value from its externalized form. See
<xref linkend="ref_guide_pc_extern"/> for details.
@ -941,7 +941,7 @@ names a method to re-create a field value from its externalized form. See
</indexterm>
<para>
The OpenJPA
<ulink url="../javadoc/org/apache/openjpa/persistence/ExternalValues.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/ExternalValues.html">
<classname>org.apache.openjpa.persistence.ExternalValues</classname></ulink>
annotation declares values for transformation of simple fields to
different constant values in the datastore. See

4
openjpa-project/src/doc/manual/ref_guide_optimization.xml
View File

@ -159,7 +159,7 @@ features in a transaction that will delete, modify, or create a very large
number of objects you can set <literal>LargeTransaction</literal> to true and
perform periodic flushes during your transaction to reduce its memory
requirements. See the Javadoc:
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
OpenJPAEntityManager.setTrackChangesByType</ulink>. Note that transactions in
large mode have to more aggressively flush items from the data cache.
<para>
@ -168,7 +168,7 @@ accessed by other transactions, for example an exhaustive report run only once a
month, you can turn off population of the data cache so that the transaction
doesn't fill the entire data cache with objects that won't be accessed again.
Again, see the Javadoc:
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
OpenJPAEntityManager.setPopulateDataCache</ulink>
</para>
</entry>

40
openjpa-project/src/doc/manual/ref_guide_pc.xml
View File

@ -629,7 +629,7 @@ persistent objects for you through a surrogate key in the database.
<para>
You can control how your JPA datastore identity value is generated through
OpenJPA's
<ulink url="../javadoc/org/apache/openjpa/persistence/DataStoreId.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/DataStoreId.html">
<classname>org.apache.openjpa.persistence.DataStoreId</classname></ulink> class
annotation. This annotation has <literal>strategy</literal> and <literal>
generator</literal> properties that mirror the same-named properties on the
@ -659,7 +659,7 @@ public class LineItem {
</example>
<para>
Internally, OpenJPA uses the public
<ulink url="../javadoc/org/apache/openjpa/util/Id.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/util/Id.html"><classname>
org.apache.openjpa.util.Id</classname></ulink> class for datastore identity
objects. When writing OpenJPA plugins, you can manipulate datastore identity
objects by casting them to this class. You can also create your own <classname>
@ -882,7 +882,7 @@ class code, you can set the <literal>@IdClass</literal> annotation.
</para>
<para>
The application identity tool can be invoked via its Java class,
<ulink url="../javadoc/org/apache/openjpa/enhance/ApplicationIdTool">
<ulink url="../../apidocs/org/apache/openjpa/enhance/ApplicationIdTool">
<classname>org.apache.openjpa.enhance.ApplicationIdTool</classname></ulink>.
</para>
<note>
@ -1056,7 +1056,7 @@ relations that also share datastore storage in JPA.
</para>
<para>
OpenJPA also allows you to define purely logical bidirectional relations. The
<ulink url="../javadoc/org/apache/openjpa/persistence/InverseLogical.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/InverseLogical.html">
<classname>org.apache.openjpa.persistence.InverseLogical</classname></ulink>
annotation names a logical inverse in JPA metadata.
</para>
@ -1388,7 +1388,7 @@ collection and map methods, and to update the field's database record on commit.
</para>
<para>
In order to use large result set proxies in JPA, add the
<ulink url="../javadoc/org/apache/openjpa/persistence/LRS.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/persistence/LRS.html"><classname>
org.apache.openjpa.persistence.LRS</classname></ulink> annotation to the
persistent field.
</para>
@ -1463,7 +1463,7 @@ public class Company {
</indexterm>
<para>
OpenJPA manages proxies through the
<ulink url="../javadoc/org/apache/openjpa/util/ProxyManager.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/util/ProxyManager.html"><classname>
org.apache.openjpa.util.ProxyManager</classname></ulink> interface. OpenJPA
includes a default proxy manager, the <classname>
org.apache.openjpa.util.ProxyManagerImpl</classname> (with a plugin alias name
@ -1494,7 +1494,7 @@ improve performance of some applications by allowing them to perform simple add
operations on collections without requiring them to be loaded. Delayed proxies are
loaded when an operation is performed that requires loading, such
as iteration, size, serialization, and indexOf. They can also be loaded by casting the
proxy to a <ulink url="../javadoc/org/apache/openjpa/util/DelayedProxy.html"><classname>
proxy to a <ulink url="../../apidocs/org/apache/openjpa/util/DelayedProxy.html"><classname>
org.apache.openjpa.util.DelayedProxy</classname></ulink> and invoking the
<methodname>load</methodname> method. If a broker factory is available after detaching the owning
entity, a collection may be available for delayed loading after the persistence context has been
@ -1539,7 +1539,7 @@ each of B's setters with the value from the corresponding getter on A.
If you have custom classes that must be proxied and do not meet these
requirements, OpenJPA allows you to define your own proxy classes and
your own proxy manager. See the <literal>openjpa.util</literal> package
<ulink url="../javadoc/">Javadoc</ulink> for details on the interfaces involved,
<ulink url="../../apidocs/">Javadoc</ulink> for details on the interfaces involved,
and the utility classes OpenJPA provides to assist you.
</para>
<para>
@ -1651,14 +1651,14 @@ JPA cannot have externalizers.
</note>
<para>
The OpenJPA
<ulink url="../javadoc/org/apache/openjpa/persistence/Externalizer.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/Externalizer.html">
<classname>org.apache.openjpa.persistence.Externalizer</classname></ulink>
annotation sets the name of a method that will be invoked to convert
the field into its external form for database storage. You can specify either
the name of a non-static method, which will be invoked on the field value, or a
static method, which will be invoked with the field value as a parameter. Each
method can also take an optional
<ulink url="../javadoc/org/apache/openjpa/kernel/StoreContext.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/kernel/StoreContext.html"><classname>
StoreContext</classname></ulink> parameter for access to a persistence context.
The return value of the method is the field's external form. By default, OpenJPA
assumes that all named methods belong to the field value's class (or its
@ -1743,13 +1743,13 @@ public static String AnyClass.toString(CustomType ct, StoreContext ctx)
</table>
<para>
The OpenJPA
<ulink url="../javadoc/org/apache/openjpa/persistence/Factory.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/persistence/Factory.html"><classname>
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 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>
<ulink url="../../apidocs/org/apache/openjpa/kernel/StoreContext.html"><classname>
StoreContext</classname></ulink> parameter for access to a persistence context.
If a factory is not specified, OpenJPA will use the constructor of the field
type that takes a single argument of the external type, or will throw an
@ -1851,7 +1851,7 @@ If your custom field type is mutable and is not a standard collection, map, or
date class, OpenJPA will not be able to detect changes to the field. You must
mark the field dirty manually, or create a custom field proxy.
See
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<methodname>OpenJPAEntityManager.dirty</methodname></ulink> for how to mark a
field dirty manually in JPA.
See <xref linkend="ref_guide_pc_scos_proxy"/> for a discussion of proxies.
@ -1983,7 +1983,7 @@ primitive wrappers, and Strings), to other pre-defined simple values.
</para>
<para>
Use the OpenJPA
<ulink url="../javadoc/org/apache/openjpa/persistence/ExternalValues.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/ExternalValues.html">
<classname>org.apache.openjpa.persistence.ExternalValues</classname></ulink>
annotation to define external value translations. The values are
defined in a format similar to that of <link linkend="ref_guide_conf_plugins">
@ -1995,7 +1995,7 @@ true=T,false=F</literal>.
</para>
<para>
If the type of the datastore value is different from the field's type, use the
<ulink url="../javadoc/org/apache/openjpa/persistence/Type.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/Type.html">
<classname>org.apache.openjpa.persistence.Type</classname></ulink> annotation
to define the datastore type.
</para>
@ -2057,11 +2057,11 @@ active fetch groups when loading objects from the datastore.
</para>
<para>
You create fetch groups with the
<ulink url="../javadoc/org/apache/openjpa/persistence/FetchGroup.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/FetchGroup.html">
<classname>org.apache.openjpa.persistence.FetchGroup</classname></ulink>
annotation. If your class only has one custom fetch group, you can place this
annotation directly on the class declaration. Otherwise, use the
<ulink url="../javadoc/org/apache/openjpa/persistence/FetchGroups.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/FetchGroups.html">
<classname>org.apache.openjpa.persistence.FetchGroups</classname></ulink>
annotation to declare an array of individual <classname>FetchGroup</classname>
values. The <classname>FetchGroup</classname> annotation has the following
@ -2100,7 +2100,7 @@ include in this group.
</itemizedlist>
<para>
As you might expect, listing a
<ulink url="../javadoc/org/apache/openjpa/persistence/FetchAttribute.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/FetchAttribute.html">
<classname>org.apache.openjpa.persistence.FetchAttribute</classname></ulink>
within a <classname>FetchGroup</classname> includes the corresponding persistent
field or property in the fetch group. Each <classname>FetchAttribute</classname>
@ -2166,7 +2166,7 @@ accessed.
</para>
<para>
Use OpenJPA's
<ulink url="../javadoc/org/apache/openjpa/persistence/LoadFetchGroup.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/LoadFetchGroup.html">
<classname>org.apache.openjpa.persistence.LoadFetchGroup</classname></ulink>
annotation to specify the load fetch group of any persistent field. The value of
the annotation is the name of a declared fetch group whose members should be
@ -2244,7 +2244,7 @@ the fetch depth to something less than the configured maximum.
OpenJPA's <classname>OpenJPAEntityManager</classname> and <classname>
OpenJPAQuery</classname> extensions to the standard <classname>EntityManager
</classname> and <classname>Query</classname> interfaces provide access to a
<ulink url="../javadoc/org/apache/openjpa/persistence/FetchPlan.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/FetchPlan.html">
<classname>org.apache.openjpa.persistence.FetchPlan</classname></ulink> object.
The <classname>FetchPlan</classname> maintains the set of active fetch groups
and the maximum fetch depth. It begins with the groups and depth defined in the

10
openjpa-project/src/doc/manual/ref_guide_remote.xml
View File

@ -108,7 +108,7 @@ the following javax.persistence.EntityManager method:
public void detach(Object)
</programlisting>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>OpenJPAEntityManager</classname></ulink>, however, provides
additional detach methods.
</para>
@ -400,7 +400,7 @@ all <literal>Large Result Sets</literal> will be removed.
<para>
You can also alter the set of fields that will be included in the detached graph
at runtime.
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>OpenJPAEntityManager</classname></ulink>s expose the following APIs
for controlling detached state:
</para>
@ -521,7 +521,7 @@ To enable remote events, you must configure the <classname> EntityManagerFactory
<para>
When a <literal>RemoteCommitProvider</literal> is properly configured, you can
register
<ulink url="../javadoc/org/apache/openjpa/event/RemoteCommitListener.html">
<ulink url="../../apidocs/org/apache/openjpa/event/RemoteCommitListener.html">
<classname>RemoteCommitListener</classname></ulink>s that will be alerted with
a list of modified object ids whenever a transaction on a remote machine
successfully commits.
@ -784,10 +784,10 @@ provider, we modify the previous example as follows:
<para>
You can develop additional mechanisms for remote event notification be by
creating an implementation of the
<ulink url="../javadoc/org/apache/openjpa/event/RemoteCommitProvider.html">
<ulink url="../../apidocs/org/apache/openjpa/event/RemoteCommitProvider.html">
<classname> RemoteCommitProvider</classname></ulink> interface, possibly by
extending the
<ulink url="../javadoc/org/apache/openjpa/event/AbstractRemoteCommitProvider.html">
<ulink url="../../apidocs/org/apache/openjpa/event/AbstractRemoteCommitProvider.html">
<classname>AbstractRemoteCommitProvider</classname></ulink> abstract class..
</para>
</section>

82
openjpa-project/src/doc/manual/ref_guide_runtime.xml
View File

@ -171,7 +171,7 @@ Defaults to <literal>false</literal>.
</example>
<para>
Additionally, some advanced users may want to add capabilities to OpenJPA's
internal <ulink url="../javadoc/org/apache/openjpa/kernel/BrokerImpl.html">
internal <ulink url="../../apidocs/org/apache/openjpa/kernel/BrokerImpl.html">
<classname>org.apache.openjpa.kernel.BrokerImpl</classname></ulink>. You can
configure OpenJPA to use a custom subclass of <classname>BrokerImpl</classname>
with the <link linkend="openjpa.BrokerImpl"><literal>openjpa.BrokerImpl
@ -180,9 +180,9 @@ name of your custom subclass. When implementing your subclass, consider the
finalization issues mentioned in
<xref linkend="ref_guide_runtime_broker_finalization"/>. It may be appropriate
to create a subtype of both
<ulink url="../javadoc/org/apache/openjpa/kernel/BrokerImpl.html">
<ulink url="../../apidocs/org/apache/openjpa/kernel/BrokerImpl.html">
<classname>org.apache.openjpa.kernel.BrokerImpl</classname></ulink> and
<ulink url="../javadoc/org/apache/openjpa/kernel/FinalizingBrokerImpl.html">
<ulink url="../../apidocs/org/apache/openjpa/kernel/FinalizingBrokerImpl.html">
<classname>org.apache.openjpa.kernel.FinalizingBrokerImpl</classname></ulink>.
</para>
</section>
@ -244,7 +244,7 @@ javax.persistence.EntityManagerFactory</classname> with OpenJPA-specific
features. The <classname>OpenJPAEntityManagerFactory</classname> offers APIs to
access the OpenJPA data and query caches and to perform other OpenJPA-specific
operations. See the
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManagerFactory.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManagerFactory.html">
interface Javadoc</ulink> for details.
</para>
</section>
@ -270,7 +270,7 @@ interface Javadoc</ulink> for details.
</indexterm>
<para>
All OpenJPA <classname>EntityManager</classname>s implement the
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>org.apache.openjpa.persistence.OpenJPAEntityManager</classname>
</ulink> interface. This interface extends the standard <classname>
javax.persistence.EntityManager</classname>. Just as the standard <classname>
@ -303,7 +303,7 @@ extensions this interface contains.
<para>
OpenJPA extends JPA's standard query functionality with the <classname>
org.apache.openjpa.persistence.OpenJPAQuery</classname> interface. See its
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAQuery.html">Javadoc
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAQuery.html">Javadoc
</ulink> for details on the convenience methods it provides.
</para>
</section>
@ -330,7 +330,7 @@ org.apache.openjpa.persistence.OpenJPAQuery</classname> interface. See its
<para>
An <classname>Extent</classname> is a logical view of all persistent instances
of a given entity class, possibly including subclasses. OpenJPA adds the
<ulink url="../javadoc/org/apache/openjpa/persistence/Extent.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/persistence/Extent.html"><classname>
org.apache.openjpa.persistence.Extent</classname></ulink> class to the set of
Java Persistence APIs. The following code illustrates iterating over all
instances of the <classname>Magazine</classname> entity, without subclasses:
@ -365,7 +365,7 @@ In addition to the <classname>EntityManager</classname> object cache the JPA
specification provides access to a second level cache via the
javax.persistence.Cache interface. OpenJPA provides further extensions via
the org.apache.openjpa.persistence.StoreCache interface documented at
<ulink url="../javadoc/org/apache/openjpa/persistence/StoreCache.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/StoreCache.html">
<classname>org.apache.openjpa.persistence.StoreCache</classname></ulink>.
<xref linkend="ref_guide_cache"/> has detailed information on OpenJPA's
data caching system, including the <classname>StoreCache</classname> facade.
@ -382,7 +382,7 @@ data caching system, including the <classname>StoreCache</classname> facade.
</indexterm>
<para>
OpenJPA can cache query results as well as persistent object data. The
<ulink url="../javadoc/org/apache/openjpa/persistence/QueryResultCache.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/QueryResultCache.html">
<classname>org.apache.openjpa.persistence.QueryResultCache</classname></ulink>
is an JPA-flavored facade to OpenJPA's internal query cache. See
<xref linkend="ref_guide_cache_query"/> for details on query caching in
@ -416,7 +416,7 @@ groups</link>, and <link linkend="ref_guide_locking">lock levels</link>.
</para>
<para>
OpenJPA goes one step further, extending <classname>FetchPlan</classname> with
<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/JDBCFetchPlan.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/jdbc/JDBCFetchPlan.html">
<classname>org.apache.openjpa.persistence.jdbc.JDBCFetchPlan</classname></ulink>
to add additional JDBC-specific tuning methods. Unless you have customized
OpenJPA to use a non-relational back-end (see
@ -452,7 +452,7 @@ FetchPlan</classname>s.
</primary>
</indexterm>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityTransaction.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityTransaction.html">
<classname>org.apache.openjpa.persistence.OpenJPAEntityTransaction</classname></ulink>
extends <classname>javax.persistence.EntityTransaction</classname> to provide
additional transaction-debugging capabilities and some concurrency-related
@ -469,7 +469,7 @@ commit and rollback features.
</primary>
</indexterm>
<para>
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAPersistence.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAPersistence.html">
<classname>org.apache.openjpa.persistence.OpenJPAPersistence</classname></ulink>
is a static helper class that adds OpenJPA-specific utility methods to
<classname>javax.persistence.Persistence</classname>.
@ -661,7 +661,7 @@ In addition to the standard
<ulink url="http://download.oracle.com/javaee/6/api/javax/persistence/EntityManager.html">
<methodname>EntityManager.lock(Object, LockModeType)</methodname></ulink>
method, the
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>OpenJPAEntityManager</classname></ulink> exposes the following
methods to lock objects explicitly:
</para>
@ -722,7 +722,7 @@ oem.getTransaction().commit();
</primary>
</indexterm>
OpenJPA delegates the actual work of locking objects to the system's
<ulink url="../javadoc/org/apache/openjpa/kernel/LockManager.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/kernel/LockManager.html"><classname>
org.apache.openjpa.kernel.LockManager</classname></ulink>. This plugin is
controlled by the <link linkend="openjpa.LockManager"><literal>
openjpa.LockManager</literal></link> configuration property. You can write your
@ -732,7 +732,7 @@ own lock manager, or use one of the bundled options:
<listitem>
<para>
<literal>mixed</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/MixedLockManager.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/MixedLockManager.html">
<classname>org.apache.openjpa.jdbc.kernel.MixedLockManager</classname>
</ulink>, which implements the JPA 2.0 specification entity locking behaviors.
It combines both the optimistic and pessimistic semantics controlled by
@ -753,7 +753,7 @@ This is the default <literal>openjpa.LockManager</literal> setting in OpenJPA.
<para>
<literal>pessimistic</literal>: This is an alias for the
<ulink
url="../javadoc/org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html">
url="../../apidocs/org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html">
<classname>org.apache.openjpa.jdbc.kernel.PessimisticLockManager</classname>
</ulink>, which
uses SELECT FOR UPDATE statements (or the database's equivalent) to lock the
@ -775,7 +775,7 @@ properties:
<listitem>
<para>
<literal>version</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/kernel/VersionLockManager.html">
<ulink url="../../apidocs/org/apache/openjpa/kernel/VersionLockManager.html">
<classname>org.apache.openjpa.kernel.VersionLockManager</classname></ulink>.
This lock manager does not perform any exclusive locking, but instead ensures
read consistency by verifying that the version of all read-locked instances is
@ -788,7 +788,7 @@ behavior.
<listitem>
<para>
<literal>none</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/kernel/NoneLockManager.html">
<ulink url="../../apidocs/org/apache/openjpa/kernel/NoneLockManager.html">
<classname>org.apache.openjpa.kernel.NoneLockManager</classname></ulink>, which
does not perform any locking at all.
</para>
@ -983,7 +983,7 @@ changes. This chapter describes how to use and configure OpenJPA savepoints.
</title>
<para>
OpenJPA's
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>OpenJPAEntityManager</classname></ulink> have the following
methods to control savepoint behavior. Note that the savepoints work in tandem
with the current transaction. This means that savepoints require an open
@ -1063,7 +1063,7 @@ oem.getTransaction().commit();
</title>
<para>
OpenJPA uses the
<ulink url="../javadoc/org/apache/openjpa/kernel/SavepointManager">
<ulink url="../../apidocs/org/apache/openjpa/kernel/SavepointManager">
<classname>org.apache.openjpa.kernel.SavepointManager</classname></ulink>
<link linkend="ref_guide_conf_plugins">plugin</link> to handle preserving the
savepoint state. OpenJPA includes the following <classname>SavepointManager
@ -1073,7 +1073,7 @@ savepoint state. OpenJPA includes the following <classname>SavepointManager
<listitem>
<para>
<literal>in-mem</literal>: The default. This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/kernel/InMemorySavepointManager.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/kernel/InMemorySavepointManager.html"><classname>
org.apache.openjpa.kernel.InMemorySavepointManager</classname></ulink>. This
plugin stores all state, including field values, in memory. Due to this
behavior, each set savepoint is designed for small to medium transactional
@ -1083,7 +1083,7 @@ object counts.
<listitem>
<para>
<literal>jdbc</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/JDBC3SavepointManager.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/JDBC3SavepointManager.html"><classname>
org.apache.openjpa.jdbc.kernel.JDBC3SavepointManager</classname></ulink>. This
plugin requires <literal>JDBC 3</literal> and <classname> java.sql.Savepoint
</classname> support to operate. Note that this plugin implements savepoints by
@ -1244,7 +1244,7 @@ select p from Product p where p.price &lt; ext:sql ('(SELECT AVG(PRICE) FROM PRO
</indexterm>
<para>
You can write your own extensions by implementing the
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html">
<classname>org.apache.openjpa.jdbc.kernel.exps.JDBCFilterListener</classname>
</ulink> interface. View the Javadoc documentation for details. Additionally,
the source for all of OpenJPA's built-in query extensions is included in your
@ -1293,7 +1293,7 @@ registration for very specific extensions that do not apply globally.
</para>
<para>
See the <classname>OpenJPAQuery</classname>
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAQuery.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAQuery.html">
Javadoc</ulink> for details.
</para>
</listitem>
@ -1315,7 +1315,7 @@ Javadoc</ulink> for details.
<para>
Just as you can write your own filter methods, you can write your own query
aggregates by implementing the
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/exps/JDBCAggregateListener.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/exps/JDBCAggregateListener.html">
<classname>org.apache.openjpa.jdbc.kernel.exps.JDBCAggregateListener</classname>
</ulink> interface. View the Javadoc documentation for details. When using your
custom aggregates in result or having query clauses, you can optionally prefix
@ -1361,7 +1361,7 @@ registration for very specific aggregates that do not apply globally.
</para>
<para>
See the <classname>OpenJPAQuery</classname>
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAQuery.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAQuery.html">
Javadoc</ulink> for details.
</para>
</listitem>
@ -1432,7 +1432,7 @@ import org.apache.openjpa.persistence.*;
For datastore queries, the method must have the following signature:
</para>
<programlisting>
public static <ulink url="../javadoc/org/apache/openjpa/lib/rop/ResultObjectProvider.html">ResultObjectProvider</ulink> xxx(<ulink url="../javadoc/org/apache/openjpa/kernel/StoreContext.html">StoreContext</ulink> ctx, <ulink url="../javadoc/org/apache/openjpa/meta/ClassMetaData.html">ClassMetaData</ulink> meta, boolean subclasses, Map params, <ulink url="../javadoc/org/apache/openjpa/kernel/FetchConfiguration.html">FetchConfiguration </ulink> fetch)
public static <ulink url="../../apidocs/org/apache/openjpa/lib/rop/ResultObjectProvider.html">ResultObjectProvider</ulink> xxx(<ulink url="../javadoc/org/apache/openjpa/kernel/StoreContext.html">StoreContext</ulink> ctx, <ulink url="../javadoc/org/apache/openjpa/meta/ClassMetaData.html">ClassMetaData</ulink> meta, boolean subclasses, Map params, <ulink url="../javadoc/org/apache/openjpa/kernel/FetchConfiguration.html">FetchConfiguration </ulink> fetch)
</programlisting>
<para>
The returned result object provider should produce objects of the candidate
@ -1446,7 +1446,7 @@ In-memory execution is slightly different, taking in one object at a time and
returning a boolean on whether the object matches the query:
</para>
<programlisting>
public static boolean xxx(<ulink url="../javadoc/org/apache/openjpa/kernel/StoreContext.html">StoreContext</ulink> ctx, <ulink url="../javadoc/org/apache/openjpa/meta/ClassMetaData.html">ClassMetaData</ulink> meta, boolean subclasses, Object obj, Map params, <ulink url="../javadoc/org/apache/openjpa/kernel/FetchConfiguration.html">FetchConfiguration</ulink> fetch)
public static boolean xxx(<ulink url="../../apidocs/org/apache/openjpa/kernel/StoreContext.html">StoreContext</ulink> ctx, <ulink url="../javadoc/org/apache/openjpa/meta/ClassMetaData.html">ClassMetaData</ulink> meta, boolean subclasses, Object obj, Map params, <ulink url="../javadoc/org/apache/openjpa/kernel/FetchConfiguration.html">FetchConfiguration</ulink> fetch)
</programlisting>
<para>
In both method versions, the given <literal>params</literal> map contains the
@ -1474,12 +1474,12 @@ generators to automatically populate identity fields in JPA.
</para>
<para>
OpenJPA represents all generators internally with the
<ulink url="../javadoc/org/apache/openjpa/kernel/Seq.html"><classname>
<ulink url="../../apidocs/org/apache/openjpa/kernel/Seq.html"><classname>
org.apache.openjpa.kernel.Seq</classname></ulink> interface. This interface
supplies all the context you need to create your own custom generators,
including the current persistence environment, the JDBC <classname>DataSource
</classname>, and other essentials. The
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/AbstractJDBCSeq.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/AbstractJDBCSeq.html">
<classname>org.apache.openjpa.jdbc.kernel.AbstractJDBCSeq</classname></ulink>
helps you create custom JDBC-based sequences. OpenJPA also supplies the
following built-in <classname>Seq</classname>s:
@ -1497,7 +1497,7 @@ following built-in <classname>Seq</classname>s:
</indexterm>
<literal>table</literal>: This is OpenJPA's default implementation. It is an
alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/TableJDBCSeq.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/TableJDBCSeq.html">
<classname>org.apache.openjpa.jdbc.kernel.TableJDBCSeq</classname></ulink>
class. The <classname>TableJDBCSeq</classname> uses a special single-row table
to store a global sequence number. If the table does not already exist, it is
@ -1554,7 +1554,7 @@ requests.
</secondary>
</indexterm>
<literal>class-table</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/ClassTableJDBCSeq.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/ClassTableJDBCSeq.html">
<classname>org.apache.openjpa.jdbc.kernel.ClassTableJDBCSeq</classname></ulink>
. This <classname>Seq</classname> is like the <classname>TableJDBCSeq
</classname> above, but maintains a separate table row, and therefore a separate
@ -1597,7 +1597,7 @@ tool runs. However, you can manually manipulate the table through the class'
</secondary>
</indexterm>
<literal>value-table</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/ValueTableJDBCSeq.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/ValueTableJDBCSeq.html">
<classname>org.apache.openjpa.jdbc.kernel.ValueTableJDBCSeq</classname></ulink>
. This <classname>Seq</classname> is like the <classname>ClassTableJDBCSeq
</classname> above, but has an arbitrary number of rows for sequence values,
@ -1631,7 +1631,7 @@ tool runs. However, you can manually manipulate the table through the class'
</secondary>
</indexterm>
<literal>native</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/NativeJDBCSeq.html">
<ulink url="../../apidocs/org/apache/openjpa/jdbc/kernel/NativeJDBCSeq.html">
<classname>org.apache.openjpa.jdbc.kernel.NativeJDBCSeq</classname></ulink>.
Many databases have a concept of "native sequences" - a built-in mechanism for
obtaining incrementing numbers. For example, in Oracle database, you can create a
@ -1681,7 +1681,7 @@ requests.
</secondary>
</indexterm>
<literal>time</literal>: This is an alias for the
<ulink url="../javadoc/org/apache/openjpa/kernel/TimeSeededSeq.html">
<ulink url="../../apidocs/org/apache/openjpa/kernel/TimeSeededSeq.html">
<classname>org.apache.openjpa.kernel.TimeSeededSeq</classname></ulink>. This
type uses an in-memory static counter, initialized to the current time in
milliseconds and monotonically incremented for each value requested. It is only
@ -1789,7 +1789,7 @@ public Generator getNamedGenerator(String name);
</programlisting>
<para>
The returned
<ulink url="../javadoc/org/apache/openjpa/persistence/Generator.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/Generator.html">
<classname>org.apache.openjpa.persistence.Generator</classname></ulink> is a
facade over an internal OpenJPA <classname>Seq</classname>.
</para>
@ -1799,7 +1799,7 @@ retrieve the identity generator of any class, or the generator of any field.
With these APIs, you do not have to know the generator name. Additionally, they
allow you to access the implicit generator used by default for datastore
identity classes. See the
<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<ulink url="../../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
Javadoc</ulink> for the <methodname> OpenJPAEntityManager.getIdentityGenerator
</methodname> and <methodname>OpenJPAEntityManager.getFieldGenerator
</methodname> methods for API details.
@ -1821,7 +1821,7 @@ Javadoc</ulink> for the <methodname> OpenJPAEntityManager.getIdentityGenerator
<para>
The OpenJPA runtime supports broadcasting transaction-related events. By
registering one or more
<ulink url="../javadoc/org/apache/openjpa/event/TransactionListener.html">
<ulink url="../../apidocs/org/apache/openjpa/event/TransactionListener.html">
<classname>org.apache.openjpa.event.TransactionListener</classname></ulink> s,
you can receive notifications when transactions begin, flush, rollback, commit,
and more. Where appropriate, event notifications include the set of
@ -1838,7 +1838,7 @@ and remove listeners. These methods are outside the bounds of the published Open
<para>
For details on the transaction framework, see the <literal>
org.apache.openjpa.event</literal> package
<ulink url="../javadoc/org/apache/openjpa/event/package-summary.html">Javadoc</ulink>.
<ulink url="../../apidocs/org/apache/openjpa/event/package-summary.html">Javadoc</ulink>.
Also see <xref linkend="ref_guide_event"/> for a description of OpenJPA's
remote event support.
</para>
@ -1850,11 +1850,11 @@ remote event support.
<para>
It is possible to adapt OpenJPA to access a non-relational datastore by creating
an implementation of the
<ulink url="../javadoc/org/apache/openjpa/kernel/StoreManager.html"><literal>
<ulink url="../../apidocs/org/apache/openjpa/kernel/StoreManager.html"><literal>
org.apache.openjpa.kernel.StoreManager</literal></ulink> interface. OpenJPA
provides an abstract <literal>StoreManager</literal> implementation to
facilitate this process. See the <literal>org.apache.openjpa.abstractstore
</literal> package <ulink url="../javadoc/org/apache/openjpa/abstractstore/package-summary.html">
</literal> package <ulink url="../../apidocs/org/apache/openjpa/abstractstore/package-summary.html">
Javadoc</ulink> for details.
</para>
</section>

2
openjpa-project/src/doc/manual/ref_guide_slice.xml
View File

@ -502,7 +502,7 @@ the JDBC connection URL of a slice.
This <emphasis>mandatory</emphasis> plug-in property determines how newly
persistent instances are distributed across individual slices.
The value of this property is a fully-qualified class name that implements
<ulink url="../javadoc/org/apache/openjpa/slice/DistributionPolicy.html">
<ulink url="../../apidocs/org/apache/openjpa/slice/DistributionPolicy.html">
<classname>org.apache.openjpa.slice.DistributionPolicy</classname>
</ulink> interface.
</para>