From ea499a8ed6331f519ec492dfab5618e7e7155dc4 Mon Sep 17 00:00:00 2001
From: "Richard G. Curtis" <curtisr7@apache.org>
Date: Tue, 16 Aug 2011 16:39:40 +0000
Subject: [PATCH] OPENJPA-2039: Update javadoc and minor formatting changes.

git-svn-id: https://svn.apache.org/repos/asf/openjpa/trunk@1158364 13f79535-47bb-0310-9956-ffa450edef68
---
 .../openjpa/jdbc/kernel/JDBCFetchConfiguration.java  | 12 ++++++++----
 .../jdbc/kernel/JDBCFetchConfigurationImpl.java      |  2 ++
 .../openjpa/persistence/jdbc/JDBCFetchPlan.java      | 12 ++++++++----
 3 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.java b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.java
index 95cf43c43..ad5eb1833 100644
--- a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.java
+++ b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.java
@@ -243,18 +243,22 @@ public interface JDBCFetchConfiguration
     public JDBCFetchConfiguration addFetchInnerJoins(Collection<String> fields);
     
     /**
-     * If true - Ignore whether or not a field is in the dfg for mappings that use 2-part selects to load fk table data.
+     * Affirms if foreign key for a relation field will be pre-fetched as part of the owning object irrespective of
+     * whether the field is included in the default fetch group of this fetch configuration. <br>
+     * By default, foreign key for a relation field is pre-fetched as part of the owning object <em>only</em> if the
+     * field in included in the default fetch group of this fetch configuration.
      * 
      * @since 2.2.0
-     * @return false
      */
     public boolean getIgnoreDfgForFkSelect();
 
     /**
-     * If true - Ignore whether or not a field is in the dfg for mappings that use 2-part selects to load fk table data.
+     * Affirms if foreign key for a relation field will be pre-fetched as part of the owning object irrespective of
+     * whether the field is included in the default fetch group of this fetch configuration. <br>
+     * By default, foreign key for a relation field is pre-fetched as part of the owning object <em>only</em> if the
+     * field in included in the default fetch group of this fetch configuration.
      * 
      * @since 2.2.0
-     * @return false
      */
     public void setIgnoreDfgForFkSelect(boolean b);
 }
diff --git a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCFetchConfigurationImpl.java b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCFetchConfigurationImpl.java
index 2540aca68..c9af34caa 100644
--- a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCFetchConfigurationImpl.java
+++ b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCFetchConfigurationImpl.java
@@ -143,10 +143,12 @@ public class JDBCFetchConfigurationImpl
     public boolean getIgnoreDfgForFkSelect() {
         return _state.ignoreDfgForFkSelect;
     }
+
     @Override
     public void setIgnoreDfgForFkSelect(boolean b) {
         _state.ignoreDfgForFkSelect = b;
     }
+
     public int getEagerFetchMode() {
         return _state.eagerMode;
     }
diff --git a/openjpa-persistence-jdbc/src/main/java/org/apache/openjpa/persistence/jdbc/JDBCFetchPlan.java b/openjpa-persistence-jdbc/src/main/java/org/apache/openjpa/persistence/jdbc/JDBCFetchPlan.java
index 3e5f6d381..8ceb76a5a 100644
--- a/openjpa-persistence-jdbc/src/main/java/org/apache/openjpa/persistence/jdbc/JDBCFetchPlan.java
+++ b/openjpa-persistence-jdbc/src/main/java/org/apache/openjpa/persistence/jdbc/JDBCFetchPlan.java
@@ -229,18 +229,22 @@ public interface JDBCFetchPlan
     public JDBCFetchPlan setJoinSyntax(int syntax);
     
     /**
-     * If true - Ignore whether or not a field is in the dfg for mappings that use 2-part selects to load fk table data.
+     * Affirms if foreign key for a relation field will be pre-fetched as part of the owning object irrespective of
+     * whether the field is included in the default fetch group of this fetch configuration. <br><br>
+     * By default, foreign key for a relation field is pre-fetched as part of the owning object <em>only</em> if the
+     * field in included in the default fetch group of this fetch configuration.
      * 
      * @since 2.2.0
-     * @return false
      */
     public boolean getIgnoreDfgForFkSelect();
 
     /**
-     * If true - Ignore whether or not a field is in the dfg for mappings that use 2-part selects to load fk table data.
+     * Affirms if foreign key for a relation field will be pre-fetched as part of the owning object irrespective of
+     * whether the field is included in the default fetch group of this fetch configuration. <br><br>
+     * By default, foreign key for a relation field is pre-fetched as part of the owning object <em>only</em> if the
+     * field in included in the default fetch group of this fetch configuration.
      * 
      * @since 2.2.0
-     * @return false
      */
     public void setIgnoreDfgForFkSelect(boolean b);
 }