| <!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_30) on Thu Feb 16 09:34:37 CST 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| PreparedQueryCacheImpl (OpenJPA Parent POM 2.2.0 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-02-16"> |
| |
| <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="PreparedQueryCacheImpl (OpenJPA Parent POM 2.2.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/PreparedQueryCacheImpl.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/jdbc/kernel/PreparedProjectionResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.StrongExclusion.html" title="class in org.apache.openjpa.jdbc.kernel"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PreparedQueryCacheImpl.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.jdbc.kernel</FONT> |
| <BR> |
| Class PreparedQueryCacheImpl</H2> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.jdbc.kernel.PreparedQueryCacheImpl</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A>, <A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>PreparedQueryCacheImpl</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></DL> |
| </PRE> |
| |
| <P> |
| An implementation of the cache of <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQuery.html" title="interface in org.apache.openjpa.kernel"><CODE>prepared queries</CODE></A>. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>2.0.0</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Pinaki Poddar</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.StrongExclusion.html" title="class in org.apache.openjpa.jdbc.kernel">PreparedQueryCacheImpl.StrongExclusion</A></B></CODE> |
| |
| <BR> |
| Strong exclusion.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.WeakExclusion.html" title="class in org.apache.openjpa.jdbc.kernel">PreparedQueryCacheImpl.WeakExclusion</A></B></CODE> |
| |
| <BR> |
| Weak exclusion.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="nested_classes_inherited_from_class_org.apache.openjpa.kernel.PreparedQueryCache"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.apache.openjpa.kernel.<A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.Exclusion.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache.Exclusion</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#PreparedQueryCacheImpl()">PreparedQueryCacheImpl</A></B>()</CODE> |
| |
| <BR> |
| </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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.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 a pattern for exclusion.</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/jdbc/kernel/PreparedQueryCacheImpl.html#cache(org.apache.openjpa.kernel.PreparedQuery)">cache</A></B>(<A HREF="../../../../../org/apache/openjpa/kernel/PreparedQuery.html" title="interface in org.apache.openjpa.kernel">PreparedQuery</A> q)</CODE> |
| |
| <BR> |
| Cache the given query keyed by its identifier.</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/jdbc/kernel/PreparedQueryCacheImpl.html#clear()">clear</A></B>()</CODE> |
| |
| <BR> |
| Clears all cached queries.</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/jdbc/kernel/PreparedQueryCacheImpl.html#endConfiguration()">endConfiguration</A></B>()</CODE> |
| |
| <BR> |
| Invoked upon completion of bean property configuration for this object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQuery.html" title="interface in org.apache.openjpa.kernel">PreparedQuery</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#get(java.lang.String)">get</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> id)</CODE> |
| |
| <BR> |
| Get the PreparedQuery with the given identifier if it exists.</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/jdbc/kernel/PreparedQueryCacheImpl.html#getEnableStatistics()">getEnableStatistics</A></B>()</CODE> |
| |
| <BR> |
| Affirm if statistics is gathered.</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="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.Exclusion.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache.Exclusion</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#getExcludes()">getExcludes</A></B>()</CODE> |
| |
| <BR> |
| Gets the exclusion patterns.</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/jdbc/kernel/PreparedQueryCacheImpl.html#getMapView()">getMapView</A></B>()</CODE> |
| |
| <BR> |
| Get a map view of the cached queries indexed by identifier.</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="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/jdbc/kernel/PreparedQueryCacheImpl.html#getStatistics()">getStatistics</A></B>()</CODE> |
| |
| <BR> |
| Gets the simple statistics for executed queries.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQuery.html" title="interface in org.apache.openjpa.kernel">PreparedQuery</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#initialize(java.lang.String, java.lang.Object)">initialize</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> result)</CODE> |
| |
| <BR> |
| Initialize the cached Prepared Query registered with the given |
| key earlier by the given execution result.</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/jdbc/kernel/PreparedQueryCacheImpl.html#invalidate(java.lang.String)">invalidate</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> id)</CODE> |
| |
| <BR> |
| Remove the PreparedQuery with the given identifier from this cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#isCachable(java.lang.String)">isCachable</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> id)</CODE> |
| |
| <BR> |
| Affirms if a PreparedQuery can be cached against the given key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.Exclusion.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache.Exclusion</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#isExcluded(java.lang.String)">isExcluded</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> id)</CODE> |
| |
| <BR> |
| Returns the exclusion status of if the given query key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>(package private) boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#isHinted(org.apache.openjpa.kernel.FetchConfiguration, java.lang.String)">isHinted</A></B>(<A HREF="../../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch, |
| <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> hint)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#lock(boolean)">lock</A></B>(boolean readOnly)</CODE> |
| |
| <BR> |
| Note: Care needs to be taken so that a read lock is <b>never</b> held while requesting a write lock.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQuery.html" title="interface in org.apache.openjpa.kernel">PreparedQuery</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#markUncachable(java.lang.String, org.apache.openjpa.kernel.PreparedQueryCache.Exclusion)">markUncachable</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> id, |
| <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.Exclusion.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache.Exclusion</A> exclusion)</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>(package private) boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#matches(java.lang.String, java.lang.String)">matches</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, |
| <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> target)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#register(java.lang.String, org.apache.openjpa.kernel.Query, org.apache.openjpa.kernel.FetchConfiguration)">register</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> id, |
| <A HREF="../../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</A> query, |
| <A HREF="../../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> hints)</CODE> |
| |
| <BR> |
| Register the given query for caching against the given key if it has not |
| already been cached.</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/jdbc/kernel/PreparedQueryCacheImpl.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 a pattern for exclusion.</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/jdbc/kernel/PreparedQueryCacheImpl.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</A></B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A> conf)</CODE> |
| |
| <BR> |
| Invoked prior to setting bean properties.</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/jdbc/kernel/PreparedQueryCacheImpl.html#setEnableStatistics(boolean)">setEnableStatistics</A></B>(boolean enable)</CODE> |
| |
| <BR> |
| Enable/disable gathering of statistics.</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/jdbc/kernel/PreparedQueryCacheImpl.html#setExcludes(java.lang.String)">setExcludes</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> excludes)</CODE> |
| |
| <BR> |
| Sets one or more exclusion regular expression patterns separated by |
| semicolon.</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/jdbc/kernel/PreparedQueryCacheImpl.html#startConfiguration()">startConfiguration</A></B>()</CODE> |
| |
| <BR> |
| Invoked before bean property configuration is begun on this object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html#unlock(boolean)">unlock</A></B>(boolean readOnly)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_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>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="PreparedQueryCacheImpl()"><!-- --></A><H3> |
| PreparedQueryCacheImpl</H3> |
| <PRE> |
| public <B>PreparedQueryCacheImpl</B>()</PRE> |
| <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="register(java.lang.String, org.apache.openjpa.kernel.Query, org.apache.openjpa.kernel.FetchConfiguration)"><!-- --></A><H3> |
| register</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> <B>register</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> id, |
| <A HREF="../../../../../org/apache/openjpa/kernel/Query.html" title="interface in org.apache.openjpa.kernel">Query</A> query, |
| <A HREF="../../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> hints)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#register(java.lang.String, org.apache.openjpa.kernel.Query, org.apache.openjpa.kernel.FetchConfiguration)">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Register the given query for caching against the given key if it has not |
| already been cached. If the query can not be cached, then mark it as such |
| to avoid computing for the same key again. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#register(java.lang.String, org.apache.openjpa.kernel.Query, org.apache.openjpa.kernel.FetchConfiguration)">register</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>TRUE the query is registered in the cache by this call |
| null if the query is already registered in the cache |
| FALSE if can not be registered in the cache, either because |
| it is known not to be cacheable from a previous attempt or |
| a hint is given to ignore the cached version.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMapView()"><!-- --></A><H3> |
| getMapView</H3> |
| <PRE> |
| public <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><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#getMapView()">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Get a map view of the cached queries indexed by identifier. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#getMapView()">getMapView</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="cache(org.apache.openjpa.kernel.PreparedQuery)"><!-- --></A><H3> |
| cache</H3> |
| <PRE> |
| public boolean <B>cache</B>(<A HREF="../../../../../org/apache/openjpa/kernel/PreparedQuery.html" title="interface in org.apache.openjpa.kernel">PreparedQuery</A> q)</PRE> |
| <DL> |
| <DD>Cache the given query keyed by its identifier. Does not cache if the |
| identifier matches any exclusion pattern or has been marked as |
| non-cachable. Also register the identifier as not cachable against |
| the matched exclusion pattern. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#cache(org.apache.openjpa.kernel.PreparedQuery)">cache</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if the given query is cached. false if it can not be cached |
| due to exclusion.<DT><B>See Also:</B><DD><CODE>#markUncachable(String)</CODE>, |
| <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#setExcludes(java.lang.String)"><CODE>PreparedQueryCache.setExcludes(String)</CODE></A>, |
| <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#addExclusionPattern(java.lang.String)"><CODE>PreparedQueryCache.addExclusionPattern(String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initialize(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| initialize</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQuery.html" title="interface in org.apache.openjpa.kernel">PreparedQuery</A> <B>initialize</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> key, |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> result)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#initialize(java.lang.String, java.lang.Object)">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Initialize the cached Prepared Query registered with the given |
| key earlier by the given execution result. If it is not possible to |
| initialize the Prepared Query from the given execution result, then |
| the corresponding key will be marked as invalid for caching. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#initialize(java.lang.String, java.lang.Object)">initialize</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key used during registration<DD><CODE>result</CODE> - an opaque instance carrying the execution result |
| of the original query. |
| <DT><B>Returns:</B><DD>the initialized Prepared Query. If it is not possible to |
| initialize the cached, possibly hollow Prepared Query from the given |
| result, return null.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="invalidate(java.lang.String)"><!-- --></A><H3> |
| invalidate</H3> |
| <PRE> |
| public boolean <B>invalidate</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> id)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#invalidate(java.lang.String)">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Remove the PreparedQuery with the given identifier from this cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#invalidate(java.lang.String)">invalidate</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get(java.lang.String)"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQuery.html" title="interface in org.apache.openjpa.kernel">PreparedQuery</A> <B>get</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> id)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#get(java.lang.String)">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Get the PreparedQuery with the given identifier if it exists. null |
| otherwise. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#get(java.lang.String)">get</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isCachable(java.lang.String)"><!-- --></A><H3> |
| isCachable</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> <B>isCachable</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> id)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#isCachable(java.lang.String)">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Affirms if a PreparedQuery can be cached against the given key. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#isCachable(java.lang.String)">isCachable</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Boolean.FALSE if the given key is explicitly marked before as not |
| be cached or matches any of the exclusion patterns. |
| Boolean.TRUE if the given key currently exists in the cache. |
| Otherwise, return null implying this receiver can not determine whether |
| this key can be cached on not.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="markUncachable(java.lang.String, org.apache.openjpa.kernel.PreparedQueryCache.Exclusion)"><!-- --></A><H3> |
| markUncachable</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQuery.html" title="interface in org.apache.openjpa.kernel">PreparedQuery</A> <B>markUncachable</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> id, |
| <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.Exclusion.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache.Exclusion</A> exclusion)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#markUncachable(java.lang.String, org.apache.openjpa.kernel.PreparedQueryCache.Exclusion)">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Marks the given key as not amenable to caching. |
| Explicit marking helps to avoid repeated computational cost of |
| determining whether a query can be cached or not. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#markUncachable(java.lang.String, org.apache.openjpa.kernel.PreparedQueryCache.Exclusion)">markUncachable</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - is the key to be excluded<DD><CODE>exclusion</CODE> - directs whether exclusion is irreversible or not. |
| <DT><B>Returns:</B><DD>The value for the given key if it had been cached before. null |
| otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isExcluded(java.lang.String)"><!-- --></A><H3> |
| isExcluded</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.Exclusion.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache.Exclusion</A> <B>isExcluded</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> id)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#isExcluded(java.lang.String)">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Returns the exclusion status of if the given query key. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#isExcluded(java.lang.String)">isExcluded</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>null implies that the key is not excluded.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setExcludes(java.lang.String)"><!-- --></A><H3> |
| setExcludes</H3> |
| <PRE> |
| public void <B>setExcludes</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> excludes)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#setExcludes(java.lang.String)">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Sets one or more exclusion regular expression patterns separated by |
| semicolon. Any existing cache entry whose key matches any of the given |
| pattern will be marked non-cachable in a reversible manner. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#setExcludes(java.lang.String)">setExcludes</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExcludes()"><!-- --></A><H3> |
| getExcludes</H3> |
| <PRE> |
| public <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="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.Exclusion.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache.Exclusion</A>> <B>getExcludes</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#getExcludes()">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Gets the exclusion patterns. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#getExcludes()">getExcludes</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addExclusionPattern(java.lang.String)"><!-- --></A><H3> |
| addExclusionPattern</H3> |
| <PRE> |
| public 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 a pattern for exclusion. Any query cached currently whose identifier |
| matches the given pattern will be marked invalidated as a side-effect. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#addExclusionPattern(java.lang.String)">addExclusionPattern</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeExclusionPattern(java.lang.String)"><!-- --></A><H3> |
| removeExclusionPattern</H3> |
| <PRE> |
| public 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 a pattern for exclusion. Any query identifier marked as not |
| cachable due to the given pattern will now be removed from the list of |
| uncachables as a side-effect. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#removeExclusionPattern(java.lang.String)">removeExclusionPattern</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#markUncachable(java.lang.String, org.apache.openjpa.kernel.PreparedQueryCache.Exclusion)"><CODE>PreparedQueryCache.markUncachable(String, Exclusion)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getStatistics()"><!-- --></A><H3> |
| getStatistics</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/openjpa/kernel/QueryStatistics.html" title="interface in org.apache.openjpa.kernel">QueryStatistics</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>getStatistics</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#getStatistics()">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Gets the simple statistics for executed queries. |
| If the statistics gathering is disabled, an empty statistics is returned. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#getStatistics()">getStatistics</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="lock(boolean)"><!-- --></A><H3> |
| lock</H3> |
| <PRE> |
| protected void <B>lock</B>(boolean readOnly)</PRE> |
| <DL> |
| <DD>Note: Care needs to be taken so that a read lock is <b>never</b> held while requesting a write lock. This will |
| result in a deadlock. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>readOnly</CODE> - - If true, a read lock will be acquired. Else a write lock will be acquired.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="unlock(boolean)"><!-- --></A><H3> |
| unlock</H3> |
| <PRE> |
| protected void <B>unlock</B>(boolean readOnly)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>readOnly</CODE> - - If true, the read lock will be released. Else a write lock will be released.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="matches(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| matches</H3> |
| <PRE> |
| boolean <B>matches</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, |
| <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> target)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isHinted(org.apache.openjpa.kernel.FetchConfiguration, java.lang.String)"><!-- --></A><H3> |
| isHinted</H3> |
| <PRE> |
| boolean <B>isHinted</B>(<A HREF="../../../../../org/apache/openjpa/kernel/FetchConfiguration.html" title="interface in org.apache.openjpa.kernel">FetchConfiguration</A> fetch, |
| <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> hint)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clear()"><!-- --></A><H3> |
| clear</H3> |
| <PRE> |
| public void <B>clear</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#clear()">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Clears all cached queries. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#clear()">clear</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setEnableStatistics(boolean)"><!-- --></A><H3> |
| setEnableStatistics</H3> |
| <PRE> |
| public void <B>setEnableStatistics</B>(boolean enable)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#setEnableStatistics(boolean)">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Enable/disable gathering of statistics. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#setEnableStatistics(boolean)">setEnableStatistics</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEnableStatistics()"><!-- --></A><H3> |
| getEnableStatistics</H3> |
| <PRE> |
| public boolean <B>getEnableStatistics</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#getEnableStatistics()">PreparedQueryCache</A></CODE></B></DD> |
| <DD>Affirm if statistics is gathered. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html#getEnableStatistics()">getEnableStatistics</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConfiguration(org.apache.openjpa.lib.conf.Configuration)"><!-- --></A><H3> |
| setConfiguration</H3> |
| <PRE> |
| public void <B>setConfiguration</B>(<A HREF="../../../../../org/apache/openjpa/lib/conf/Configuration.html" title="interface in org.apache.openjpa.lib.conf">Configuration</A> conf)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">Configurable</A></CODE></B></DD> |
| <DD>Invoked prior to setting bean properties. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#setConfiguration(org.apache.openjpa.lib.conf.Configuration)">setConfiguration</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="startConfiguration()"><!-- --></A><H3> |
| startConfiguration</H3> |
| <PRE> |
| public void <B>startConfiguration</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#startConfiguration()">Configurable</A></CODE></B></DD> |
| <DD>Invoked before bean property configuration is begun on this object. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#startConfiguration()">startConfiguration</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="endConfiguration()"><!-- --></A><H3> |
| endConfiguration</H3> |
| <PRE> |
| public void <B>endConfiguration</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration()">Configurable</A></CODE></B></DD> |
| <DD>Invoked upon completion of bean property configuration for this object. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html#endConfiguration()">endConfiguration</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></CODE></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/PreparedQueryCacheImpl.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/jdbc/kernel/PreparedProjectionResultObjectProvider.html" title="class in org.apache.openjpa.jdbc.kernel"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.StrongExclusion.html" title="class in org.apache.openjpa.jdbc.kernel"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/openjpa/jdbc/kernel/PreparedQueryCacheImpl.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="PreparedQueryCacheImpl.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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2012 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
