Author: ppoddar
Date: Mon Aug 25 07:39:39 2008
New Revision: 688738
URL: http://svn.apache.org/viewvc?rev=688738&view=rev
Log:
OPENJPA-693: describe implicit property of @ForeignKey annotation
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=688738&r1=688737&r2=688738&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 Mon Aug
25 07:39:39 2008
@@ -2306,6 +2306,19 @@
</para>
</listitem>
<listitem>
+ <para>
+<literal>boolean implicit</literal>: Whether to mark a relation field value as
+implicitly referring to a related entity. This property can be used, for
+example, when a field value represents primary key field of a related
+entity, but for legacy or other logistic reasons, the field is declared as the
+same type of the primary key of the related entity instead of a reference to
+the entity itself. Hence no actual mapping can be defined on the field itself.
+If this implicit property is set, then no other property on
+the ForeignKey annotation can be set to their non-default value. This setting
+does not manifest as a database foreign key constraint.
+ </para>
+ </listitem>
+ <listitem>
<para>
<literal>ForeignKeyAction deleteAction</literal>: Value from the
<ulink
url="../javadoc/org/apache/openjpa/persistence/jdbc/ForeignKeyAction.html">
