svn commit: r737187 - /openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml

[jr...@apache.org]

Author: jrbauer
Date: Fri Jan 23 13:00:24 2009
New Revision: 737187

URL: http://svn.apache.org/viewvc?rev=737187&view=rev
Log:
OPENJPA-802 OrderColumn doc update

Modified:
    openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml

Modified: openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml
URL: http://svn.apache.org/viewvc/openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml?rev=737187&r1=737186&r2=737187&view=diff
==============================================================================
--- openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml (original)
+++ openjpa/trunk/openjpa-project/src/doc/manual/ref_guide_mapping.xml Fri Jan 23 13:00:24 2009
@@ -2091,7 +2091,13 @@
                 <para>
 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.
+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">
+<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">
 <classname>org.apache.openjpa.persistence.jdbc.OrderColumn</classname></ulink>
@@ -2100,7 +2106,12 @@
                 <itemizedlist>
                     <listitem>
                         <para>
-<literal>String name</literal>: Defaults to <literal>ORDR</literal>.
+<literal>String name</literal>: Defaults to <literal>the name of the
+relationship property or field of the entity or embeddable 
+class + _ORDER</literal>.  To use the JPA 1.0 default order column
+name <literal>ORDR</literal>, set the <xref linkend="openjpa.Compatibility"/>
+option <literal>UseJPA2DefaultOrderColumnName</literal> to <literal>
+false</literal>.
                         </para>
                     </listitem>
                     <listitem>