You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by aw...@apache.org on 2006/10/04 02:10:29 UTC
svn commit: r452681 [2/2] -
/incubator/openjpa/trunk/openjpa-project/src/doc/manual/
Modified: incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml?view=diff&rev=452681&r1=452680&r2=452681
==============================================================================
--- incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml (original)
+++ incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml Tue Oct 3 17:10:28 2006
@@ -47,7 +47,7 @@
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="../apidocs/org/apache/openjpa/jdbc/meta/MappingTool"><classname>
+<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/MappingTool"><classname>
org.apache.openjpa.jdbc.meta.MappingTool</classname></ulink>.
</para>
<note>
@@ -456,7 +456,7 @@
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="../apidocs/org/apache/openjpa/jdbc/meta/ReverseMappingTool">
+<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/ReverseMappingTool">
<classname>org.apache.openjpa.jdbc.meta.ReverseMappingTool</classname></ulink>.
</para>
<example id="ref_guide_pc_reverse_reversemappingtool">
@@ -606,11 +606,11 @@
<para>
<literal>-customizerClass/-cc <class name></literal>: The full class name
of a
-<ulink url="../apidocs/org/apache/openjpa/jdbc/meta/ReverseCustomizer.html">
+<ulink url="../javadoc/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="../apidocs/org/apache/openjpa/jdbc/meta/PropertiesReverseCustomizer.html">
+<ulink url="../javadoc/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
@@ -669,7 +669,7 @@
<para>
The <classname>org.apache.openjpa.jdbc.meta.ReverseCustomizer</classname> plugin
interface allows you to customze the reverse mapping process. See the class
-<ulink url="../apidocs/org/apache/openjpa/jdbc/meta/ReverseCustomizer.html">
+<ulink url="../javadoc/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
@@ -677,7 +677,7 @@
</para>
<para>
By default, the reverse mapping tool uses a
-<ulink url="../apidocs/org/apache/openjpa/jdbc/meta/PropertiesReverseCustomizer.html">
+<ulink url="../javadoc/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>
@@ -912,7 +912,7 @@
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="../apidocs/org/apache/openjpa/jdbc/meta/MappingDefaults.html">
+<ulink url="../javadoc/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
@@ -941,7 +941,7 @@
<para>
<literal>jpa</literal>: Provides defaults in compliance with the JPA standard.
This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/PersistenceMappingDefaults.html">
+<ulink url="../javadoc/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
@@ -951,7 +951,7 @@
<listitem>
<para>
<literal>default</literal>: This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/meta/MappingDefaultsImpl.html">
+<ulink url="../javadoc/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:
@@ -973,7 +973,7 @@
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="../apidocs/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
+<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<literal>org.apache.openjpa.jdbc.meta.strats</literal></ulink> package for
available strategies.
</para>
@@ -987,7 +987,7 @@
<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="../apidocs/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
+<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<literal>org.apache.openjpa.jdbc.meta.strats</literal></ulink> package for all
available strategies.
</para>
@@ -1002,7 +1002,7 @@
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="../apidocs/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
+<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<literal>org.apache.openjpa.jdbc.meta.strats</literal></ulink> package for all
available strategies.
</para>
@@ -1019,7 +1019,7 @@
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="../apidocs/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
+<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/strats/package-summary.html">
<literal>org.apache.openjpa.jdbc.meta.strats</literal></ulink> package for all
available strategies.
</para>
@@ -1273,7 +1273,7 @@
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="../apidocs/org/apache/openjpa/jdbc/meta/Joinable.html"><classname>
+<ulink url="../javadoc/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
@@ -1434,7 +1434,7 @@
<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="../apidocs/org/apache/openjpa/persistence/jdbc/DataStoreIdColumn.html">
+<ulink url="../javadoc/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:
@@ -1527,10 +1527,10 @@
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="../apidocs/org/apache/openjpa/persistence/jdbc/VersionColumn.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/VersionColumn.html">
<classname>org.apache.openjpa.persistence.jdbc.VersionColumn</classname></ulink>
annotation. You can also use the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/VersionColumns.html">
+<ulink url="../javadoc/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:
@@ -1623,7 +1623,7 @@
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="../apidocs/org/apache/openjpa/persistence/jdbc/Columns.html">
+<ulink url="../javadoc/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>
@@ -1652,7 +1652,7 @@
</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="../apidocs/org/apache/openjpa/persistence/jdbc/XJoinColumn.html">
+<ulink url="../javadoc/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>
@@ -1662,7 +1662,7 @@
</para>
<para>
For compound keys, use the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/XJoinColumns.html">
+<ulink url="../javadoc/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.
@@ -1682,7 +1682,7 @@
</para>
<para>
OpenJPA overcomes these shortcomings with the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/EmbeddedMapping.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/EmbeddedMapping.html">
<classname>org.apache.openjpa.persistence.jdbc.EmbeddedMapping</classname>
</ulink> annotation. This annotation has the following properties:
</para>
@@ -1734,7 +1734,7 @@
</para>
<para>
Each
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/MappingOverride.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/MappingOverride.html">
<classname>org.apache.openjpa.persistence.jdbc.MappingOverride</classname>
</ulink> annotation has the following properties:
</para>
@@ -1853,7 +1853,7 @@
</indexterm>
<para>
The
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/ContainerTable.html">
+<ulink url="../javadoc/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:
@@ -1924,11 +1924,11 @@
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="../apidocs/org/apache/openjpa/persistence/jdbc/ElementJoinColumn.html">
+<ulink url="../javadoc/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="../apidocs/org/apache/openjpa/persistence/jdbc/ElementJoinColumns.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementJoinColumns.html">
<classname>org.apache.openjpa.persistence.jdbc.ElementJoinColumns</classname>
</ulink> annotation.
</para>
@@ -1961,7 +1961,7 @@
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.
OpenJPA's
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/OrderColumn">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/OrderColumn">
<classname>org.apache.openjpa.persistence.jdbc.OrderColumn</classname></ulink>
annotation has the following properties:
</para>
@@ -2138,13 +2138,13 @@
</primary>
</indexterm>
<para>
-The <ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/Index.html">
+The <ulink url="../javadoc/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="../apidocs/org/apache/openjpa/persistence/jdbc/ElementIndex.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementIndex.html">
<classname> org.apache.openjpa.persistence.jdbc.ElementIndex</classname></ulink>
annotation. These annotations have the following properties:
</para>
@@ -2188,14 +2188,14 @@
</primary>
</indexterm>
<para>
-The <ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/ForeignKey.html">
+The <ulink url="../javadoc/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="../apidocs/org/apache/openjpa/persistence/jdbc/ElementForeignKey.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementForeignKey.html">
<classname> org.apache.openjpa.persistence.jdbc.ElementForeignKey</classname>
</ulink> annotation. These annotations have the following properties:
</para>
@@ -2222,7 +2222,7 @@
<listitem>
<para>
<literal>ForeignKeyAction deleteAction</literal>: Value from the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/ForeignKeyAction.html">
+<ulink url="../javadoc/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>.
@@ -2231,7 +2231,7 @@
<listitem>
<para>
<literal>ForeignKeyAction updateAction</literal>: Value from the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/ForeignKeyAction.html">
+<ulink url="../javadoc/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>.
@@ -2266,7 +2266,7 @@
</primary>
</indexterm>
<para>
-The <ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/Unique.html">
+The <ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Unique.html">
<classname>org.apache.openjpa.persistence.jdbc.Unique</classname></ulink>
annotation represents a unqiue constraint on the columns of a field. It is more
convenient than using the <literal>uniqueConstraints</literal> property of
@@ -2408,10 +2408,10 @@
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 JPA
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/SubclassFetchMode.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/SubclassFetchMode.html">
<classname>org.apache.openjpa.persistence.jdbc.SubclassFetchMode</classname>
</ulink> annotation to a value from the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/EagerFetchType.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/EagerFetchType.html">
<classname>org.apache.openjpa.persistence.jdbc.EagerFetchType</classname>
</ulink> enum: <literal>JOIN</literal>, <literal>PARALLEL</literal>, or
<literal>NONE</literal>. See <xref linkend="ref_guide_perfpack_eager"/>
@@ -2437,7 +2437,7 @@
</seealso>
</indexterm>
<para>
-The <ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/Strategy.html">
+The <ulink url="../javadoc/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
@@ -2464,7 +2464,7 @@
</indexterm>
<para>
The
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/DiscriminatorStrategy.html">
+<ulink url="../javadoc/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
@@ -2491,7 +2491,7 @@
</indexterm>
<para>
The
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/VersionStrategy.html">
+<ulink url="../javadoc/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
@@ -2528,10 +2528,10 @@
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 JPA
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/EagerFetchMode.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/EagerFetchMode.html">
<classname>org.apache.openjpa.persistence.jdbc.EagerFetchMode</classname>
</ulink> annotation to a value from the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/EagerFetchType.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/EagerFetchType.html">
<classname>org.apache.openjpa.persistence.jdbc.EagerFetchType</classname>
</ulink> enum: <literal>JOIN</literal>, <literal>PARALLEL</literal>, or
<literal>NONE</literal>. See <xref linkend="ref_guide_perfpack_eager"/>
@@ -2574,14 +2574,14 @@
<itemizedlist>
<listitem>
<para>
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/Nonpolymorphic.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/Nonpolymorphic.html">
<classname>org.apache.openjpa.persistence.jdbc.Nonpolymorphic</classname>
</ulink>
</para>
</listitem>
<listitem>
<para>
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/ElementNonpolymorphic.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementNonpolymorphic.html">
<classname>org.apache.openjpa.persistence.jdbc.ElementNonpolymorphic</classname>
</ulink>
</para>
@@ -2589,7 +2589,7 @@
</itemizedlist>
<para>
The value of these extensions is a constant from the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/NonpolymorphicType.html">
+<ulink url="../javadoc/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
@@ -2642,13 +2642,13 @@
<itemizedlist>
<listitem>
<para>
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/ClassCriteria.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ClassCriteria.html">
<classname>org.apache.openjpa.persistence.jdbc.ClassCriteria</classname></ulink>
</para>
</listitem>
<listitem>
<para>
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/ElementClassCriteria.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/ElementClassCriteria.html">
<classname>org.apache.openjpa.persistence.jdbc.ElementClassCriteria</classname>
</ulink>
</para>
@@ -2675,7 +2675,7 @@
</indexterm>
<para>
OpenJPA's
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/Strategy.html">
+<ulink url="../javadoc/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
@@ -2717,14 +2717,14 @@
</title>
<para>
To create a custom class mapping, write an implementation of the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/meta/ClassStrategy.html">
+<ulink url="../javadoc/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="../apidocs/org/apache/openjpa/persistence/jdbc/Strategy.html">
+The <ulink url="../javadoc/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
@@ -2738,10 +2738,10 @@
</title>
<para>
To define a custom discriminator or version strategy, implement the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/meta/DiscriminatorStrategy.html">
+<ulink url="../javadoc/org/apache/openjpa/jdbc/meta/DiscriminatorStrategy.html">
<classname>org.apache.openjpa.jdbc.meta.DiscriminatorStrategy</classname>
</ulink> or
-<ulink url="../apidocs/org/apache/openjpa/jdbc/meta/VersionStrategy.html">
+<ulink url="../javadoc/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
@@ -2749,10 +2749,10 @@
</para>
<para>
OpenJPA includes the
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/DiscriminatorStrategy.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/jdbc/DiscriminatorStrategy.html">
<classname>org.apache.openjpa.persistence.jdbc.DiscriminatorStrategy</classname>
</ulink> and
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/VersionStrategy.html">
+<ulink url="../javadoc/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
@@ -2802,7 +2802,7 @@
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="../apidocs/org/apache/openjpa/jdbc/meta/ValueHandler.html"> Javadoc
+<ulink url="../javadoc/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
@@ -2826,7 +2826,7 @@
</indexterm>
<para>
OpenJPA interacts with persistent fields through the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/meta/FieldStrategy"><classname>
+<ulink url="../javadoc/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>
@@ -2865,7 +2865,7 @@
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="../apidocs/org/apache/openjpa/persistence/jdbc/Strategy.html">
+<ulink url="../javadoc/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
@@ -2899,7 +2899,7 @@
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="../apidocs/org/apache/openjpa/event/OrphanedKeyAction.html">
+<ulink url="../javadoc/org/apache/openjpa/event/OrphanedKeyAction.html">
<classname> org.apache.openjpa.event.OrphanedKeyAction</classname></ulink>
interface, or use one of the built-in options:
</para>
@@ -2908,7 +2908,7 @@
<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="../apidocs/org/apache/openjpa/event/LogOrphanedKeyAction.html">
+<ulink url="../javadoc/org/apache/openjpa/event/LogOrphanedKeyAction.html">
<classname>org.apache.openjpa.event.LogOrphanedKeyAction</classname></ulink>
class, which has the following additional properties:
</para>
@@ -2932,7 +2932,7 @@
<literal>exception</literal>: Throw an <classname>
EntityNotFoundException</classname> when OpenJPA discovers an
orphaned key. This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/event/ExceptionOrphanedKeyAction.html">
+<ulink url="../javadoc/org/apache/openjpa/event/ExceptionOrphanedKeyAction.html">
<classname>org.apache.openjpa.event.ExceptionOrphanedKeyAction</classname>
</ulink> class.
</para>
@@ -2940,7 +2940,7 @@
<listitem>
<para>
<literal>none</literal>: Ignore orphaned keys. This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/event/NoneOrphanedKeyAction.html">
+<ulink url="../javadoc/org/apache/openjpa/event/NoneOrphanedKeyAction.html">
<classname>org.apache.openjpa.event.NoneOrphanedKeyAction</classname></ulink>
class.
</para>
Modified: incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml?view=diff&rev=452681&r1=452680&r2=452681
==============================================================================
--- incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml (original)
+++ incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_meta.xml Tue Oct 3 17:10:28 2006
@@ -26,7 +26,7 @@
</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="../apidocs/org/apache/openjpa/meta/MetaDataFactory.html">
+<ulink url="../javadoc/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
@@ -38,7 +38,7 @@
<listitem>
<para>
<literal>jpa</literal>: Standard JPA metadata. This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/persistence/PersistenceMetaDataFactory.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/PersistenceMetaDataFactory.html">
<classname>
org.apache.openjpa.persistence.PersistenceMetaDataFactory</classname></ulink>.
</para>
@@ -175,7 +175,7 @@
</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="../apidocs/org/apache/openjpa/persistence/Persistent.html">
+The <ulink url="../javadoc/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:
@@ -241,7 +241,7 @@
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="../apidocs/org/apache/openjpa/persistence/PersistentCollection.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/PersistentCollection.html">
<classname>kodo.persistence.PersistentCollection</classname></ulink> metadata
annotation to represents any persistent collection field. It has the following
properties:
@@ -297,7 +297,7 @@
<para>
JPA has limited support for maps. If you extend JPA's standard map support to
encompass new mappings, use the
-<ulink url="../apidocs/org/apache/openjpa/persistence/PersistentMap.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/PersistentMap.html">
<classname>kodo.persistence.PersistentMap</classname></ulink> metadata
annotation to represent your custom persistent map fields. It has the
following properties:
@@ -403,9 +403,9 @@
</seealso>
</indexterm>
<para>
-The <ulink url="../apidocs/org/apache/openjpa/persistence/FetchGroups.html">
+The <ulink url="../javadoc/org/apache/openjpa/persistence/FetchGroups.html">
<classname>org.apache.openjpa.persistence.FetchGroups</classname></ulink> and
-<ulink url="../apidocs/org/apache/openjpa/persistence/FetchGroup.html">
+<ulink url="../javadoc/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
@@ -437,7 +437,7 @@
</para>
<para>
OpenJPA defines the
-<ulink url="../apidocs/org/apache/openjpa/persistence/DataCache.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/DataCache.html">
<classname>org.apache.openjpa.persistence.DataCache</classname></ulink>
annotation for caching information. This annotation has the following
properties:
@@ -491,7 +491,7 @@
</para>
<para>
OpenJPA defines the
-<ulink url="../apidocs/org/apache/openjpa/persistence/DetachedState.html">
+<ulink url="../javadoc/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:
@@ -564,21 +564,21 @@
<itemizedlist>
<listitem>
<para>
-<ulink url="../apidocs/org/apache/openjpa/persistence/Dependent.html">
+<ulink url="../javadoc/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="../apidocs/org/apache/openjpa/persistence/ElementDependent.html">
+<ulink url="../javadoc/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="../apidocs/org/apache/openjpa/persistence/KeyDependent.html">
+<ulink url="../javadoc/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>
@@ -609,7 +609,7 @@
</secondary>
</indexterm>
<para>
-The <ulink url="../apidocs/org/apache/openjpa/persistence/LoadFetchGroup.html">
+The <ulink url="../javadoc/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
@@ -637,7 +637,7 @@
</indexterm>
<para>
This boolean extension, denoted by the OpenJPA
-<ulink url="../apidocs/org/apache/openjpa/persistence/LRS.html"><classname>
+<ulink url="../javadoc/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
@@ -665,7 +665,7 @@
<para>
This extension names the inverse field in a logical bidirectional relation.
To create a logical bidrectional relation in OpenJPA, use the
-<ulink url="../apidocs/org/apache/openjpa/persistence/InverseLogical.html">
+<ulink url="../javadoc/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"/>.
@@ -703,10 +703,10 @@
</para>
<para>
To mark a field read-only in JPA metadata, set the
-<ulink url="../apidocs/org/apache/openjpa/persistence/ReadOnly.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/ReadOnly.html">
<classname>org.apache.openjpa.persistence.ReadOnly</classname></ulink>
annotation to an
-<ulink url="../apidocs/org/apache/openjpa/persistence/UpdateAction.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/UpdateAction.html">
<classname>org.apache.openjpa.persistence.UpdateAction</classname></ulink> enum
value. The <classname>UpdateAction</classname> enum includes:
</para>
@@ -804,19 +804,19 @@
<itemizedlist>
<listitem>
<para>
-<ulink url="../apidocs/org/apache/openjpa/persistence/Type.html"><classname>
+<ulink url="../javadoc/org/apache/openjpa/persistence/Type.html"><classname>
org.apache.openjpa.persistence.Type</classname></ulink>
</para>
</listitem>
<listitem>
<para>
-<ulink url="../apidocs/org/apache/openjpa/persistence/ElementType.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/ElementType.html">
<classname>org.apache.openjpa.persistence.ElementType</classname></ulink>
</para>
</listitem>
<listitem>
<para>
-<ulink url="../apidocs/org/apache/openjpa/persistence/KeyType.html"><classname>
+<ulink url="../javadoc/org/apache/openjpa/persistence/KeyType.html"><classname>
org.apache.openjpa.persistence.KeyType</classname></ulink>
</para>
</listitem>
@@ -842,7 +842,7 @@
</indexterm>
<para>
The OpenJPA
-<ulink url="../apidocs/org/apache/openjpa/persistence/Externalizer.html">
+<ulink url="../javadoc/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.
@@ -868,7 +868,7 @@
</indexterm>
<para>
The OpenJPA
-<ulink url="../apidocs/org/apache/openjpa/persistence/Factory.html"><classname>
+<ulink url="../javadoc/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.
@@ -894,7 +894,7 @@
</indexterm>
<para>
The OpenJPA
-<ulink url="../apidocs/org/apache/openjpa/persistence/ExternalValues.html">
+<ulink url="../javadoc/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
Modified: incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml?view=diff&rev=452681&r1=452680&r2=452681
==============================================================================
--- incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml (original)
+++ incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_optimization.xml Tue Oct 3 17:10:28 2006
@@ -134,7 +134,7 @@
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="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
OpenJPAEntityManager.setLargeTransaction</ulink>. Note that transactions in
large mode have to more aggressively flush items from the data cache.
<para>
@@ -143,7 +143,7 @@
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="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
OpenJPAEntityManager.setPopulateDataCache</ulink>
</para>
</entry>
Modified: incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml?view=diff&rev=452681&r1=452680&r2=452681
==============================================================================
--- incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml (original)
+++ incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_pc.xml Tue Oct 3 17:10:28 2006
@@ -396,7 +396,7 @@
<para>
You can control how your JPA datastore identity value is generated through
OpenJPA's
-<ulink url="../apidocs/org/apache/openjpa/persistence/DataStoreId.html">
+<ulink url="../javadoc/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
@@ -438,7 +438,7 @@
</indexterm>
<para>
Internally, OpenJPA uses the public
-<ulink url="../apidocs/org/apache/openjpa/util/Id.html"><classname>
+<ulink url="../javadoc/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>
@@ -499,7 +499,7 @@
</para>
<para>
The application identity tool can be invoked via its Java class,
-<ulink url="../apidocs/org/apache/openjpa/enhance/ApplicationIdTool">
+<ulink url="../javadoc/org/apache/openjpa/enhance/ApplicationIdTool">
<classname>org.apache.openjpa.enhance.ApplicationIdTool</classname></ulink>.
</para>
<note>
@@ -673,7 +673,7 @@
</para>
<para>
OpenJPA also allows you to define purely logical bidirectional relations. The
-<ulink url="../apidocs/org/apache/openjpa/persistence/InverseLogical.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/InverseLogical.html">
<classname>org.apache.openjpa.persistence.InverseLogical</classname></ulink>
annotation names a logical inverse in JPA metadata.
</para>
@@ -1015,7 +1015,7 @@
</para>
<para>
In order to use large result set proxies in JPA, add the
-<ulink url="../apidocs/org/apache/openjpa/persistence/LRS.html"><classname>
+<ulink url="../javadoc/org/apache/openjpa/persistence/LRS.html"><classname>
org.apache.openjpa.persistence.LRS</classname></ulink> annotation to the
persistent field.
</para>
@@ -1090,7 +1090,7 @@
</indexterm>
<para>
OpenJPA manages proxies through the
-<ulink url="../apidocs/org/apache/openjpa/util/ProxyManager.html"><classname>
+<ulink url="../javadoc/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
@@ -1109,7 +1109,7 @@
<para>
For custom behavior, OpenJPA allows you to define your own proxy classes, and
your own proxy manager. See the <literal>openjpa.util</literal> package
-<ulink url="../apidocs/">Javadoc</ulink> for details on the interfaces involved,
+<ulink url="../javadoc/">Javadoc</ulink> for details on the interfaces involved,
and the utility classes OpenJPA provides to assist you.
</para>
<para>
@@ -1166,14 +1166,14 @@
</note>
<para>
The OpenJPA
-<ulink url="../apidocs/org/apache/openjpa/persistence/Externalizer.html">
+<ulink url="../javadoc/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="../apidocs/org/apache/openjpa/kernel/StoreContext.html"><classname>
+<ulink url="../javadoc/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
@@ -1258,13 +1258,13 @@
</table>
<para>
The OpenJPA
-<ulink url="../apidocs/org/apache/openjpa/persistence/Factory.html"><classname>
+<ulink url="../javadoc/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 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="../apidocs/org/apache/openjpa/kernel/StoreContext.html"><classname>
+<ulink url="../javadoc/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
@@ -1366,7 +1366,7 @@
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="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/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.
@@ -1498,7 +1498,7 @@
</para>
<para>
Use the OpenJPA
-<ulink url="../apidocs/org/apache/openjpa/persistence/ExternalValues.html">
+<ulink url="../javadoc/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">
@@ -1510,7 +1510,7 @@
</para>
<para>
If the type of the datastore value is different from the field's type, use the
-<ulink url="../apidocs/org/apache/openjpa/persistence/Type.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/Type.html">
<classname>org.apache.openjpa.persistence.Type</classname></ulink> annotation
to define the datastore type.
</para>
@@ -1572,11 +1572,11 @@
</para>
<para>
You create fetch groups with the
-<ulink url="../apidocs/org/apache/openjpa/persistence/FetchGroup.html">
+<ulink url="../javadoc/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="../apidocs/org/apache/openjpa/persistence/FetchGroups.html">
+<ulink url="../javadoc/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
@@ -1615,7 +1615,7 @@
</itemizedlist>
<para>
As you might expect, listing a
-<ulink url="../apidocs/org/apache/openjpa/persistence/FetchAttribute.html">
+<ulink url="../javadoc/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>
@@ -1681,7 +1681,7 @@
</para>
<para>
Use OpenJPA's
-<ulink url="../apidocs/org/apache/openjpa/persistence/LoadFetchGroup.html">
+<ulink url="../javadoc/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
@@ -1759,7 +1759,7 @@
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="../apidocs/org/apache/openjpa/persistence/FetchPlan.html">
+<ulink url="../javadoc/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
Modified: incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_remote.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_remote.xml?view=diff&rev=452681&r1=452680&r2=452681
==============================================================================
--- incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_remote.xml (original)
+++ incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_remote.xml Tue Oct 3 17:10:28 2006
@@ -73,7 +73,7 @@
<link linkend="jpa_overview_emfactory_perscontext">persistence context</link>
ends. The specification does not define any way to explicitly detach objects.
The extended
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>OpenJPAEntityManager</classname></ulink>, however, allows you to
explicitly detach objects at any time.
</para>
@@ -111,7 +111,7 @@
from flushing when detaching dirty objects; instead OpenJPA just runs its
pre-flush actions (see the <methodname>OpenJPAEntityManager.preFlush
</methodname>
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
Javadoc</ulink> for details).
</para>
<para>
@@ -320,7 +320,7 @@
<para>
You can also alter the set of fields that will be included in the detached graph
at runtime.
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>OpenJPAEntityManager</classname></ulink>s expose the following APIs
for controlling detached state:
</para>
@@ -433,7 +433,7 @@
<para>
When a <literal>RemoteCommitProvider</literal> is properly configured, you can
register
-<ulink url="../apidocs/org/apache/openjpa/event/RemoteCommitListener.html">
+<ulink url="../javadoc/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.
@@ -678,10 +678,10 @@
<para>
You can develop additional mechanisms for remote event notification be by
creating an implementation of the
-<ulink url="../apidocs/org/apache/openjpa/event/RemoteCommitProvider.html">
+<ulink url="../javadoc/org/apache/openjpa/event/RemoteCommitProvider.html">
<classname> RemoteCommitProvider</classname></ulink> interface, possibly by
extending the
-<ulink url="../apidocs/org/apache/openjpa/event/AbstractRemoteCommitProvider.html">
+<ulink url="../javadoc/org/apache/openjpa/event/AbstractRemoteCommitProvider.html">
<classname>AbstractRemoteCommitProvider</classname></ulink> abstract class..
</para>
</section>
Modified: incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_runtime.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_runtime.xml?view=diff&rev=452681&r1=452680&r2=452681
==============================================================================
--- incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_runtime.xml (original)
+++ incubator/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_runtime.xml Tue Oct 3 17:10:28 2006
@@ -101,7 +101,7 @@
</indexterm>
<para>
Some advanced users may want to add capabilities to OpenJPA's internal
-<ulink url="../apidocs/org/apache/openjpa/kernel/BrokerImpl.html"><classname>
+<ulink url="../javadoc/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> through
the <link linkend="openjpa.BrokerImpl"><literal>openjpa.BrokerImpl</literal>
@@ -189,7 +189,7 @@
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="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManagerFactory.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManagerFactory.html">
interface Javadoc</ulink> for details.
</para>
</section>
@@ -215,7 +215,7 @@
</indexterm>
<para>
All OpenJPA <classname>EntityManager</classname>s implement the
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/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>
@@ -248,7 +248,7 @@
<para>
OpenJPA extends JPA's standard query functionality with the <classname>
org.apache.openjpa.persistence.OpenJPAQuery</classname> interface. See its
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAQuery.html">Javadoc
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAQuery.html">Javadoc
</ulink> for details on the convenience methods it provides.
</para>
</section>
@@ -275,7 +275,7 @@
<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="../apidocs/org/apache/openjpa/persistence/Extent.html"><classname>
+<ulink url="../javadoc/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:
@@ -309,7 +309,7 @@
In addition to the <classname>EntityManager</classname> object cache mandated by
the JPA specification, OpenJPA includes a flexible datastore-level cache. You
can access this cache from your JPA code using the
-<ulink url="../apidocs/org/apache/openjpa/persistence/StoreCache.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/StoreCache.html">
<classname>org.apache.openjpa.persistence.StoreCache</classname></ulink> facade.
<xref linkend="ref_guide_cache"/> has detailed information on OpenJPA's
data caching system, including the <classname>StoreCache</classname> facade.
@@ -326,7 +326,7 @@
</indexterm>
<para>
OpenJPA can cache query results as well as persistent object data. The
-<ulink url="../apidocs/org/apache/openjpa/persistence/QueryResultCache.html">
+<ulink url="../javadoc/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
@@ -360,7 +360,7 @@
</para>
<para>
OpenJPA goes one step further, extending <classname>FetchPlan</classname> with
-<ulink url="../apidocs/org/apache/openjpa/persistence/jdbc/JDBCFetchPlan.html">
+<ulink url="../javadoc/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
@@ -396,7 +396,7 @@
</primary>
</indexterm>
<para>
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAPersistence.html">
+<ulink url="../javadoc/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>.
@@ -585,7 +585,7 @@
<ulink url="http://java.sun.com/javaee/5/docs/api/javax/persistence/EntityManager.html">
<methodname>EntityManager.lock(Object, LockModeType)</methodname></ulink>
method, the
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
<classname>OpenJPAEntityManager</classname></ulink> exposes the following
methods to lock objects explicitly:
</para>
@@ -646,7 +646,7 @@
</primary>
</indexterm>
OpenJPA delegates the actual work of locking objects to the system's
-<ulink url="../apidocs/org/apache/openjpa/kernel/LockManager.html"><classname>
+<ulink url="../javadoc/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
@@ -656,7 +656,7 @@
<listitem>
<para>
<literal>pessimistic</literal>: This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html">
+<ulink url="../javadoc/org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html">
<classname>o
rg.apache.openjpa.jdbc.kernel.PessimisticLockManager</classname></ulink>, which
uses SELECT FOR UPDATE statements (or the database's equivalent) to lock the
@@ -678,7 +678,7 @@
<listitem>
<para>
<literal>none</literal>: An alias for the
-<ulink url="../apidocs/org/apache/openjpa/kernel/NoneLockManager.html">
+<ulink url="../javadoc/org/apache/openjpa/kernel/NoneLockManager.html">
<classname>org.apache.openjpa.kernel.NoneLockManager</classname></ulink>, which
does not perform any locking at all.
</para>
@@ -686,7 +686,7 @@
<listitem>
<para>
<literal>version</literal>: An alias for the
-<ulink url="../apidocs/org/apache/openjpa/kernel/VersionLockManager.html">
+<ulink url="../javadoc/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
@@ -870,7 +870,7 @@
</title>
<para>
OpenJPA's
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/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
@@ -949,7 +949,7 @@
</title>
<para>
OpenJPA uses the
-<ulink url="../apidocs/org/apache/openjpa/kernel/SavepointManager">
+<ulink url="../javadoc/org/apache/openjpa/kernel/SavepointManager">
<classname>org.apache.openjpa.kernel.SavepointManager</classname></ulink>
<link linkend="ref_guide_conf_plugins">plugin</link> to handle perserving the
savepoint state. OpenJPA includes the following <classname>SavepointManager
@@ -1141,7 +1141,7 @@
</indexterm>
<para>
You can write your own extensions by implementing the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/kernel/exps/JDBCFilterListener.html">
+<ulink url="../javadoc/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
@@ -1190,7 +1190,7 @@
</para>
<para>
See the <classname>OpenJPAQuery</classname>
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAQuery.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAQuery.html">
Javadoc</ulink> for details.
</para>
</listitem>
@@ -1212,7 +1212,7 @@
<para>
Just as you can write your own filter methods, you can write your own query
aggregates by implementing the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/kernel/exps/JDBCAggregateListener.html">
+<ulink url="../javadoc/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
@@ -1258,7 +1258,7 @@
</para>
<para>
See the <classname>OpenJPAQuery</classname>
-<ulink url="../apidocs/org/apache/openjpa/persistence/OpenJPAQuery.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAQuery.html">
Javadoc</ulink> for details.
</para>
</listitem>
@@ -1318,7 +1318,7 @@
For datastore queries, the method must have the following signature:
</para>
<programlisting>
-public static <ulink url="../apidocs/org/apache/openjpa/lib/rop/ResultObjectProvider.html">ResultObjectProvider</ulink> xxx(<ulink url="../apidocs/org/apache/openjpa/kernel/StoreContext.html">StoreContext</ulink> ctx, <ulink url="../apidocs/org/apache/openjpa/meta/ClassMetaData.html">ClassMetaData</ulink> meta, boolean subclasses, Map params, <ulink url="../apidocs/org/apache/openjpa/kernel/FetchConfiguration.html">FetchConfiguration </ulink> fetch)
+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)
</programlisting>
<para>
The returned result object provider should produce objects of the candidate
@@ -1332,7 +1332,7 @@
returning a boolean on whether the object matches the query:
</para>
<programlisting>
-public static boolean xxx(<ulink url="../apidocs/org/apache/openjpa/kernel/StoreContext.html">StoreContext</ulink> ctx, <ulink url="../apidocs/org/apache/openjpa/meta/ClassMetaData.html">ClassMetaData</ulink> meta, boolean subclasses, Object obj, Map params, <ulink url="../apidocs/org/apache/openjpa/kernel/FetchConfiguration.html">FetchConfiguration</ulink> fetch)
+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)
</programlisting>
<para>
In both method versions, the given <literal>params</literal> map contains the
@@ -1360,12 +1360,12 @@
</para>
<para>
OpenJPA represents all generators internally with the
-<ulink url="../apidocs/org/apache/openjpa/kernel/Seq.html"><classname>
+<ulink url="../javadoc/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="../apidocs/org/apache/openjpa/jdbc/kernel/AbstractJDBCSeq.html">
+<ulink url="../javadoc/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:
@@ -1383,7 +1383,7 @@
</indexterm>
<literal>table</literal>: This is OpenJPA's default implementation. It is an
alias for the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/kernel/TableJDBCSeq.html">
+<ulink url="../javadoc/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
@@ -1437,7 +1437,7 @@
</secondary>
</indexterm>
<literal>class-table</literal>: This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/kernel/ClassTableJDBCSeq.html">
+<ulink url="../javadoc/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
@@ -1480,7 +1480,7 @@
</secondary>
</indexterm>
<literal>value-table</literal>: This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/kernel/ValueTableJDBCSeq.html">
+<ulink url="../javadoc/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,
@@ -1514,7 +1514,7 @@
</secondary>
</indexterm>
<literal>native</literal>: This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/jdbc/kernel/NativeJDBCSeq.html">
+<ulink url="../javadoc/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, you can create a
@@ -1561,7 +1561,7 @@
</secondary>
</indexterm>
<literal>time</literal>: This is an alias for the
-<ulink url="../apidocs/org/apache/openjpa/kernel/TimeSeededSeq.html">
+<ulink url="../javadoc/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
@@ -1654,7 +1654,7 @@
</programlisting>
<para>
The returned
-<ulink url="../apidocs/org/apache/openjpa/persistence/Generator.html">
+<ulink url="../javadoc/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>
@@ -1664,7 +1664,7 @@
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="../apidocs/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
+<ulink url="../javadoc/org/apache/openjpa/persistence/OpenJPAEntityManager.html">
Javadoc</ulink> for the <methodname> OpenJPAEntityManager.getIdentityGenerator
</methodname> and <methodname>OpenJPAEntityManager.getFieldGenerator
</methodname> methods for API details.
@@ -1686,7 +1686,7 @@
<para>
The OpenJPA runtime supports broadcasting transaction-related events. By
registering one or more
-<ulink url="../apidocs/org/apache/openjpa/event/TransactionListener.html">
+<ulink url="../javadoc/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
@@ -1703,7 +1703,7 @@
<para>
For details on the transaction framework, see the <literal>
org.apache.openjpa.event</literal> package
-<ulink url="../apidocs/org/apache/openjpa/event/package.html">Javadoc</ulink>.
+<ulink url="../javadoc/org/apache/openjpa/event/package.html">Javadoc</ulink>.
Also see <xref linkend="ref_guide_event"/> for a description of OpenJPA's
remote event support.
</para>
@@ -1715,11 +1715,11 @@
<para>
It is possible to adapt OpenJPA to access a non-relational datastore by creating
an implementation of the
-<ulink url="../apidocs/org/apache/openjpa/kernel/StoreManager.html"><literal>
+<ulink url="../javadoc/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="../apidocs/org/apache/openjpa/abstractstore">
+</literal> package <ulink url="../javadoc/org/apache/openjpa/abstractstore">
Javadoc</ulink> for details.
</para>
</section>