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
This commit is contained in:
Richard G. Curtis 2011-08-16 16:39:40 +00:00
parent e032624813
commit ea499a8ed6
3 changed files with 18 additions and 8 deletions

View File

@ -243,18 +243,22 @@ public interface JDBCFetchConfiguration
public JDBCFetchConfiguration addFetchInnerJoins(Collection<String> fields); 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 * @since 2.2.0
* @return false
*/ */
public boolean getIgnoreDfgForFkSelect(); 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 * @since 2.2.0
* @return false
*/ */
public void setIgnoreDfgForFkSelect(boolean b); public void setIgnoreDfgForFkSelect(boolean b);
} }

View File

@ -143,10 +143,12 @@ public class JDBCFetchConfigurationImpl
public boolean getIgnoreDfgForFkSelect() { public boolean getIgnoreDfgForFkSelect() {
return _state.ignoreDfgForFkSelect; return _state.ignoreDfgForFkSelect;
} }
@Override @Override
public void setIgnoreDfgForFkSelect(boolean b) { public void setIgnoreDfgForFkSelect(boolean b) {
_state.ignoreDfgForFkSelect = b; _state.ignoreDfgForFkSelect = b;
} }
public int getEagerFetchMode() { public int getEagerFetchMode() {
return _state.eagerMode; return _state.eagerMode;
} }

View File

@ -229,18 +229,22 @@ public interface JDBCFetchPlan
public JDBCFetchPlan setJoinSyntax(int syntax); 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 * @since 2.2.0
* @return false
*/ */
public boolean getIgnoreDfgForFkSelect(); 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 * @since 2.2.0
* @return false
*/ */
public void setIgnoreDfgForFkSelect(boolean b); public void setIgnoreDfgForFkSelect(boolean b);
} }