<!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) on Tue Nov 06 17:41:06 CST 2007 --> | |
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |
<TITLE> | |
DataCacheManager (OpenJPA 1.0.1 API) | |
</TITLE> | |
<META NAME="keywords" CONTENT="org.apache.openjpa.datacache.DataCacheManager interface"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
parent.document.title="DataCacheManager (OpenJPA 1.0.1 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"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DataCacheManager.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/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.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/DataCacheManager.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="DataCacheManager.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_top"></A> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<HR> | |
<A NAME="main"></A> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<H2> | |
<FONT SIZE="-1"> | |
org.apache.openjpa.datacache</FONT> | |
<BR> | |
Interface DataCacheManager</H2> | |
<DL> | |
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.html" title="class in org.apache.openjpa.datacache">DataCacheManagerImpl</A></DD> | |
</DL> | |
<HR> | |
<DL> | |
<DT><PRE>public interface <B>DataCacheManager</B></DL> | |
</PRE> | |
<P> | |
Manages the system's data and query caches. You can | |
retrieve the data cache manager from the <A HREF="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf"><CODE>OpenJPAConfiguration</CODE></A>. | |
<P> | |
<P> | |
<DL> | |
<DT><B>Author:</B></DT> | |
<DD>Abe White, Patrick Linskey</DD> | |
</DL> | |
<HR> | |
<P> | |
<!-- ========== METHOD SUMMARY =========== --> | |
<A NAME="method_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Method Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html#close()">close</A></B>()</CODE> | |
<BR> | |
Close all caches.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getDataCache(java.lang.String)">getDataCache</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> | |
Return the named data cache, or null if it does not exist.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getDataCache(java.lang.String, boolean)">getDataCache</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, | |
boolean create)</CODE> | |
<BR> | |
Return the named data cache.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/datacache/DataCacheScheduler.html" title="class in org.apache.openjpa.datacache">DataCacheScheduler</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getDataCacheScheduler()">getDataCacheScheduler</A></B>()</CODE> | |
<BR> | |
Return the runnable which schedules evictions.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/datacache/DataCachePCDataGenerator.html" title="class in org.apache.openjpa.datacache">DataCachePCDataGenerator</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getPCDataGenerator()">getPCDataGenerator</A></B>()</CODE> | |
<BR> | |
Return the PCData generator if configured.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getSystemDataCache()">getSystemDataCache</A></B>()</CODE> | |
<BR> | |
Return the system-wide data cache, or null if caching is not enabled.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html#getSystemQueryCache()">getSystemQueryCache</A></B>()</CODE> | |
<BR> | |
Return the system query cache, or null if not configured.</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/DataCacheManager.html#initialize(org.apache.openjpa.conf.OpenJPAConfiguration, org.apache.openjpa.lib.conf.ObjectValue, org.apache.openjpa.lib.conf.ObjectValue)">initialize</A></B>(<A HREF="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</A> conf, | |
<A HREF="../../../../org/apache/openjpa/lib/conf/ObjectValue.html" title="class in org.apache.openjpa.lib.conf">ObjectValue</A> dataCache, | |
<A HREF="../../../../org/apache/openjpa/lib/conf/ObjectValue.html" title="class in org.apache.openjpa.lib.conf">ObjectValue</A> queryCache)</CODE> | |
<BR> | |
Initialize the manager, supplying the cache configuration.</TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<!-- ============ METHOD DETAIL ========== --> | |
<A NAME="method_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Method Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="initialize(org.apache.openjpa.conf.OpenJPAConfiguration, org.apache.openjpa.lib.conf.ObjectValue, org.apache.openjpa.lib.conf.ObjectValue)"><!-- --></A><H3> | |
initialize</H3> | |
<PRE> | |
void <B>initialize</B>(<A HREF="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</A> conf, | |
<A HREF="../../../../org/apache/openjpa/lib/conf/ObjectValue.html" title="class in org.apache.openjpa.lib.conf">ObjectValue</A> dataCache, | |
<A HREF="../../../../org/apache/openjpa/lib/conf/ObjectValue.html" title="class in org.apache.openjpa.lib.conf">ObjectValue</A> queryCache)</PRE> | |
<DL> | |
<DD>Initialize the manager, supplying the cache configuration. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSystemDataCache()"><!-- --></A><H3> | |
getSystemDataCache</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A> <B>getSystemDataCache</B>()</PRE> | |
<DL> | |
<DD>Return the system-wide data cache, or null if caching is not enabled. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDataCache(java.lang.String)"><!-- --></A><H3> | |
getDataCache</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A> <B>getDataCache</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>Return the named data cache, or null if it does not exist. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDataCache(java.lang.String, boolean)"><!-- --></A><H3> | |
getDataCache</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A> <B>getDataCache</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, | |
boolean create)</PRE> | |
<DL> | |
<DD>Return the named data cache. If the given name is null, the default | |
data cache is returned. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>create</CODE> - if true, the cache will be created if it does | |
not already exist</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSystemQueryCache()"><!-- --></A><H3> | |
getSystemQueryCache</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</A> <B>getSystemQueryCache</B>()</PRE> | |
<DL> | |
<DD>Return the system query cache, or null if not configured. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getPCDataGenerator()"><!-- --></A><H3> | |
getPCDataGenerator</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/datacache/DataCachePCDataGenerator.html" title="class in org.apache.openjpa.datacache">DataCachePCDataGenerator</A> <B>getPCDataGenerator</B>()</PRE> | |
<DL> | |
<DD>Return the PCData generator if configured. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDataCacheScheduler()"><!-- --></A><H3> | |
getDataCacheScheduler</H3> | |
<PRE> | |
<A HREF="../../../../org/apache/openjpa/datacache/DataCacheScheduler.html" title="class in org.apache.openjpa.datacache">DataCacheScheduler</A> <B>getDataCacheScheduler</B>()</PRE> | |
<DL> | |
<DD>Return the runnable which schedules evictions. | |
<P> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="close()"><!-- --></A><H3> | |
close</H3> | |
<PRE> | |
void <B>close</B>()</PRE> | |
<DL> | |
<DD>Close all caches. | |
<P> | |
<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"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DataCacheManager.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/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache"><B>PREV CLASS</B></A> | |
<A HREF="../../../../org/apache/openjpa/datacache/DataCacheManagerImpl.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/DataCacheManager.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="DataCacheManager.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
Copyright © 2006-2007 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. | |
</BODY> | |
</HTML> |