| <!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> | |
| FinderCache (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="FinderCache (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/FinderCache.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/FindCallbacks.html" title="interface in org.apache.openjpa.kernel"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/openjpa/kernel/FinderQuery.html" title="interface 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/FinderCache.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="FinderCache.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | 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 FinderCache<K,V,R></H2> | |
| <DL> | |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></DD> | |
| </DL> | |
| <DL> | |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/openjpa/jdbc/kernel/FinderCacheImpl.html" title="class in org.apache.openjpa.jdbc.kernel">FinderCacheImpl</A></DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public interface <B>FinderCache<K,V,R></B><DT>extends <A HREF="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></DL> | |
| </PRE> | |
| <P> | |
| A cache to create and maintain <A HREF="../../../../org/apache/openjpa/kernel/FinderQuery.html" title="interface in org.apache.openjpa.kernel"><CODE>finder queries</CODE></A>. | |
| A finder query is a query to find instance of a given class by its primary | |
| identity. This cache maintains finder queries by generic identifier of | |
| parameterized type K. | |
| A cached query by an identifier of parameterized type K. | |
| A query can be cached by an identifier and value represented by parameterized | |
| type V. Caching results in creating a new instance of FinderQuery FQ from the | |
| value V such that FQ can be executed to return a result of parameterized type | |
| R. A request to cache may not be successful if this cache determines the | |
| value V to be not cachable. | |
| Both get() and put() operations can be controlled by the hints associated | |
| with FetchConfiguration. | |
| The target database query FQ associated to a cached finder query F | |
| <em>may</em> depend upon query execution context such as fetch plan or | |
| lock group. This cache, by design, does not monitor the context or | |
| automatically invalidate an entry when the original query F is executed | |
| with context parameters that affect the target query FQ. | |
| The user must notify this receiver to invalidate a cached entry when | |
| execution context changes in a way that will modify the resultant database | |
| language query FQ. | |
| One of the built-in mechanism (available in JPA facade) is to set query hints | |
| to either invalidate the query entirely or ignore the cached version for the | |
| current execution. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Since:</B></DT> | |
| <DD>2.0.0</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD>Pinaki Poddar</DD> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/QueryHints.html#HINT_IGNORE_FINDER"><CODE>QueryHints.HINT_IGNORE_FINDER</CODE></A>, | |
| <A HREF="../../../../org/apache/openjpa/kernel/QueryHints.html#HINT_INVALIDATE_FINDER"><CODE>QueryHints.HINT_INVALIDATE_FINDER</CODE></A>, | |
| <A HREF="../../../../org/apache/openjpa/kernel/QueryHints.html#HINT_RECACHE_FINDER"><CODE>This cache allows customization of whether a query can be cached or not | |
| via either explicit marking of certain classes as non-cachable (which is | |
| irreversible) or addition/removal of exclusion patterns (which is reversible)</CODE></A></DL> | |
| <HR> | |
| <P> | |
| <!-- ========== 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> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html#addExclusionPattern(java.lang.String)">addExclusionPattern</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> pattern)</CODE> | |
| <BR> | |
| Adds the given pattern to the list of excluded patterns.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/openjpa/kernel/FinderQuery.html" title="interface in org.apache.openjpa.kernel">FinderQuery</A><<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">V</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">R</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html#cache(K, V, org.apache.openjpa.kernel.FetchConfiguration)">cache</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key, | |
| <A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">V</A> value, | |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch)</CODE> | |
| <BR> | |
| Cache a FinderQuery for the given key and value.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/openjpa/kernel/FinderQuery.html" title="interface in org.apache.openjpa.kernel">FinderQuery</A><<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">V</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">R</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html#get(K, org.apache.openjpa.kernel.FetchConfiguration)">get</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key, | |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch)</CODE> | |
| <BR> | |
| Get the FinderQuery 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://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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/FinderCache.html#getExcludes()">getExcludes</A></B>()</CODE> | |
| <BR> | |
| Gets the excluded stringified keys.</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/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/FinderCache.html#getMapView()">getMapView</A></B>()</CODE> | |
| <BR> | |
| Get a map view of the cached entries as strings.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/openjpa/kernel/QueryStatistics.html" title="interface in org.apache.openjpa.kernel">QueryStatistics</A><<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html#getStatistics()">getStatistics</A></B>()</CODE> | |
| <BR> | |
| Gets the simple statistics for executed finder queries.</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/FinderCache.html#invalidate(K)">invalidate</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key)</CODE> | |
| <BR> | |
| Remove the FinderQuery for the given key from this cache.</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/FinderCache.html#isExcluded(K)">isExcluded</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key)</CODE> | |
| <BR> | |
| Affirms if the given key matches any of the exclusion patterns.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../org/apache/openjpa/kernel/FinderQuery.html" title="interface in org.apache.openjpa.kernel">FinderQuery</A><<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">V</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">R</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html#markUncachable(K)">markUncachable</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key)</CODE> | |
| <BR> | |
| Marks the given key as not amenable to caching.</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/FinderCache.html#removeExclusionPattern(java.lang.String)">removeExclusionPattern</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> pattern)</CODE> | |
| <BR> | |
| Removes the given pattern from the list of excluded patterns.</TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.lib.conf.Configurable"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.lib.conf.<A HREF="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration()">endConfiguration</A>, <A HREF="../../../../org/apache/openjpa/lib/conf/Configurable.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</A>, <A HREF="../../../../org/apache/openjpa/lib/conf/Configurable.html#startConfiguration()">startConfiguration</A></CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ 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="get(java.lang.Object,org.apache.openjpa.kernel.FetchConfiguration)"><!-- --></A><A NAME="get(K, org.apache.openjpa.kernel.FetchConfiguration)"><!-- --></A><H3> | |
| get</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/openjpa/kernel/FinderQuery.html" title="interface in org.apache.openjpa.kernel">FinderQuery</A><<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">V</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">R</A>> <B>get</B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key, | |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch)</PRE> | |
| <DL> | |
| <DD>Get the FinderQuery for the given key. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - for which the finder is looked up<DD><CODE>fecth</CODE> - may contain hints to control lookup operation | |
| <DT><B>Returns:</B><DD>FinderQuery for the given mapping.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="cache(java.lang.Object,java.lang.Object,org.apache.openjpa.kernel.FetchConfiguration)"><!-- --></A><A NAME="cache(K, V, org.apache.openjpa.kernel.FetchConfiguration)"><!-- --></A><H3> | |
| cache</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/openjpa/kernel/FinderQuery.html" title="interface in org.apache.openjpa.kernel">FinderQuery</A><<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">V</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">R</A>> <B>cache</B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key, | |
| <A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">V</A> value, | |
| <A HREF="../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch)</PRE> | |
| <DL> | |
| <DD>Cache a FinderQuery for the given key and value. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - for which the finder is cached.<DD><CODE>value</CODE> - used to construct the finder query<DD><CODE>fetch</CODE> - may contain hints to control cache operation. | |
| <DT><B>Returns:</B><DD>the finder query that has been cached. It may be newly | |
| constructed or an existing query. If the given key-value can not be | |
| cached, then return null.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getMapView()"><!-- --></A><H3> | |
| getMapView</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/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getMapView</B>()</PRE> | |
| <DL> | |
| <DD>Get a map view of the cached entries as strings. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="invalidate(java.lang.Object)"><!-- --></A><A NAME="invalidate(K)"><!-- --></A><H3> | |
| invalidate</H3> | |
| <PRE> | |
| boolean <B>invalidate</B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key)</PRE> | |
| <DL> | |
| <DD>Remove the FinderQuery for the given key from this cache. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="markUncachable(java.lang.Object)"><!-- --></A><A NAME="markUncachable(K)"><!-- --></A><H3> | |
| markUncachable</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/openjpa/kernel/FinderQuery.html" title="interface in org.apache.openjpa.kernel">FinderQuery</A><<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">V</A>,<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">R</A>> <B>markUncachable</B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key)</PRE> | |
| <DL> | |
| <DD>Marks the given key as not amenable to caching. | |
| Explicit marking helps to avoid repeated computational cost of | |
| determining whether finder for a key can be cached or not. | |
| Explicit marking can not be reversed by removal of exclusion patterns. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>finder query for the given class if it had been cached before. | |
| null otherwise.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isExcluded(java.lang.Object)"><!-- --></A><A NAME="isExcluded(K)"><!-- --></A><H3> | |
| isExcluded</H3> | |
| <PRE> | |
| boolean <B>isExcluded</B>(<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A> key)</PRE> | |
| <DL> | |
| <DD>Affirms if the given key matches any of the exclusion patterns. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getExcludes()"><!-- --></A><H3> | |
| getExcludes</H3> | |
| <PRE> | |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</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>getExcludes</B>()</PRE> | |
| <DL> | |
| <DD>Gets the excluded stringified keys. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addExclusionPattern(java.lang.String)"><!-- --></A><H3> | |
| addExclusionPattern</H3> | |
| <PRE> | |
| void <B>addExclusionPattern</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> pattern)</PRE> | |
| <DL> | |
| <DD>Adds the given pattern to the list of excluded patterns. Any existing | |
| cache entry whose key matches the given pattern will be marked | |
| non-cachable in a reversible manner. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="removeExclusionPattern(java.lang.String)"><!-- --></A><H3> | |
| removeExclusionPattern</H3> | |
| <PRE> | |
| void <B>removeExclusionPattern</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> pattern)</PRE> | |
| <DL> | |
| <DD>Removes the given pattern from the list of excluded patterns. | |
| Any excluded entry that matches the given pattern can now be cached | |
| again, unless it has been marked non-cachable explicitly. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getStatistics()"><!-- --></A><H3> | |
| getStatistics</H3> | |
| <PRE> | |
| <A HREF="../../../../org/apache/openjpa/kernel/QueryStatistics.html" title="interface in org.apache.openjpa.kernel">QueryStatistics</A><<A HREF="../../../../org/apache/openjpa/kernel/FinderCache.html" title="type parameter in FinderCache">K</A>> <B>getStatistics</B>()</PRE> | |
| <DL> | |
| <DD>Gets the simple statistics for executed finder queries. | |
| <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/FinderCache.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/FindCallbacks.html" title="interface in org.apache.openjpa.kernel"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/openjpa/kernel/FinderQuery.html" title="interface 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/FinderCache.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="FinderCache.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | 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> |