<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!--NewPage--> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.6.0_29) on Thu Nov 21 14:32:36 CET 2013 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
FetchConfiguration (OpenJPA Parent POM 2.3.0 API) | |
</TITLE> | |
<META NAME="date" CONTENT="2013-11-21"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
if (location.href.indexOf('is-external=true') == -1) { | |
parent.document.title="FetchConfiguration (OpenJPA Parent POM 2.3.0 API)"; | |
} | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white" onload="windowTitle();"> | |
<HR> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FetchConfiguration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../org/apache/openjpa/kernel/ExtentImpl.html" title="class in org.apache.openjpa.kernel"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html" title="class in org.apache.openjpa.kernel"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/openjpa/kernel/FetchConfiguration.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="FetchConfiguration.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_top"></A> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<HR> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<H2> | |
<FONT SIZE="-1"> | |
org.apache.openjpa.kernel</FONT> | |
<BR> | |
Interface FetchConfiguration</H2> | |
<DL> | |
<DT><B>All Superinterfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A>, <A HREF="../../../../org/apache/openjpa/kernel/LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</A>, <A HREF="../../../../org/apache/openjpa/kernel/LockScopes.html" title="interface in org.apache.openjpa.kernel">LockScopes</A>, <A HREF="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD> | |
</DL> | |
<DL> | |
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfiguration.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCFetchConfiguration</A></DD> | |
</DL> | |
<DL> | |
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/openjpa/kernel/DelegatingFetchConfiguration.html" title="class in org.apache.openjpa.kernel">DelegatingFetchConfiguration</A>, <A HREF="../../../../org/apache/openjpa/jdbc/kernel/DelegatingJDBCFetchConfiguration.html" title="class in org.apache.openjpa.jdbc.kernel">DelegatingJDBCFetchConfiguration</A>, <A HREF="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html" title="class in org.apache.openjpa.kernel">FetchConfigurationImpl</A>, <A HREF="../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfigurationImpl.html" title="class in org.apache.openjpa.jdbc.kernel">JDBCFetchConfigurationImpl</A>, <A HREF="../../../../org/apache/openjpa/slice/jdbc/TargetFetchConfiguration.html" title="class in org.apache.openjpa.slice.jdbc">TargetFetchConfiguration</A></DD> | |
</DL> | |
<HR> | |
<DL> | |
<DT><PRE>public interface <B>FetchConfiguration</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A>, <A HREF="../../../../org/apache/openjpa/kernel/LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</A>, <A HREF="../../../../org/apache/openjpa/kernel/LockScopes.html" title="interface in org.apache.openjpa.kernel">LockScopes</A>, <A HREF="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</A></DL> | |
</PRE> | |
<P> | |
Allows configuration and optimization of how objects are loaded from | |
the data store. | |
<P> | |
<P> | |
<DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.3.0</DD> | |
<DT><B>Author:</B></DT> | |
<DD>Abe White, Pinaki Poddar</DD> | |
</DL> | |
<HR> | |
<P> | |
<!-- =========== FIELD SUMMARY =========== --> | |
<A NAME="field_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Field Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#DEFAULT">DEFAULT</A></B></CODE> | |
<BR> | |
Constant to revert any setting back to its default value.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_LOAD">FETCH_LOAD</A></B></CODE> | |
<BR> | |
Constant indicating that a field requires a fetch and load of fetched | |
data.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_NONE">FETCH_NONE</A></B></CODE> | |
<BR> | |
Constant indicating that a field does not require fetching.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>static int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_REF">FETCH_REF</A></B></CODE> | |
<BR> | |
Constant indicating that a reference to the field's value must be | |
fetched, but loading data is not necessary.</TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.openjpa.kernel.LockLevels"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from interface org.apache.openjpa.kernel.<A HREF="../../../../org/apache/openjpa/kernel/LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_NONE">LOCK_NONE</A>, <A HREF="../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_READ">LOCK_READ</A>, <A HREF="../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_WRITE">LOCK_WRITE</A></CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.openjpa.kernel.LockScopes"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from interface org.apache.openjpa.kernel.<A HREF="../../../../org/apache/openjpa/kernel/LockScopes.html" title="interface in org.apache.openjpa.kernel">LockScopes</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="../../../../org/apache/openjpa/kernel/LockScopes.html#LOCKSCOPE_EXTENDED">LOCKSCOPE_EXTENDED</A>, <A HREF="../../../../org/apache/openjpa/kernel/LockScopes.html#LOCKSCOPE_NORMAL">LOCKSCOPE_NORMAL</A></CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.openjpa.kernel.QueryFlushModes"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from interface org.apache.openjpa.kernel.<A HREF="../../../../org/apache/openjpa/kernel/QueryFlushModes.html" title="interface in org.apache.openjpa.kernel">QueryFlushModes</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_FALSE">FLUSH_FALSE</A>, <A HREF="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_TRUE">FLUSH_TRUE</A>, <A HREF="../../../../org/apache/openjpa/kernel/QueryFlushModes.html#FLUSH_WITH_CONNECTION">FLUSH_WITH_CONNECTION</A></CODE></TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ========== METHOD SUMMARY =========== --> | |
<A NAME="method_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Method Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFetchGroup(java.lang.String)">addFetchGroup</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> group)</CODE> | |
<BR> | |
Adds <code>group</code> to the set of fetch group names to | |
use when loading objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFetchGroups(java.util.Collection)">addFetchGroups</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> groups)</CODE> | |
<BR> | |
Adds <code>groups</code> to the set of fetch group names to | |
use when loading objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addField(java.lang.String)">addField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> field)</CODE> | |
<BR> | |
Adds <code>field</code> to the set of fully-qualified field names to | |
use when loading objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#addFields(java.util.Collection)">addFields</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> fields)</CODE> | |
<BR> | |
Adds <code>fields</code> to the set of fully-qualified field names to | |
use when loading objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clearFetchGroups()">clearFetchGroups</A></B>()</CODE> | |
<BR> | |
Clears the set of fetch group names to use when loading | |
data.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clearFields()">clearFields</A></B>()</CODE> | |
<BR> | |
Clears the set of field names to use when loading | |
data.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#clone()">clone</A></B>()</CODE> | |
<BR> | |
Clone this instance.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#copy(org.apache.openjpa.kernel.FetchConfiguration)">copy</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch)</CODE> | |
<BR> | |
Copy the state from the given fetch configuration to this one.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getCacheRetrieveMode()">getCacheRetrieveMode</A></B>()</CODE> | |
<BR> | |
Gets the current retrieve mode for data cache.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getCacheStoreMode()">getCacheStoreMode</A></B>()</CODE> | |
<BR> | |
Gets the current storage mode for data cache.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getContext()">getContext</A></B>()</CODE> | |
<BR> | |
Return the context associated with this configuration; | |
may be null if it has not been set or this object has been serialized.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getExtendedPathLookup()">getExtendedPathLookup</A></B>()</CODE> | |
<BR> | |
Affirms if extended path lookup feature is active.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFetchBatchSize()">getFetchBatchSize</A></B>()</CODE> | |
<BR> | |
Return the fetch batch size for large result set support.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFetchGroups()">getFetchGroups</A></B>()</CODE> | |
<BR> | |
Returns immutable set of names of the fetch groups that this component | |
will use when loading objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFields()">getFields</A></B>()</CODE> | |
<BR> | |
Returns the set of fully-qualified field names that this component | |
will use when loading objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getFlushBeforeQueries()">getFlushBeforeQueries</A></B>()</CODE> | |
<BR> | |
The query automatic flush configuration.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getHint(java.lang.String)">getHint</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</CODE> | |
<BR> | |
Get the hint value for the specific key as originally set by the caller, or null if the hint is not specified.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getHints()">getHints</A></B>()</CODE> | |
<BR> | |
Get an immutable view of the currently active hints and their values.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getLockScope()">getLockScope</A></B>()</CODE> | |
<BR> | |
The lock scope for next fetch.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getLockTimeout()">getLockTimeout</A></B>()</CODE> | |
<BR> | |
The number of milliseconds to wait for an object lock, or -1 for no | |
limit.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getMaxFetchDepth()">getMaxFetchDepth</A></B>()</CODE> | |
<BR> | |
Return the maximum depth of fetched instance graph.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getQueryCacheEnabled()">getQueryCacheEnabled</A></B>()</CODE> | |
<BR> | |
Return whether or not query caching is enabled.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getQueryTimeout()">getQueryTimeout</A></B>()</CODE> | |
<BR> | |
The number of milliseconds to wait for a query, or -1 for no | |
limit.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getReadLockLevel()">getReadLockLevel</A></B>()</CODE> | |
<BR> | |
The lock level to use for locking loaded objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getRootClasses()">getRootClasses</A></B>()</CODE> | |
<BR> | |
Root classes for recursive operations.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getRootInstances()">getRootInstances</A></B>()</CODE> | |
<BR> | |
Root instances for recursive operations.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#getWriteLockLevel()">getWriteLockLevel</A></B>()</CODE> | |
<BR> | |
The lock level to use for locking dirtied objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#hasFetchGroup(java.lang.String)">hasFetchGroup</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> group)</CODE> | |
<BR> | |
Return true if the given fetch group has been added.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#hasField(java.lang.String)">hasField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> field)</CODE> | |
<BR> | |
Return true if the given fully-qualified field has been added.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isDefaultPUFetchGroupConfigurationOnly()">isDefaultPUFetchGroupConfigurationOnly</A></B>()</CODE> | |
<BR> | |
Affirm if the Fetch Plan currently matches the Persistence Unit's configured default.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isFetchConfigurationSQLCacheAdmissible()">isFetchConfigurationSQLCacheAdmissible</A></B>()</CODE> | |
<BR> | |
Whether SQL generated by the FetchConfiguration's current configuration should be cached.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#isHintSet(java.lang.String)">isHintSet</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</CODE> | |
<BR> | |
Affirm if the given hint has been set in this receiver.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#lock()">lock</A></B>()</CODE> | |
<BR> | |
Synchronize on internal lock if multithreaded is true.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop">ResultList</A><?></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)">newResultList</A></B>(<A HREF="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</A> rop)</CODE> | |
<BR> | |
Return a new result list for the current fetch configuration.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFetchGroup(java.lang.String)">removeFetchGroup</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> group)</CODE> | |
<BR> | |
Remove the given fetch group.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFetchGroups(java.util.Collection)">removeFetchGroups</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> groups)</CODE> | |
<BR> | |
Removes <code>groups</code> from the set of fetch group names | |
to use when loading objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeField(java.lang.String)">removeField</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> field)</CODE> | |
<BR> | |
Remove the given fully-qualified field.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#removeFields(java.util.Collection)">removeFields</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> fields)</CODE> | |
<BR> | |
Removes <code>fields</code> from the set of fully-qualified field names | |
to use when loading objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch(org.apache.openjpa.meta.FieldMetaData)">requiresFetch</A></B>(<A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> fm)</CODE> | |
<BR> | |
Affirms if the given field requires to be fetched in the context | |
of current fetch operation.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresLoad()">requiresLoad</A></B>()</CODE> | |
<BR> | |
Return false if we know that the object being fetched with this | |
configuration does not require a load, because this configuration came | |
from a traversal of a <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_REF"><CODE>FETCH_REF</CODE></A> field.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#resetFetchGroups()">resetFetchGroups</A></B>()</CODE> | |
<BR> | |
Resets the set of fetch groups to the list in the global configuration.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)">setCacheRetrieveMode</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</A> mode)</CODE> | |
<BR> | |
Sets the current retrieve mode for data cache.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)">setCacheStoreMode</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</A> mode)</CODE> | |
<BR> | |
Sets the current storage mode for data cache.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</A> ctx)</CODE> | |
<BR> | |
Called automatically by the system to associate the fetch configuration | |
with a context before use.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setExtendedPathLookup(boolean)">setExtendedPathLookup</A></B>(boolean flag)</CODE> | |
<BR> | |
Sets extended path lookup feature.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setFetchBatchSize(int)">setFetchBatchSize</A></B>(int fetchBatchSize)</CODE> | |
<BR> | |
Set the fetch batch size for large result set support.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setFlushBeforeQueries(int)">setFlushBeforeQueries</A></B>(int flush)</CODE> | |
<BR> | |
The query automatic flush configuration.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setHint(java.lang.String, java.lang.Object)">setHint</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</CODE> | |
<BR> | |
Sets an arbitrary query hint that may be utilized during execution.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setHint(java.lang.String, java.lang.Object, java.lang.Object)">setHint</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> original)</CODE> | |
<BR> | |
Sets an arbitrary query hint that may be utilized during execution.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setLockScope(int)">setLockScope</A></B>(int scope)</CODE> | |
<BR> | |
The lock scope for next fetch.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setLockTimeout(int)">setLockTimeout</A></B>(int timeout)</CODE> | |
<BR> | |
The number of milliseconds to wait for an object lock, or -1 for no | |
limit.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setMaxFetchDepth(int)">setMaxFetchDepth</A></B>(int max)</CODE> | |
<BR> | |
Set the maximum depth of the fetched instance graph.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setQueryCacheEnabled(boolean)">setQueryCacheEnabled</A></B>(boolean cache)</CODE> | |
<BR> | |
Control whether or not query caching is enabled.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setQueryTimeout(int)">setQueryTimeout</A></B>(int timeout)</CODE> | |
<BR> | |
The number of milliseconds to wait for a query, or -1 for no | |
limit.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setReadLockLevel(int)">setReadLockLevel</A></B>(int level)</CODE> | |
<BR> | |
The lock level to use for locking loaded objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setRootClasses(java.util.Collection)">setRootClasses</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?>> classes)</CODE> | |
<BR> | |
Root classes for recursive operations.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setRootInstances(java.util.Collection)">setRootInstances</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><?> roots)</CODE> | |
<BR> | |
Root instances for recursive operations.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setWriteLockLevel(int)">setWriteLockLevel</A></B>(int level)</CODE> | |
<BR> | |
The lock level to use for locking dirtied objects.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#traverse(org.apache.openjpa.meta.FieldMetaData)">traverse</A></B>(<A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> fm)</CODE> | |
<BR> | |
Traverse the given field to generate (possibly) a new configuration | |
state.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#unlock()">unlock</A></B>()</CODE> | |
<BR> | |
Release internal lock if multithreaded is true.</TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<!-- ============ FIELD DETAIL =========== --> | |
<A NAME="field_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Field Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="DEFAULT"><!-- --></A><H3> | |
DEFAULT</H3> | |
<PRE> | |
static final int <B>DEFAULT</B></PRE> | |
<DL> | |
<DD>Constant to revert any setting back to its default value. | |
<P> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.kernel.FetchConfiguration.DEFAULT">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="FETCH_NONE"><!-- --></A><H3> | |
FETCH_NONE</H3> | |
<PRE> | |
static final int <B>FETCH_NONE</B></PRE> | |
<DL> | |
<DD>Constant indicating that a field does not require fetching. | |
<P> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch(org.apache.openjpa.meta.FieldMetaData)"><CODE>requiresFetch(org.apache.openjpa.meta.FieldMetaData)</CODE></A>, | |
<A HREF="../../../../constant-values.html#org.apache.openjpa.kernel.FetchConfiguration.FETCH_NONE">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="FETCH_LOAD"><!-- --></A><H3> | |
FETCH_LOAD</H3> | |
<PRE> | |
static final int <B>FETCH_LOAD</B></PRE> | |
<DL> | |
<DD>Constant indicating that a field requires a fetch and load of fetched | |
data. | |
<P> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch(org.apache.openjpa.meta.FieldMetaData)"><CODE>requiresFetch(org.apache.openjpa.meta.FieldMetaData)</CODE></A>, | |
<A HREF="../../../../constant-values.html#org.apache.openjpa.kernel.FetchConfiguration.FETCH_LOAD">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="FETCH_REF"><!-- --></A><H3> | |
FETCH_REF</H3> | |
<PRE> | |
static final int <B>FETCH_REF</B></PRE> | |
<DL> | |
<DD>Constant indicating that a reference to the field's value must be | |
fetched, but loading data is not necessary. Used when we know the | |
data will be loaded anyway, such as when traversing the back-ptr of | |
a bidirectional relation where the other side is also being fetched. | |
<P> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#requiresFetch(org.apache.openjpa.meta.FieldMetaData)"><CODE>requiresFetch(org.apache.openjpa.meta.FieldMetaData)</CODE></A>, | |
<A HREF="../../../../constant-values.html#org.apache.openjpa.kernel.FetchConfiguration.FETCH_REF">Constant Field Values</A></DL> | |
</DL> | |
<!-- ============ METHOD DETAIL ========== --> | |
<A NAME="method_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Method Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="getContext()"><!-- --></A><H3> | |
getContext</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</A> <B>getContext</B>()</PRE> | |
<DL> | |
<DD>Return the context associated with this configuration; | |
may be null if it has not been set or this object has been serialized. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setContext(org.apache.openjpa.kernel.StoreContext)"><!-- --></A><H3> | |
setContext</H3> | |
<PRE> | |
void <B>setContext</B>(<A HREF="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</A> ctx)</PRE> | |
<DL> | |
<DD>Called automatically by the system to associate the fetch configuration | |
with a context before use. The fetch configuration properties should | |
be synchronized with the context's configuration object. Subclasses | |
for specific back ends cannot rely on the context's configuration | |
implementing their back end's configuration sub-interface. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="clone()"><!-- --></A><H3> | |
clone</H3> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>clone</B>()</PRE> | |
<DL> | |
<DD>Clone this instance. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="copy(org.apache.openjpa.kernel.FetchConfiguration)"><!-- --></A><H3> | |
copy</H3> | |
<PRE> | |
void <B>copy</B>(<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch)</PRE> | |
<DL> | |
<DD>Copy the state from the given fetch configuration to this one. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getFetchBatchSize()"><!-- --></A><H3> | |
getFetchBatchSize</H3> | |
<PRE> | |
int <B>getFetchBatchSize</B>()</PRE> | |
<DL> | |
<DD>Return the fetch batch size for large result set support. | |
Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note | |
that this property will be ignored under some data stores. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setFetchBatchSize(int)"><!-- --></A><H3> | |
setFetchBatchSize</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setFetchBatchSize</B>(int fetchBatchSize)</PRE> | |
<DL> | |
<DD>Set the fetch batch size for large result set support. | |
Defaults to the <code>openjpa.FetchBatchSize</code> setting. Note | |
that this property will be ignored under some data stores. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getMaxFetchDepth()"><!-- --></A><H3> | |
getMaxFetchDepth</H3> | |
<PRE> | |
int <B>getMaxFetchDepth</B>()</PRE> | |
<DL> | |
<DD>Return the maximum depth of fetched instance graph. | |
Defaults to <code>1</code> | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setMaxFetchDepth(int)"><!-- --></A><H3> | |
setMaxFetchDepth</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setMaxFetchDepth</B>(int max)</PRE> | |
<DL> | |
<DD>Set the maximum depth of the fetched instance graph. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>max</CODE> - denotes limiting length of traversal path from a root | |
instance. <code>-1</code> implies no limit. <code>0</code> is not | |
permissible.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getQueryCacheEnabled()"><!-- --></A><H3> | |
getQueryCacheEnabled</H3> | |
<PRE> | |
boolean <B>getQueryCacheEnabled</B>()</PRE> | |
<DL> | |
<DD>Return whether or not query caching is enabled. If this returns | |
<code>true</code> but the datacache plugin is not installed, caching | |
will not be enabled. If this | |
returns <code>false</code>, query caching will not be used | |
even if the datacache plugin is installed. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setQueryCacheEnabled(boolean)"><!-- --></A><H3> | |
setQueryCacheEnabled</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setQueryCacheEnabled</B>(boolean cache)</PRE> | |
<DL> | |
<DD>Control whether or not query caching is enabled. This has no effect | |
if the datacache plugin is not installed, or if the query cache size | |
is set to zero. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getFlushBeforeQueries()"><!-- --></A><H3> | |
getFlushBeforeQueries</H3> | |
<PRE> | |
int <B>getFlushBeforeQueries</B>()</PRE> | |
<DL> | |
<DD>The query automatic flush configuration. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setFlushBeforeQueries(int)"><!-- --></A><H3> | |
setFlushBeforeQueries</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setFlushBeforeQueries</B>(int flush)</PRE> | |
<DL> | |
<DD>The query automatic flush configuration. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getExtendedPathLookup()"><!-- --></A><H3> | |
getExtendedPathLookup</H3> | |
<PRE> | |
boolean <B>getExtendedPathLookup</B>()</PRE> | |
<DL> | |
<DD>Affirms if extended path lookup feature is active. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setExtendedPathLookup(boolean)"><!-- --></A><H3> | |
setExtendedPathLookup</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setExtendedPathLookup</B>(boolean flag)</PRE> | |
<DL> | |
<DD>Sets extended path lookup feature. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getFetchGroups()"><!-- --></A><H3> | |
getFetchGroups</H3> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getFetchGroups</B>()</PRE> | |
<DL> | |
<DD>Returns immutable set of names of the fetch groups that this component | |
will use when loading objects. Defaults to the | |
<code>openjpa.FetchGroups</code> setting. This set is not thread safe. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="hasFetchGroup(java.lang.String)"><!-- --></A><H3> | |
hasFetchGroup</H3> | |
<PRE> | |
boolean <B>hasFetchGroup</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> group)</PRE> | |
<DL> | |
<DD>Return true if the given fetch group has been added. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addFetchGroup(java.lang.String)"><!-- --></A><H3> | |
addFetchGroup</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>addFetchGroup</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> group)</PRE> | |
<DL> | |
<DD>Adds <code>group</code> to the set of fetch group names to | |
use when loading objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addFetchGroups(java.util.Collection)"><!-- --></A><H3> | |
addFetchGroups</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>addFetchGroups</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> groups)</PRE> | |
<DL> | |
<DD>Adds <code>groups</code> to the set of fetch group names to | |
use when loading objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="removeFetchGroup(java.lang.String)"><!-- --></A><H3> | |
removeFetchGroup</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>removeFetchGroup</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> group)</PRE> | |
<DL> | |
<DD>Remove the given fetch group. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="removeFetchGroups(java.util.Collection)"><!-- --></A><H3> | |
removeFetchGroups</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>removeFetchGroups</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> groups)</PRE> | |
<DL> | |
<DD>Removes <code>groups</code> from the set of fetch group names | |
to use when loading objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="clearFetchGroups()"><!-- --></A><H3> | |
clearFetchGroups</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>clearFetchGroups</B>()</PRE> | |
<DL> | |
<DD>Clears the set of fetch group names to use when loading | |
data. After this operation is invoked, only those fields in | |
the default fetch group (and any requested field) will be | |
loaded when loading an object. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="resetFetchGroups()"><!-- --></A><H3> | |
resetFetchGroups</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>resetFetchGroups</B>()</PRE> | |
<DL> | |
<DD>Resets the set of fetch groups to the list in the global configuration. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getFields()"><!-- --></A><H3> | |
getFields</H3> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getFields</B>()</PRE> | |
<DL> | |
<DD>Returns the set of fully-qualified field names that this component | |
will use when loading objects. Defaults to the empty set. This set is | |
not thread safe. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="hasField(java.lang.String)"><!-- --></A><H3> | |
hasField</H3> | |
<PRE> | |
boolean <B>hasField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> field)</PRE> | |
<DL> | |
<DD>Return true if the given fully-qualified field has been added. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addField(java.lang.String)"><!-- --></A><H3> | |
addField</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>addField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> field)</PRE> | |
<DL> | |
<DD>Adds <code>field</code> to the set of fully-qualified field names to | |
use when loading objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addFields(java.util.Collection)"><!-- --></A><H3> | |
addFields</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>addFields</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> fields)</PRE> | |
<DL> | |
<DD>Adds <code>fields</code> to the set of fully-qualified field names to | |
use when loading objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="removeField(java.lang.String)"><!-- --></A><H3> | |
removeField</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>removeField</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> field)</PRE> | |
<DL> | |
<DD>Remove the given fully-qualified field. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="removeFields(java.util.Collection)"><!-- --></A><H3> | |
removeFields</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>removeFields</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> fields)</PRE> | |
<DL> | |
<DD>Removes <code>fields</code> from the set of fully-qualified field names | |
to use when loading objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="clearFields()"><!-- --></A><H3> | |
clearFields</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>clearFields</B>()</PRE> | |
<DL> | |
<DD>Clears the set of field names to use when loading | |
data. After this operation is invoked, only those fields in | |
the configured fetch groups will be loaded when loading an object. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getLockTimeout()"><!-- --></A><H3> | |
getLockTimeout</H3> | |
<PRE> | |
int <B>getLockTimeout</B>()</PRE> | |
<DL> | |
<DD>The number of milliseconds to wait for an object lock, or -1 for no | |
limit. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.3.1</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setLockTimeout(int)"><!-- --></A><H3> | |
setLockTimeout</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setLockTimeout</B>(int timeout)</PRE> | |
<DL> | |
<DD>The number of milliseconds to wait for an object lock, or -1 for no | |
limit. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.3.1</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getLockScope()"><!-- --></A><H3> | |
getLockScope</H3> | |
<PRE> | |
int <B>getLockScope</B>()</PRE> | |
<DL> | |
<DD>The lock scope for next fetch. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setLockScope(int)"><!-- --></A><H3> | |
setLockScope</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setLockScope</B>(int scope)</PRE> | |
<DL> | |
<DD>The lock scope for next fetch. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getQueryTimeout()"><!-- --></A><H3> | |
getQueryTimeout</H3> | |
<PRE> | |
int <B>getQueryTimeout</B>()</PRE> | |
<DL> | |
<DD>The number of milliseconds to wait for a query, or -1 for no | |
limit. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setQueryTimeout(int)"><!-- --></A><H3> | |
setQueryTimeout</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setQueryTimeout</B>(int timeout)</PRE> | |
<DL> | |
<DD>The number of milliseconds to wait for a query, or -1 for no | |
limit. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getReadLockLevel()"><!-- --></A><H3> | |
getReadLockLevel</H3> | |
<PRE> | |
int <B>getReadLockLevel</B>()</PRE> | |
<DL> | |
<DD>The lock level to use for locking loaded objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.3.1</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setReadLockLevel(int)"><!-- --></A><H3> | |
setReadLockLevel</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setReadLockLevel</B>(int level)</PRE> | |
<DL> | |
<DD>The lock level to use for locking loaded objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.3.1</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getWriteLockLevel()"><!-- --></A><H3> | |
getWriteLockLevel</H3> | |
<PRE> | |
int <B>getWriteLockLevel</B>()</PRE> | |
<DL> | |
<DD>The lock level to use for locking dirtied objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.3.1</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getCacheStoreMode()"><!-- --></A><H3> | |
getCacheStoreMode</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</A> <B>getCacheStoreMode</B>()</PRE> | |
<DL> | |
<DD>Gets the current storage mode for data cache. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setCacheStoreMode(org.apache.openjpa.kernel.DataCacheStoreMode)"><!-- --></A><H3> | |
setCacheStoreMode</H3> | |
<PRE> | |
void <B>setCacheStoreMode</B>(<A HREF="../../../../org/apache/openjpa/kernel/DataCacheStoreMode.html" title="enum in org.apache.openjpa.kernel">DataCacheStoreMode</A> mode)</PRE> | |
<DL> | |
<DD>Sets the current storage mode for data cache. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getCacheRetrieveMode()"><!-- --></A><H3> | |
getCacheRetrieveMode</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</A> <B>getCacheRetrieveMode</B>()</PRE> | |
<DL> | |
<DD>Gets the current retrieve mode for data cache. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setCacheRetrieveMode(org.apache.openjpa.kernel.DataCacheRetrieveMode)"><!-- --></A><H3> | |
setCacheRetrieveMode</H3> | |
<PRE> | |
void <B>setCacheRetrieveMode</B>(<A HREF="../../../../org/apache/openjpa/kernel/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</A> mode)</PRE> | |
<DL> | |
<DD>Sets the current retrieve mode for data cache. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setWriteLockLevel(int)"><!-- --></A><H3> | |
setWriteLockLevel</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setWriteLockLevel</B>(int level)</PRE> | |
<DL> | |
<DD>The lock level to use for locking dirtied objects. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.3.1</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="newResultList(org.apache.openjpa.lib.rop.ResultObjectProvider)"><!-- --></A><H3> | |
newResultList</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/lib/rop/ResultList.html" title="interface in org.apache.openjpa.lib.rop">ResultList</A><?> <B>newResultList</B>(<A HREF="../../../../org/apache/openjpa/lib/rop/ResultObjectProvider.html" title="interface in org.apache.openjpa.lib.rop">ResultObjectProvider</A> rop)</PRE> | |
<DL> | |
<DD>Return a new result list for the current fetch configuration. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setHint(java.lang.String, java.lang.Object, java.lang.Object)"><!-- --></A><H3> | |
setHint</H3> | |
<PRE> | |
void <B>setHint</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> original)</PRE> | |
<DL> | |
<DD>Sets an arbitrary query hint that may be utilized during execution. | |
The hint may be specific to a particular database. A hint, if known | |
to this receiver, may have a corresponding setter method, then the hint sets the value. | |
Otherwise the hint is stored opaquely by the receiver. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the hint<DD><CODE>value</CODE> - the value of the hint. If the hint has a corresponding setter, then | |
the type of value must be same as the setter argument.<DD><CODE>original</CODE> - the value of the hint as specified by the user.<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setHint(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
setHint</H3> | |
<PRE> | |
void <B>setHint</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key, | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</PRE> | |
<DL> | |
<DD>Sets an arbitrary query hint that may be utilized during execution. | |
The hint may be specific to a particular database. A hint, if known | |
to this receiver, may have a corresponding setter method, then the hint sets the value. | |
Otherwise the hint is stored opaquely by the receiver. | |
<br> | |
This is same as calling <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#setHint(java.lang.String, java.lang.Object, java.lang.Object)">setHint(String, Object, Object)</A> with the third | |
argument being the same as the second. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the hint<DD><CODE>value</CODE> - the value of the hint. If the hint has a corresponding setter, then | |
the type of value must be same as the setter argument.<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getHint(java.lang.String)"><!-- --></A><H3> | |
getHint</H3> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getHint</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</PRE> | |
<DL> | |
<DD>Get the hint value for the specific key as originally set by the caller, or null if the hint is not specified. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the hint name<DT><B>Since:</B></DT> | |
<DD>0.4.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getHints()"><!-- --></A><H3> | |
getHints</H3> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>> <B>getHints</B>()</PRE> | |
<DL> | |
<DD>Get an immutable view of the currently active hints and their values. | |
The values are as specified by the user. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>2.0.0</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isHintSet(java.lang.String)"><!-- --></A><H3> | |
isHintSet</H3> | |
<PRE> | |
boolean <B>isHintSet</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key)</PRE> | |
<DL> | |
<DD>Affirm if the given hint has been set in this receiver. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isDefaultPUFetchGroupConfigurationOnly()"><!-- --></A><H3> | |
isDefaultPUFetchGroupConfigurationOnly</H3> | |
<PRE> | |
boolean <B>isDefaultPUFetchGroupConfigurationOnly</B>()</PRE> | |
<DL> | |
<DD>Affirm if the Fetch Plan currently matches the Persistence Unit's configured default. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getRootClasses()"><!-- --></A><H3> | |
getRootClasses</H3> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?>> <B>getRootClasses</B>()</PRE> | |
<DL> | |
<DD>Root classes for recursive operations. This set is not thread safe. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setRootClasses(java.util.Collection)"><!-- --></A><H3> | |
setRootClasses</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setRootClasses</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?>> classes)</PRE> | |
<DL> | |
<DD>Root classes for recursive operations. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getRootInstances()"><!-- --></A><H3> | |
getRootInstances</H3> | |
<PRE> | |
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>> <B>getRootInstances</B>()</PRE> | |
<DL> | |
<DD>Root instances for recursive operations. This set is not thread safe. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setRootInstances(java.util.Collection)"><!-- --></A><H3> | |
setRootInstances</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>setRootInstances</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><?> roots)</PRE> | |
<DL> | |
<DD>Root instances for recursive operations. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="lock()"><!-- --></A><H3> | |
lock</H3> | |
<PRE> | |
void <B>lock</B>()</PRE> | |
<DL> | |
<DD>Synchronize on internal lock if multithreaded is true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="unlock()"><!-- --></A><H3> | |
unlock</H3> | |
<PRE> | |
void <B>unlock</B>()</PRE> | |
<DL> | |
<DD>Release internal lock if multithreaded is true. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="requiresFetch(org.apache.openjpa.meta.FieldMetaData)"><!-- --></A><H3> | |
requiresFetch</H3> | |
<PRE> | |
int <B>requiresFetch</B>(<A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> fm)</PRE> | |
<DL> | |
<DD>Affirms if the given field requires to be fetched in the context | |
of current fetch operation. Returns one of <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_NONE"><CODE>FETCH_NONE</CODE></A>, | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_LOAD"><CODE>FETCH_LOAD</CODE></A>, <CODE>FETCH_REF</CODE>. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Since:</B></DT> | |
<DD>0.4.1</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="requiresLoad()"><!-- --></A><H3> | |
requiresLoad</H3> | |
<PRE> | |
boolean <B>requiresLoad</B>()</PRE> | |
<DL> | |
<DD>Return false if we know that the object being fetched with this | |
configuration does not require a load, because this configuration came | |
from a traversal of a <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html#FETCH_REF"><CODE>FETCH_REF</CODE></A> field. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="traverse(org.apache.openjpa.meta.FieldMetaData)"><!-- --></A><H3> | |
traverse</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>traverse</B>(<A HREF="../../../../org/apache/openjpa/meta/FieldMetaData.html" title="class in org.apache.openjpa.meta">FieldMetaData</A> fm)</PRE> | |
<DL> | |
<DD>Traverse the given field to generate (possibly) a new configuration | |
state. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>a new configuration state resulting out of traversal<DT><B>Since:</B></DT> | |
<DD>0.4.1</DD> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isFetchConfigurationSQLCacheAdmissible()"><!-- --></A><H3> | |
isFetchConfigurationSQLCacheAdmissible</H3> | |
<PRE> | |
boolean <B>isFetchConfigurationSQLCacheAdmissible</B>()</PRE> | |
<DL> | |
<DD>Whether SQL generated by the FetchConfiguration's current configuration should be cached. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<!-- ========= END OF CLASS DATA ========= --> | |
<HR> | |
<!-- ======= START OF BOTTOM NAVBAR ====== --> | |
<A NAME="navbar_bottom"><!-- --></A> | |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_bottom_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FetchConfiguration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../org/apache/openjpa/kernel/ExtentImpl.html" title="class in org.apache.openjpa.kernel"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/openjpa/kernel/FetchConfigurationImpl.html" title="class in org.apache.openjpa.kernel"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/openjpa/kernel/FetchConfiguration.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="FetchConfiguration.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
Copyright © 2006–2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved. | |
</BODY> | |
</HTML> |