| <!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_21) on Wed Aug 25 21:59:49 EDT 2010 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| FetchPlan (OpenJPA Parent POM 2.0.1 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2010-08-25"> |
| |
| <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="FetchPlan (OpenJPA Parent POM 2.0.1 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/FetchPlan.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/persistence/FetchGroups.html" title="annotation in org.apache.openjpa.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/persistence/FetchPlan.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="FetchPlan.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.persistence</FONT> |
| <BR> |
| Interface FetchPlan</H2> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/openjpa/persistence/jdbc/JDBCFetchPlan.html" title="interface in org.apache.openjpa.persistence.jdbc">JDBCFetchPlan</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence">FetchPlanImpl</A>, <A HREF="../../../../org/apache/openjpa/persistence/jdbc/JDBCFetchPlanImpl.html" title="class in org.apache.openjpa.persistence.jdbc">JDBCFetchPlanImpl</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>FetchPlan</B></DL> |
| </PRE> |
| |
| <P> |
| The fetch plan allows you to dynamically alter eager fetching |
| configuration and other aspects of data loading. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.4.1</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/persistence/FetchPlan.html#DEFAULT">DEFAULT</A></B></CODE> |
| |
| <BR> |
| Constant to revert any setting 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/persistence/FetchPlan.html#DEPTH_INFINITE">DEPTH_INFINITE</A></B></CODE> |
| |
| <BR> |
| Infinite fetch depth.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html#GROUP_ALL">GROUP_ALL</A></B></CODE> |
| |
| <BR> |
| Fetch group representing all fields.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html#GROUP_DEFAULT">GROUP_DEFAULT</A></B></CODE> |
| |
| <BR> |
| The default fetch group.</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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroup(java.lang.String)">addFetchGroup</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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 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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroups(java.util.Collection)">addFetchGroups</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFetchGroups(java.lang.String...)">addFetchGroups</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#addField(java.lang.Class, java.lang.String)">addField</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/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 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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#addField(java.lang.String)">addField</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.lang.Class, java.util.Collection)">addFields</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A> fields)</CODE> |
| |
| <BR> |
| Adds <code>fields</code> to the set of 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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.lang.Class, java.lang.String...)">addFields</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/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 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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.util.Collection)">addFields</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#addFields(java.lang.String...)">addFields</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#clearFetchGroups()">clearFetchGroups</A></B>()</CODE> |
| |
| <BR> |
| Clears the set of fetch group names to use wen 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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#clearFields()">clearFields</A></B>()</CODE> |
| |
| <BR> |
| Clears the set of field names to use wen 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/DataCacheRetrieveMode.html" title="enum in org.apache.openjpa.kernel">DataCacheRetrieveMode</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.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/persistence/FetchPlan.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/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#getDelegate()">getDelegate</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>cast to <A HREF="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><CODE>FetchPlanImpl</CODE></A> instead. This |
| method pierces the published-API boundary, as does the SPI cast.</I></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/persistence/FetchPlan.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/persistence/FetchPlan.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://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html#getFetchGroups()">getFetchGroups</A></B>()</CODE> |
| |
| <BR> |
| Returns the 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://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html#getFields()">getFields</A></B>()</CODE> |
| |
| <BR> |
| Returns the fully qualified names of the fields 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://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html#getHint(java.lang.String)">getHint</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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 given key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html#getHints()">getHints</A></B>()</CODE> |
| |
| <BR> |
| Get the hints and their values currently set on this receiver.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/PessimisticLockScope.html?is-external=true" title="class or interface in javax.persistence">PessimisticLockScope</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#getLockScope()">getLockScope</A></B>()</CODE> |
| |
| <BR> |
| The lock scope to use for locking loaded 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/persistence/FetchPlan.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/persistence/FetchPlan.html#getMaxFetchDepth()">getMaxFetchDepth</A></B>()</CODE> |
| |
| <BR> |
| The maximum fetch depth when loading an object.</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/persistence/FetchPlan.html#getQueryResultCache()">getQueryResultCache</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>use <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryResultCacheEnabled()"><CODE>getQueryResultCacheEnabled()</CODE></A> instead.</I></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/persistence/FetchPlan.html#getQueryResultCacheEnabled()">getQueryResultCacheEnabled</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/persistence/FetchPlan.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> <A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#getReadLockMode()">getReadLockMode</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://java.sun.com/javaee/6/docs/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#getWriteLockMode()">getWriteLockMode</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/persistence/FetchPlan.html#hasField(java.lang.Class, java.lang.String)">hasField</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/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 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/persistence/FetchPlan.html#hasField(java.lang.String)">hasField</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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 field has been added.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroup(java.lang.String)">removeFetchGroup</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroups(java.util.Collection)">removeFetchGroups</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFetchGroups(java.lang.String...)">removeFetchGroups</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeField(java.lang.Class, java.lang.String)">removeField</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> field)</CODE> |
| |
| <BR> |
| Remove the given field.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeField(java.lang.String)">removeField</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.lang.Class, java.util.Collection)">removeFields</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A> fields)</CODE> |
| |
| <BR> |
| Removes <code>fields</code> from the set of 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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.lang.Class, java.lang.String...)">removeFields</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/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 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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.util.Collection)">removeFields</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#removeFields(java.lang.String...)">removeFields</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/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> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.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> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.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> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.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> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#setHint(java.lang.String, java.lang.Object)">setHint</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</CODE> |
| |
| <BR> |
| Set the hint for the given key to the given value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#setLockScope(javax.persistence.PessimisticLockScope)">setLockScope</A></B>(<A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/PessimisticLockScope.html?is-external=true" title="class or interface in javax.persistence">PessimisticLockScope</A> scope)</CODE> |
| |
| <BR> |
| The lock scope 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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#setMaxFetchDepth(int)">setMaxFetchDepth</A></B>(int depth)</CODE> |
| |
| <BR> |
| The maximum fetch depth when loading an object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCache(boolean)">setQueryResultCache</A></B>(boolean cache)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>use <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCacheEnabled(boolean)"><CODE>setQueryResultCacheEnabled(boolean)</CODE></A> instead.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCacheEnabled(boolean)">setQueryResultCacheEnabled</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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#setReadLockMode(javax.persistence.LockModeType)">setReadLockMode</A></B>(<A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</A> mode)</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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#setWriteLockMode(javax.persistence.LockModeType)">setWriteLockMode</A></B>(<A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</A> mode)</CODE> |
| |
| <BR> |
| The lock level to use for locking dirtied objects.</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="GROUP_ALL"><!-- --></A><H3> |
| GROUP_ALL</H3> |
| <PRE> |
| static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>GROUP_ALL</B></PRE> |
| <DL> |
| <DD>Fetch group representing all fields. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.GROUP_ALL">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="GROUP_DEFAULT"><!-- --></A><H3> |
| GROUP_DEFAULT</H3> |
| <PRE> |
| static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>GROUP_DEFAULT</B></PRE> |
| <DL> |
| <DD>The default fetch group. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.GROUP_DEFAULT">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="DEPTH_INFINITE"><!-- --></A><H3> |
| DEPTH_INFINITE</H3> |
| <PRE> |
| static final int <B>DEPTH_INFINITE</B></PRE> |
| <DL> |
| <DD>Infinite fetch depth. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.DEPTH_INFINITE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="DEFAULT"><!-- --></A><H3> |
| DEFAULT</H3> |
| <PRE> |
| static final int <B>DEFAULT</B></PRE> |
| <DL> |
| <DD>Constant to revert any setting to its default value. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.persistence.FetchPlan.DEFAULT">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="getMaxFetchDepth()"><!-- --></A><H3> |
| getMaxFetchDepth</H3> |
| <PRE> |
| int <B>getMaxFetchDepth</B>()</PRE> |
| <DL> |
| <DD>The maximum fetch depth when loading an object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setMaxFetchDepth(int)"><!-- --></A><H3> |
| setMaxFetchDepth</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>setMaxFetchDepth</B>(int depth)</PRE> |
| <DL> |
| <DD>The maximum fetch depth when loading an object. |
| <P> |
| <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> |
| </DL> |
| <HR> |
| |
| <A NAME="setFetchBatchSize(int)"><!-- --></A><H3> |
| setFetchBatchSize</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</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> |
| </DL> |
| <HR> |
| |
| <A NAME="getQueryResultCacheEnabled()"><!-- --></A><H3> |
| getQueryResultCacheEnabled</H3> |
| <PRE> |
| boolean <B>getQueryResultCacheEnabled</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> |
| <DT><B>Since:</B></DT> |
| <DD>1.0.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setQueryResultCacheEnabled(boolean)"><!-- --></A><H3> |
| setQueryResultCacheEnabled</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>setQueryResultCacheEnabled</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> |
| <DT><B>Since:</B></DT> |
| <DD>1.0.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getQueryResultCache()"><!-- --></A><H3> |
| getQueryResultCache</H3> |
| <PRE> |
| boolean <B>getQueryResultCache</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>use <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#getQueryResultCacheEnabled()"><CODE>getQueryResultCacheEnabled()</CODE></A> instead.</I> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setQueryResultCache(boolean)"><!-- --></A><H3> |
| setQueryResultCache</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>setQueryResultCache</B>(boolean cache)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>use <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html#setQueryResultCacheEnabled(boolean)"><CODE>setQueryResultCacheEnabled(boolean)</CODE></A> instead.</I> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFetchGroups()"><!-- --></A><H3> |
| getFetchGroups</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://java.sun.com/j2se/1.5.0/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 the names of the fetch groups that this component will use |
| when loading objects. Defaults to the |
| <code>openjpa.FetchGroups</code> setting. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addFetchGroup(java.lang.String)"><!-- --></A><H3> |
| addFetchGroup</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>addFetchGroup</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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 to |
| use when loading objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addFetchGroups(java.lang.String...)"><!-- --></A><H3> |
| addFetchGroups</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>addFetchGroups</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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> |
| </DL> |
| <HR> |
| |
| <A NAME="addFetchGroups(java.util.Collection)"><!-- --></A><H3> |
| addFetchGroups</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>addFetchGroups</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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> |
| </DL> |
| <HR> |
| |
| <A NAME="removeFetchGroup(java.lang.String)"><!-- --></A><H3> |
| removeFetchGroup</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>removeFetchGroup</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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> |
| </DL> |
| <HR> |
| |
| <A NAME="removeFetchGroups(java.lang.String...)"><!-- --></A><H3> |
| removeFetchGroups</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>removeFetchGroups</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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> |
| </DL> |
| <HR> |
| |
| <A NAME="removeFetchGroups(java.util.Collection)"><!-- --></A><H3> |
| removeFetchGroups</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>removeFetchGroups</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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> |
| </DL> |
| <HR> |
| |
| <A NAME="clearFetchGroups()"><!-- --></A><H3> |
| clearFetchGroups</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>clearFetchGroups</B>()</PRE> |
| <DL> |
| <DD>Clears the set of fetch group names to use wen 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> |
| </DL> |
| <HR> |
| |
| <A NAME="resetFetchGroups()"><!-- --></A><H3> |
| resetFetchGroups</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</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> |
| </DL> |
| <HR> |
| |
| <A NAME="getFields()"><!-- --></A><H3> |
| getFields</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="http://java.sun.com/j2se/1.5.0/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 fully qualified names of the fields that this component |
| will use when loading objects. Defaults to the empty set. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasField(java.lang.String)"><!-- --></A><H3> |
| hasField</H3> |
| <PRE> |
| boolean <B>hasField</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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 field has been added. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasField(java.lang.Class, java.lang.String)"><!-- --></A><H3> |
| hasField</H3> |
| <PRE> |
| boolean <B>hasField</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/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 field has been added. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addField(java.lang.String)"><!-- --></A><H3> |
| addField</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>addField</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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> |
| </DL> |
| <HR> |
| |
| <A NAME="addField(java.lang.Class, java.lang.String)"><!-- --></A><H3> |
| addField</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>addField</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/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 field names to |
| use when loading objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addFields(java.lang.String...)"><!-- --></A><H3> |
| addFields</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>addFields</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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> |
| </DL> |
| <HR> |
| |
| <A NAME="addFields(java.lang.Class, java.lang.String...)"><!-- --></A><H3> |
| addFields</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>addFields</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/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 field names to |
| use when loading objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addFields(java.util.Collection)"><!-- --></A><H3> |
| addFields</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>addFields</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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> |
| </DL> |
| <HR> |
| |
| <A NAME="addFields(java.lang.Class, java.util.Collection)"><!-- --></A><H3> |
| addFields</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>addFields</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A> fields)</PRE> |
| <DL> |
| <DD>Adds <code>fields</code> to the set of field names to |
| use when loading objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeField(java.lang.String)"><!-- --></A><H3> |
| removeField</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>removeField</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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> |
| </DL> |
| <HR> |
| |
| <A NAME="removeField(java.lang.Class, java.lang.String)"><!-- --></A><H3> |
| removeField</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>removeField</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/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 field. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeFields(java.lang.String...)"><!-- --></A><H3> |
| removeFields</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>removeFields</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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> |
| </DL> |
| <HR> |
| |
| <A NAME="removeFields(java.lang.Class, java.lang.String...)"><!-- --></A><H3> |
| removeFields</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>removeFields</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/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 field names |
| to use when loading objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeFields(java.util.Collection)"><!-- --></A><H3> |
| removeFields</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>removeFields</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</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> |
| </DL> |
| <HR> |
| |
| <A NAME="removeFields(java.lang.Class, java.util.Collection)"><!-- --></A><H3> |
| removeFields</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>removeFields</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> cls, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A> fields)</PRE> |
| <DL> |
| <DD>Removes <code>fields</code> from the set of field names |
| to use when loading objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearFields()"><!-- --></A><H3> |
| clearFields</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>clearFields</B>()</PRE> |
| <DL> |
| <DD>Clears the set of field names to use wen 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> |
| </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> |
| </DL> |
| <HR> |
| |
| <A NAME="setLockTimeout(int)"><!-- --></A><H3> |
| setLockTimeout</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</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> |
| </DL> |
| <HR> |
| |
| <A NAME="getLockScope()"><!-- --></A><H3> |
| getLockScope</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/PessimisticLockScope.html?is-external=true" title="class or interface in javax.persistence">PessimisticLockScope</A> <B>getLockScope</B>()</PRE> |
| <DL> |
| <DD>The lock scope to use for locking loaded objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLockScope(javax.persistence.PessimisticLockScope)"><!-- --></A><H3> |
| setLockScope</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>setLockScope</B>(<A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/PessimisticLockScope.html?is-external=true" title="class or interface in javax.persistence">PessimisticLockScope</A> scope)</PRE> |
| <DL> |
| <DD>The lock scope to use for locking loaded objects. |
| <P> |
| <DD><DL> |
| </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> |
| </DL> |
| <HR> |
| |
| <A NAME="setQueryTimeout(int)"><!-- --></A><H3> |
| setQueryTimeout</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</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> |
| </DL> |
| <HR> |
| |
| <A NAME="getReadLockMode()"><!-- --></A><H3> |
| getReadLockMode</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</A> <B>getReadLockMode</B>()</PRE> |
| <DL> |
| <DD>The lock level to use for locking loaded objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setReadLockMode(javax.persistence.LockModeType)"><!-- --></A><H3> |
| setReadLockMode</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>setReadLockMode</B>(<A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</A> mode)</PRE> |
| <DL> |
| <DD>The lock level to use for locking loaded objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getWriteLockMode()"><!-- --></A><H3> |
| getWriteLockMode</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</A> <B>getWriteLockMode</B>()</PRE> |
| <DL> |
| <DD>The lock level to use for locking dirtied objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setWriteLockMode(javax.persistence.LockModeType)"><!-- --></A><H3> |
| setWriteLockMode</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>setWriteLockMode</B>(<A HREF="http://java.sun.com/javaee/6/docs/api/javax/persistence/LockModeType.html?is-external=true" title="class or interface in javax.persistence">LockModeType</A> mode)</PRE> |
| <DL> |
| <DD>The lock level to use for locking dirtied objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDelegate()"><!-- --></A><H3> |
| getDelegate</H3> |
| <PRE> |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> <B>getDelegate</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>cast to <A HREF="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><CODE>FetchPlanImpl</CODE></A> instead. This |
| method pierces the published-API boundary, as does the SPI cast.</I> |
| <P> |
| <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> |
| <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/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <B>setExtendedPathLookup</B>(boolean flag)</PRE> |
| <DL> |
| <DD>Sets extended path lookup feature. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0.0</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> |
| <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> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <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> |
| <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> |
| <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> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlan.html" title="interface in org.apache.openjpa.persistence">FetchPlan</A> <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> |
| <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://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)</PRE> |
| <DL> |
| <DD>Set the hint for the given key to the given value. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value of the hint.<DD><CODE>name</CODE> - the name of the hint.<DT><B>Since:</B></DT> |
| <DD>2.0.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHints()"><!-- --></A><H3> |
| getHints</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://java.sun.com/j2se/1.5.0/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 the hints and their values currently set on this receiver. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>empty map if no hint has been set.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHint(java.lang.String)"><!-- --></A><H3> |
| getHint</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getHint</B>(<A HREF="http://java.sun.com/j2se/1.5.0/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 given key. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>null if the key has not been set.</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/FetchPlan.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/persistence/FetchGroups.html" title="annotation in org.apache.openjpa.persistence"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/openjpa/persistence/FetchPlanImpl.html" title="class in org.apache.openjpa.persistence"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/persistence/FetchPlan.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="FetchPlan.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-2010 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
