| <!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.5.0_06) on Sat Oct 14 18:41:56 PDT 2006 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| AbstractDataCache (OpenJPA 0.9.0-incubating API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.datacache.AbstractDataCache class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="AbstractDataCache (OpenJPA 0.9.0-incubating API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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/AbstractDataCache.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"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/openjpa/datacache/AbstractQueryCache.html" title="class in org.apache.openjpa.datacache"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/datacache/AbstractDataCache.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="AbstractDataCache.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> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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.datacache</FONT> |
| <BR> |
| Class AbstractDataCache</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">org.apache.openjpa.lib.util.concurrent.AbstractConcurrentEventManager</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.datacache.AbstractDataCache</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A>, <A HREF="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A>, <A HREF="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</A>, <A HREF="../../../../org/apache/openjpa/lib/util/EventManager.html" title="interface in org.apache.openjpa.lib.util">EventManager</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/openjpa/datacache/ConcurrentDataCache.html" title="class in org.apache.openjpa.datacache">ConcurrentDataCache</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>AbstractDataCache</B><DT>extends <A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">AbstractConcurrentEventManager</A><DT>implements <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A>, <A HREF="../../../../org/apache/openjpa/lib/conf/Configurable.html" title="interface in org.apache.openjpa.lib.conf">Configurable</A></DL> |
| </PRE> |
| |
| <P> |
| Abstract <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache"><CODE>DataCache</CODE></A> implementation that provides various |
| statistics, logging, and timeout functionality common across cache |
| implementations. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Patrick Linskey, Abe White</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>protected <A HREF="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#conf">conf</A></B></CODE> |
| |
| <BR> |
| The configuration set by the system.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/apache/openjpa/lib/log/Log.html" title="interface in org.apache.openjpa.lib.log">Log</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#log">log</A></B></CODE> |
| |
| <BR> |
| The log to use.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.datacache.DataCache"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from interface org.apache.openjpa.datacache.<A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#NAME_DEFAULT">NAME_DEFAULT</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/datacache/AbstractDataCache.html#AbstractDataCache()">AbstractDataCache</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/datacache/AbstractDataCache.html#addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">addExpirationListener</A></B>(<A HREF="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</A> listen)</CODE> |
| |
| <BR> |
| Add a new expiration event listener to this cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#afterCommit(org.apache.openjpa.event.RemoteCommitEvent)">afterCommit</A></B>(<A HREF="../../../../org/apache/openjpa/event/RemoteCommitEvent.html" title="class in org.apache.openjpa.event">RemoteCommitEvent</A> event)</CODE> |
| |
| <BR> |
| This method is part of the <A HREF="../../../../org/apache/openjpa/event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event"><CODE>RemoteCommitListener</CODE></A> interface.</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/datacache/AbstractDataCache.html#clear()">clear</A></B>()</CODE> |
| |
| <BR> |
| Remove all data from this cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#clearInternal()">clearInternal</A></B>()</CODE> |
| |
| <BR> |
| Clear the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#close()">close</A></B>()</CODE> |
| |
| <BR> |
| Free the resources used by this cache.</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/datacache/AbstractDataCache.html#close(boolean)">close</A></B>(boolean clear)</CODE> |
| |
| <BR> |
| </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/datacache/AbstractDataCache.html#commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)">commit</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> additions, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> newUpdates, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> existingUpdates, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> deletes)</CODE> |
| |
| <BR> |
| Perform a batch update of the 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/datacache/AbstractDataCache.html#contains(java.lang.Object)">contains</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</CODE> |
| |
| <BR> |
| Returns <code>true</code> if this cache contains data |
| corresponding to <code>oid</code>; otherwise returns |
| <code>false</code>.</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/BitSet.html" title="class or interface in java.util">BitSet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#containsAll(java.util.Collection)">containsAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> keys)</CODE> |
| |
| <BR> |
| Returns the indexes of the oids in this cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.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>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#fireEvent(java.lang.Object, java.lang.Object)">fireEvent</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> event, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> listener)</CODE> |
| |
| <BR> |
| Implement this method to fire the given event to the given listener.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#get(java.lang.Object)">get</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</CODE> |
| |
| <BR> |
| Return the cached object for the given oid.</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/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getEvictionSchedule()">getEvictionSchedule</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getInternal(java.lang.Object)">getInternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid)</CODE> |
| |
| <BR> |
| Return the object for the given oid.</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/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#getName()">getName</A></B>()</CODE> |
| |
| <BR> |
| Returns a string name that can be used by end-user-visible |
| code to identify this cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">initialize</A></B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</A> manager)</CODE> |
| |
| <BR> |
| Initialize any resources associated with the given |
| <A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache"><CODE>DataCacheManager</CODE></A>.</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/datacache/AbstractDataCache.html#isClosed()">isClosed</A></B>()</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/datacache/AbstractDataCache.html#keyRemoved(java.lang.Object, boolean)">keyRemoved</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key, |
| boolean expired)</CODE> |
| |
| <BR> |
| Invoke when a key is removed 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/datacache/AbstractDataCache.html#pin(java.lang.Object)">pin</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</CODE> |
| |
| <BR> |
| Pin the value stored under <code>oid</code> into the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#pinAll(java.lang.Class, boolean)">pinAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| boolean subs)</CODE> |
| |
| <BR> |
| Pin all oids for the given type.</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/BitSet.html" title="class or interface in java.util">BitSet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#pinAll(java.util.Collection)">pinAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> keys)</CODE> |
| |
| <BR> |
| Pin all oids to the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#pinInternal(java.lang.Object)">pinInternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid)</CODE> |
| |
| <BR> |
| Pin an object to the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)">put</A></B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> data)</CODE> |
| |
| <BR> |
| Set the cached value for the given instance.</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/datacache/AbstractDataCache.html#putAllInternal(java.util.Collection)">putAllInternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pcs)</CODE> |
| |
| <BR> |
| All all of the given objects to the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#putInternal(java.lang.Object, org.apache.openjpa.datacache.DataCachePCData)">putInternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid, |
| <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> pc)</CODE> |
| |
| <BR> |
| Add the given object to the cache, returning the old object under the |
| given oid.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#recacheUpdates()">recacheUpdates</A></B>()</CODE> |
| |
| <BR> |
| Return <code>true</code> if updates to data already in the |
| cache (either in <A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)"><CODE>commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)</CODE></A> or the <A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)"><CODE>update(org.apache.openjpa.datacache.DataCachePCData)</CODE></A>) |
| should be put back into the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#remove(java.lang.Object)">remove</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</CODE> |
| |
| <BR> |
| Remove the value stored under the given oid.</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/datacache/AbstractDataCache.html#removeAll(java.lang.Class, boolean)">removeAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| boolean subClasses)</CODE> |
| |
| <BR> |
| Remove the objects of the given class from the cache.</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/BitSet.html" title="class or interface in java.util">BitSet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeAll(java.util.Collection)">removeAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> keys)</CODE> |
| |
| <BR> |
| Remove the values stored under the given oids.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeAllInternal(java.lang.Class, boolean)">removeAllInternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| boolean subclasses)</CODE> |
| |
| <BR> |
| Evict objects in cache by class.</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/datacache/AbstractDataCache.html#removeAllInternal(java.util.Collection)">removeAllInternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> oids)</CODE> |
| |
| <BR> |
| Remove all objects under the given oids from the cache.</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/datacache/AbstractDataCache.html#removeAllTypeNamesInternal(java.util.Collection)">removeAllTypeNamesInternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> classNames)</CODE> |
| |
| <BR> |
| Remove all objects of the given class names from the 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/datacache/AbstractDataCache.html#removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">removeExpirationListener</A></B>(<A HREF="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</A> listen)</CODE> |
| |
| <BR> |
| Remove an expiration event listener from this cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#removeInternal(java.lang.Object)">removeInternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid)</CODE> |
| |
| <BR> |
| Remove the object under the given oid from the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.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/datacache/AbstractDataCache.html#setEvictionSchedule(java.lang.String)">setEvictionSchedule</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> s)</CODE> |
| |
| <BR> |
| </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/datacache/AbstractDataCache.html#setName(java.lang.String)">setName</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> |
| |
| <BR> |
| Sets a string name to be used to identify this cache to end-user needs.</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/datacache/AbstractDataCache.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> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#toString()">toString</A></B>()</CODE> |
| |
| <BR> |
| </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/datacache/AbstractDataCache.html#unpin(java.lang.Object)">unpin</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</CODE> |
| |
| <BR> |
| Unpin the value stored under <code>oid</code> from the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#unpinAll(java.lang.Class, boolean)">unpinAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| boolean subs)</CODE> |
| |
| <BR> |
| Unpin all oids associaed with the given type from the cache.</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/BitSet.html" title="class or interface in java.util">BitSet</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#unpinAll(java.util.Collection)">unpinAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> keys)</CODE> |
| |
| <BR> |
| Unpin all oids from the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#unpinInternal(java.lang.Object)">unpinInternal</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid)</CODE> |
| |
| <BR> |
| Unpin an object from the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)">update</A></B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> data)</CODE> |
| |
| <BR> |
| Update the cached value for the given instance.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.lib.util.concurrent.AbstractConcurrentEventManager"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.openjpa.lib.util.concurrent.<A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">AbstractConcurrentEventManager</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#addListener(java.lang.Object)">addListener</A>, <A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#fireEvent(java.lang.Object)">fireEvent</A>, <A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#getListeners()">getListeners</A>, <A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#hasListener(java.lang.Object)">hasListener</A>, <A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#hasListeners()">hasListeners</A>, <A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#isFailFast()">isFailFast</A>, <A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#newListenerCollection()">newListenerCollection</A>, <A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#removeListener(java.lang.Object)">removeListener</A>, <A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#setFailFast(boolean)">setFailFast</A></CODE></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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.datacache.DataCache"><!-- --></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.datacache.<A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#writeLock()">writeLock</A>, <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#writeUnlock()">writeUnlock</A></CODE></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="conf"><!-- --></A><H3> |
| conf</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</A> <B>conf</B></PRE> |
| <DL> |
| <DD>The configuration set by the system. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="log"><!-- --></A><H3> |
| log</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/openjpa/lib/log/Log.html" title="interface in org.apache.openjpa.lib.log">Log</A> <B>log</B></PRE> |
| <DL> |
| <DD>The log to use. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= 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="AbstractDataCache()"><!-- --></A><H3> |
| AbstractDataCache</H3> |
| <PRE> |
| public <B>AbstractDataCache</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="getName()"><!-- --></A><H3> |
| getName</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#getName()">DataCache</A></CODE></B></DD> |
| <DD>Returns a string name that can be used by end-user-visible |
| code to identify this cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setName(java.lang.String)"><!-- --></A><H3> |
| setName</H3> |
| <PRE> |
| public void <B>setName</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#setName(java.lang.String)">DataCache</A></CODE></B></DD> |
| <DD>Sets a string name to be used to identify this cache to end-user needs. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#setName(java.lang.String)">setName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEvictionSchedule()"><!-- --></A><H3> |
| getEvictionSchedule</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getEvictionSchedule</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setEvictionSchedule(java.lang.String)"><!-- --></A><H3> |
| setEvictionSchedule</H3> |
| <PRE> |
| public void <B>setEvictionSchedule</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> s)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initialize(org.apache.openjpa.datacache.DataCacheManager)"><!-- --></A><H3> |
| initialize</H3> |
| <PRE> |
| public void <B>initialize</B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</A> manager)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">DataCache</A></CODE></B></DD> |
| <DD>Initialize any resources associated with the given |
| <A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache"><CODE>DataCacheManager</CODE></A>. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#initialize(org.apache.openjpa.datacache.DataCacheManager)">initialize</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)"><!-- --></A><H3> |
| commit</H3> |
| <PRE> |
| public void <B>commit</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> additions, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> newUpdates, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> existingUpdates, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> deletes)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)">DataCache</A></CODE></B></DD> |
| <DD>Perform a batch update of the cache. Add all <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache"><CODE>DataCachePCData</CODE></A> |
| objects in <code>additions</code> and in |
| <code>newUpdates</code>, make the appropriate modifications to |
| all DataCachePCDatas in <code>existingUpdates</code>, and delete all |
| OIDs in <code>deletes</code>. |
| All changes made to cached data must be made via this |
| method. It is this method that is responsible for performing |
| any side-effects that should happen on meaningful cache changes. |
| Implementations should bear in mind that the |
| <code>deletes</code> collection may contain oids that are also |
| in the <code>additions</code> map. This is possible because it |
| is valid for a user to delete an object with a particular oid |
| and then add that object in the same batch. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)">commit</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>additions</CODE> - A collection of <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache"><CODE>DataCachePCData</CODE></A> objects. |
| These represent data that have been newly created, |
| and thus must be added to the cache.<DD><CODE>newUpdates</CODE> - A collection of <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache"><CODE>DataCachePCData</CODE></A> objects. |
| These represent data that have been modified but |
| were not originally in the cache, and thus must be added to the cache.<DD><CODE>existingUpdates</CODE> - A collection of <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache"><CODE>DataCachePCData</CODE></A> objects. |
| These represent data that have been modified and |
| were originally loaded from the cache. It is |
| up to the cache implementation to decide if |
| these values must be re-enlisted in the cache. |
| Some caches may return live data from <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)"><CODE>DataCache.get(java.lang.Object)</CODE></A> |
| invocations, in which case these values need not be re-enlisted.<DD><CODE>deletes</CODE> - A collection of object IDs that have been deleted |
| and must therefore be dropped from the cache.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="contains(java.lang.Object)"><!-- --></A><H3> |
| contains</H3> |
| <PRE> |
| public boolean <B>contains</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#contains(java.lang.Object)">DataCache</A></CODE></B></DD> |
| <DD>Returns <code>true</code> if this cache contains data |
| corresponding to <code>oid</code>; otherwise returns |
| <code>false</code>. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#contains(java.lang.Object)">contains</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="containsAll(java.util.Collection)"><!-- --></A><H3> |
| containsAll</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/BitSet.html" title="class or interface in java.util">BitSet</A> <B>containsAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> keys)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#containsAll(java.util.Collection)">DataCache</A></CODE></B></DD> |
| <DD>Returns the indexes of the oids in this cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#containsAll(java.util.Collection)">containsAll</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get(java.lang.Object)"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> <B>get</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)">DataCache</A></CODE></B></DD> |
| <DD>Return the cached object for the given oid. Modifying the returned |
| object may or may not change the cached value; the <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)"><CODE>DataCache.update(org.apache.openjpa.datacache.DataCachePCData)</CODE></A> |
| method should be used to re-cache any changed objects. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)">get</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the object matching the given oid, or null if none</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="put(org.apache.openjpa.datacache.DataCachePCData)"><!-- --></A><H3> |
| put</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> <B>put</B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> data)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)">DataCache</A></CODE></B></DD> |
| <DD>Set the cached value for the given instance. This does <em>not</em> |
| result in an update of other caches. Rather, it should only be |
| used for loading clean data into the cache. Meaningful changes |
| to the state of the cache should be made via the <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)"><CODE>DataCache.commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)</CODE></A> method. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)">put</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The previously cached value, or <code>null</code> if |
| the value was not previously cached. See <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html#put(K, V)" title="class or interface in java.util"><CODE>Map.put(K, V)</CODE></A> |
| for more information.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="update(org.apache.openjpa.datacache.DataCachePCData)"><!-- --></A><H3> |
| update</H3> |
| <PRE> |
| public void <B>update</B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> data)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)">DataCache</A></CODE></B></DD> |
| <DD>Update the cached value for the given instance. This does |
| <em>not</em> result in an update of other caches. Rather, it should |
| only be used for loading clean data into the cache. Meaningful changes |
| to the state of the cache should be made via the <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)"><CODE>DataCache.commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)</CODE></A> method. |
| A cache implementation may or may not return a live object |
| from <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)"><CODE>DataCache.get(java.lang.Object)</CODE></A> invocations. If an object retrieved from a |
| <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)"><CODE>DataCache.get(java.lang.Object)</CODE></A> operation needs to be updated, this method can be |
| invoked instead of invoking <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#put(org.apache.openjpa.datacache.DataCachePCData)"><CODE>DataCache.put(org.apache.openjpa.datacache.DataCachePCData)</CODE></A>. The DataCache implementation |
| can then make optimizations based on how its <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#get(java.lang.Object)"><CODE>DataCache.get(java.lang.Object)</CODE></A> method works. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)">update</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="remove(java.lang.Object)"><!-- --></A><H3> |
| remove</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> <B>remove</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#remove(java.lang.Object)">DataCache</A></CODE></B></DD> |
| <DD>Remove the value stored under the given oid. This does |
| <em>not</em> result in an update of other caches. Rather, it |
| should only be used for removing data in the cache. |
| Meaningful changes to the state of the cache should be made |
| via the <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)"><CODE>DataCache.commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)</CODE></A> method. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#remove(java.lang.Object)">remove</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>The previously cached value, or <code>null</code> if |
| the oid was not previously cached. See <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html#remove(java.lang.Object)" title="class or interface in java.util"><CODE>Map.remove(java.lang.Object)</CODE></A> |
| for more information.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAll(java.util.Collection)"><!-- --></A><H3> |
| removeAll</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/BitSet.html" title="class or interface in java.util">BitSet</A> <B>removeAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> keys)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#removeAll(java.util.Collection)">DataCache</A></CODE></B></DD> |
| <DD>Remove the values stored under the given oids. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#removeAll(java.util.Collection)">removeAll</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the indexes of the removed oids<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#remove(java.lang.Object)"><CODE>DataCache.remove(java.lang.Object)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAll(java.lang.Class, boolean)"><!-- --></A><H3> |
| removeAll</H3> |
| <PRE> |
| public void <B>removeAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| boolean subClasses)</PRE> |
| <DL> |
| <DD>Remove the objects of the given class from the cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#removeAll(java.lang.Class, boolean)">removeAll</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="pin(java.lang.Object)"><!-- --></A><H3> |
| pin</H3> |
| <PRE> |
| public boolean <B>pin</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#pin(java.lang.Object)">DataCache</A></CODE></B></DD> |
| <DD>Pin the value stored under <code>oid</code> into the cache. |
| This method guarantees that <code>oid</code>'s value will not |
| be dropped by the caching algorithm. This method does not |
| affect the behavior of <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#remove(java.lang.Object)"><CODE>DataCache.remove(java.lang.Object)</CODE></A>. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#pin(java.lang.Object)">pin</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if <code>oid</code>'s value was |
| pinned into the cache; <code>false</code> if the oid is not in the cache.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="pinAll(java.util.Collection)"><!-- --></A><H3> |
| pinAll</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/BitSet.html" title="class or interface in java.util">BitSet</A> <B>pinAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> keys)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#pinAll(java.util.Collection)">DataCache</A></CODE></B></DD> |
| <DD>Pin all oids to the cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#pinAll(java.util.Collection)">pinAll</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the indexes of the pinned oids<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#pin(java.lang.Object)"><CODE>DataCache.pin(java.lang.Object)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="pinAll(java.lang.Class, boolean)"><!-- --></A><H3> |
| pinAll</H3> |
| <PRE> |
| public void <B>pinAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| boolean subs)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#pinAll(java.lang.Class, boolean)">DataCache</A></CODE></B></DD> |
| <DD>Pin all oids for the given type. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#pinAll(java.lang.Class, boolean)">pinAll</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DD><CODE>subs</CODE> - Whether to include subclasses.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="unpin(java.lang.Object)"><!-- --></A><H3> |
| unpin</H3> |
| <PRE> |
| public boolean <B>unpin</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#unpin(java.lang.Object)">DataCache</A></CODE></B></DD> |
| <DD>Unpin the value stored under <code>oid</code> from the cache. |
| This method reverses a previous invocation of <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#pin(java.lang.Object)"><CODE>DataCache.pin(java.lang.Object)</CODE></A>. |
| This method does not remove anything from the cache; it merely |
| makes <code>oid</code>'s value a candidate for flushing from the cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#unpin(java.lang.Object)">unpin</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if <code>oid</code>'s value was |
| unpinned from the cache; <code>false</code> if the |
| oid is not in the cache.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="unpinAll(java.util.Collection)"><!-- --></A><H3> |
| unpinAll</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/BitSet.html" title="class or interface in java.util">BitSet</A> <B>unpinAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> keys)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#unpinAll(java.util.Collection)">DataCache</A></CODE></B></DD> |
| <DD>Unpin all oids from the cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#unpinAll(java.util.Collection)">unpinAll</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the indexes of the unpinned oids<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#unpin(java.lang.Object)"><CODE>DataCache.unpin(java.lang.Object)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="unpinAll(java.lang.Class, boolean)"><!-- --></A><H3> |
| unpinAll</H3> |
| <PRE> |
| public void <B>unpinAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| boolean subs)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#unpinAll(java.lang.Class, boolean)">DataCache</A></CODE></B></DD> |
| <DD>Unpin all oids associaed with the given type from the cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#unpinAll(java.lang.Class, boolean)">unpinAll</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DD><CODE>subs</CODE> - Whether to include subclasses.</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/datacache/DataCache.html#clear()">DataCache</A></CODE></B></DD> |
| <DD>Remove all data from this cache. This does <em>not</em> result |
| in an update of other caches. Rather, it should only be used |
| for clearing the cache. Meaningful changes to the state of the |
| cache should be made via the <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)"><CODE>DataCache.commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)</CODE></A> method. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#clear()">clear</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="close()"><!-- --></A><H3> |
| close</H3> |
| <PRE> |
| public void <B>close</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#close()">DataCache</A></CODE></B></DD> |
| <DD>Free the resources used by this cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/lib/util/Closeable.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="close(boolean)"><!-- --></A><H3> |
| close</H3> |
| <PRE> |
| protected void <B>close</B>(boolean clear)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isClosed()"><!-- --></A><H3> |
| isClosed</H3> |
| <PRE> |
| public boolean <B>isClosed</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)"><!-- --></A><H3> |
| addExpirationListener</H3> |
| <PRE> |
| public void <B>addExpirationListener</B>(<A HREF="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</A> listen)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">DataCache</A></CODE></B></DD> |
| <DD>Add a new expiration event listener to this cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#addExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">addExpirationListener</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)"><!-- --></A><H3> |
| removeExpirationListener</H3> |
| <PRE> |
| public boolean <B>removeExpirationListener</B>(<A HREF="../../../../org/apache/openjpa/datacache/ExpirationListener.html" title="interface in org.apache.openjpa.datacache">ExpirationListener</A> listen)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">DataCache</A></CODE></B></DD> |
| <DD>Remove an expiration event listener from this cache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html#removeExpirationListener(org.apache.openjpa.datacache.ExpirationListener)">removeExpirationListener</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="afterCommit(org.apache.openjpa.event.RemoteCommitEvent)"><!-- --></A><H3> |
| afterCommit</H3> |
| <PRE> |
| public void <B>afterCommit</B>(<A HREF="../../../../org/apache/openjpa/event/RemoteCommitEvent.html" title="class in org.apache.openjpa.event">RemoteCommitEvent</A> event)</PRE> |
| <DL> |
| <DD>This method is part of the <A HREF="../../../../org/apache/openjpa/event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event"><CODE>RemoteCommitListener</CODE></A> interface. If |
| your cache subclass relies on OpenJPA for clustering support, make it |
| implement <code>RemoteCommitListener</code>. This method will take |
| care of invalidating entries from remote commits. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="keyRemoved(java.lang.Object, boolean)"><!-- --></A><H3> |
| keyRemoved</H3> |
| <PRE> |
| protected void <B>keyRemoved</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> key, |
| boolean expired)</PRE> |
| <DL> |
| <DD>Invoke when a key is removed from this cache. Propagates the |
| expiration event on to all expiration listeners registered |
| with this class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="recacheUpdates()"><!-- --></A><H3> |
| recacheUpdates</H3> |
| <PRE> |
| protected boolean <B>recacheUpdates</B>()</PRE> |
| <DL> |
| <DD>Return <code>true</code> if updates to data already in the |
| cache (either in <A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)"><CODE>commit(java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)</CODE></A> or the <A HREF="../../../../org/apache/openjpa/datacache/AbstractDataCache.html#update(org.apache.openjpa.datacache.DataCachePCData)"><CODE>update(org.apache.openjpa.datacache.DataCachePCData)</CODE></A>) |
| should be put back into the cache. Returns false by default. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInternal(java.lang.Object)"><!-- --></A><H3> |
| getInternal</H3> |
| <PRE> |
| protected abstract <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> <B>getInternal</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid)</PRE> |
| <DL> |
| <DD>Return the object for the given oid. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="putInternal(java.lang.Object, org.apache.openjpa.datacache.DataCachePCData)"><!-- --></A><H3> |
| putInternal</H3> |
| <PRE> |
| protected abstract <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> <B>putInternal</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid, |
| <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> pc)</PRE> |
| <DL> |
| <DD>Add the given object to the cache, returning the old object under the |
| given oid. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="putAllInternal(java.util.Collection)"><!-- --></A><H3> |
| putAllInternal</H3> |
| <PRE> |
| protected void <B>putAllInternal</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> pcs)</PRE> |
| <DL> |
| <DD>All all of the given objects to the cache. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeInternal(java.lang.Object)"><!-- --></A><H3> |
| removeInternal</H3> |
| <PRE> |
| protected abstract <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCData.html" title="interface in org.apache.openjpa.datacache">DataCachePCData</A> <B>removeInternal</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid)</PRE> |
| <DL> |
| <DD>Remove the object under the given oid from the cache. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAllInternal(java.lang.Class, boolean)"><!-- --></A><H3> |
| removeAllInternal</H3> |
| <PRE> |
| protected abstract void <B>removeAllInternal</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> cls, |
| boolean subclasses)</PRE> |
| <DL> |
| <DD>Evict objects in cache by class. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAllInternal(java.util.Collection)"><!-- --></A><H3> |
| removeAllInternal</H3> |
| <PRE> |
| protected void <B>removeAllInternal</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> oids)</PRE> |
| <DL> |
| <DD>Remove all objects under the given oids from the cache. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAllTypeNamesInternal(java.util.Collection)"><!-- --></A><H3> |
| removeAllTypeNamesInternal</H3> |
| <PRE> |
| protected void <B>removeAllTypeNamesInternal</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> classNames)</PRE> |
| <DL> |
| <DD>Remove all objects of the given class names from the cache. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearInternal()"><!-- --></A><H3> |
| clearInternal</H3> |
| <PRE> |
| protected abstract void <B>clearInternal</B>()</PRE> |
| <DL> |
| <DD>Clear the cache. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="pinInternal(java.lang.Object)"><!-- --></A><H3> |
| pinInternal</H3> |
| <PRE> |
| protected abstract boolean <B>pinInternal</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid)</PRE> |
| <DL> |
| <DD>Pin an object to the cache. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="unpinInternal(java.lang.Object)"><!-- --></A><H3> |
| unpinInternal</H3> |
| <PRE> |
| protected abstract boolean <B>unpinInternal</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> oid)</PRE> |
| <DL> |
| <DD>Unpin an object from the cache. |
| <P> |
| <DD><DL> |
| </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> |
| <HR> |
| |
| <A NAME="fireEvent(java.lang.Object, java.lang.Object)"><!-- --></A><H3> |
| fireEvent</H3> |
| <PRE> |
| protected void <B>fireEvent</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> event, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> listener)</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#fireEvent(java.lang.Object, java.lang.Object)">AbstractConcurrentEventManager</A></CODE></B></DD> |
| <DD>Implement this method to fire the given event to the given listener. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html#fireEvent(java.lang.Object, java.lang.Object)">fireEvent</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/lib/util/concurrent/AbstractConcurrentEventManager.html" title="class in org.apache.openjpa.lib.util.concurrent">AbstractConcurrentEventManager</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/AbstractDataCache.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"> |
| PREV CLASS |
| <A HREF="../../../../org/apache/openjpa/datacache/AbstractQueryCache.html" title="class in org.apache.openjpa.datacache"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/datacache/AbstractDataCache.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="AbstractDataCache.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> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |
