| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_43) on Tue Apr 16 17:05:05 CDT 2013 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| AbstractDataCacheInstrument (OpenJPA Parent POM 2.2.2 API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2013-04-16"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractDataCacheInstrument (OpenJPA Parent POM 2.2.2 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractDataCacheInstrument.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/instrumentation/AbstractPreparedQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="AbstractDataCacheInstrument.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.instrumentation</FONT> |
| <BR> |
| Class AbstractDataCacheInstrument</H2> |
| <PRE> |
| <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">org.apache.openjpa.lib.instrumentation.AbstractInstrument</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.instrumentation.AbstractDataCacheInstrument</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A></DD> |
| </DL> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/openjpa/instrumentation/jmx/DataCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">DataCacheJMXInstrument</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>AbstractDataCacheInstrument</B><DT>extends <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</A><DT>implements <A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></DL> |
| </PRE> |
| |
| <P> |
| Provides a basic instrument implementation wrapper for the data cache. This class can be extended to create a |
| provider specific instrument for the data cache. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#NO_STATS">NO_STATS</A></B></CODE> |
| |
| <BR> |
| Value indicating that cache statistics are not available.</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/instrumentation/AbstractDataCacheInstrument.html#AbstractDataCacheInstrument()">AbstractDataCacheInstrument</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/instrumentation/AbstractDataCacheInstrument.html#cache(java.lang.String, boolean)">cache</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, |
| boolean enable)</CODE> |
| |
| <BR> |
| This method is used to enable/disable caching for the specified className.</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/instrumentation/AbstractDataCacheInstrument.html#clear()">clear</A></B>()</CODE> |
| |
| <BR> |
| Clears all data from the DataCache.</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/instrumentation/AbstractDataCacheInstrument.html#collectStatistics(boolean)">collectStatistics</A></B>(boolean enable)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getCacheName()">getCacheName</A></B>()</CODE> |
| |
| <BR> |
| Returns the name of the cache</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,long[]></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getCacheStatistics()">getCacheStatistics</A></B>()</CODE> |
| |
| <BR> |
| Returns the CacheStatistics for the cache.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getConfigId()">getConfigId</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getContextRef()">getContextRef</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getHitCount()">getHitCount</A></B>()</CODE> |
| |
| <BR> |
| Returns the hit count since cache statistics were last reset</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getHitCount(java.lang.String)">getHitCount</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</CODE> |
| |
| <BR> |
| Gets number of total read requests that has been found in cache for the given class since last reset.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getLevel()">getLevel</A></B>()</CODE> |
| |
| <BR> |
| Gets the instrumentation level of this instrument.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getReadCount()">getReadCount</A></B>()</CODE> |
| |
| <BR> |
| Returns the read count since cache statistics were last reset</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getReadCount(java.lang.String)">getReadCount</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</CODE> |
| |
| <BR> |
| Gets number of total read requests for the given class since last reset.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getStatisticsEnabled()">getStatisticsEnabled</A></B>()</CODE> |
| |
| <BR> |
| Returns true if cache statistics are currently being calculated.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalHitCount()">getTotalHitCount</A></B>()</CODE> |
| |
| <BR> |
| Returns the total hits since start.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalHitCount(java.lang.String)">getTotalHitCount</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</CODE> |
| |
| <BR> |
| Gets number of total read requests that has been found in cache for the given class since start.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalReadCount()">getTotalReadCount</A></B>()</CODE> |
| |
| <BR> |
| Returns the total reads since start.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalReadCount(java.lang.String)">getTotalReadCount</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</CODE> |
| |
| <BR> |
| Gets number of total read requests for the given class since start.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalWriteCount()">getTotalWriteCount</A></B>()</CODE> |
| |
| <BR> |
| Returns the total writes since start.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalWriteCount(java.lang.String)">getTotalWriteCount</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</CODE> |
| |
| <BR> |
| Gets number of total write requests for the given class since start.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getWriteCount()">getWriteCount</A></B>()</CODE> |
| |
| <BR> |
| Returns the write count since cache statistics were last reset</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getWriteCount(java.lang.String)">getWriteCount</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</CODE> |
| |
| <BR> |
| Gets number of total write requests for the given class since last reset.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#listKnownTypes()">listKnownTypes</A></B>()</CODE> |
| |
| <BR> |
| Returns the names of classes that are known to the cache and whether or not they are currently being cached.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#reset()">reset</A></B>()</CODE> |
| |
| <BR> |
| Resets cache statistics</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#setConfigId(java.lang.String)">setConfigId</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> cid)</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/instrumentation/AbstractDataCacheInstrument.html#setContextRef(java.lang.String)">setContextRef</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> cref)</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/instrumentation/AbstractDataCacheInstrument.html#setDataCache(org.apache.openjpa.datacache.DataCache)">setDataCache</A></B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A> dc)</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/instrumentation/AbstractDataCacheInstrument.html#setDataCacheManager(org.apache.openjpa.datacache.DataCacheManager)">setDataCacheManager</A></B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</A> dcm)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#sinceDate()">sinceDate</A></B>()</CODE> |
| |
| <BR> |
| Returns date since cache statistics collection were last reset.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#startDate()">startDate</A></B>()</CODE> |
| |
| <BR> |
| Returns date cache statistics collection started.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.lib.instrumentation.AbstractInstrument"><!-- --></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.instrumentation.<A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getContext()">getContext</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getName()">getName</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getOptions()">getOptions</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getProvider()">getProvider</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#initialize()">initialize</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#isStarted()">isStarted</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#restart()">restart</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#setContext(java.lang.Object)">setContext</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#setOptions(java.lang.String)">setOptions</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#setProvider(org.apache.openjpa.lib.instrumentation.InstrumentationProvider)">setProvider</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#setStarted(boolean)">setStarted</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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.lib.instrumentation.Instrument"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.openjpa.lib.instrumentation.<A HREF="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#start()">start</A>, <A HREF="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#stop()">stop</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="NO_STATS"><!-- --></A><H3> |
| NO_STATS</H3> |
| <PRE> |
| public static final long <B>NO_STATS</B></PRE> |
| <DL> |
| <DD>Value indicating that cache statistics are not available. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.openjpa.instrumentation.AbstractDataCacheInstrument.NO_STATS">Constant Field Values</A></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="AbstractDataCacheInstrument()"><!-- --></A><H3> |
| AbstractDataCacheInstrument</H3> |
| <PRE> |
| public <B>AbstractDataCacheInstrument</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="setDataCache(org.apache.openjpa.datacache.DataCache)"><!-- --></A><H3> |
| setDataCache</H3> |
| <PRE> |
| public void <B>setDataCache</B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</A> dc)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDataCacheManager(org.apache.openjpa.datacache.DataCacheManager)"><!-- --></A><H3> |
| setDataCacheManager</H3> |
| <PRE> |
| public void <B>setDataCacheManager</B>(<A HREF="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</A> dcm)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setConfigId(java.lang.String)"><!-- --></A><H3> |
| setConfigId</H3> |
| <PRE> |
| public void <B>setConfigId</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> cid)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setContextRef(java.lang.String)"><!-- --></A><H3> |
| setContextRef</H3> |
| <PRE> |
| public void <B>setContextRef</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> cref)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHitCount()"><!-- --></A><H3> |
| getHitCount</H3> |
| <PRE> |
| public long <B>getHitCount</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getHitCount()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns the hit count since cache statistics were last reset |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getHitCount()">getHitCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getReadCount()"><!-- --></A><H3> |
| getReadCount</H3> |
| <PRE> |
| public long <B>getReadCount</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getReadCount()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns the read count since cache statistics were last reset |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getReadCount()">getReadCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTotalHitCount()"><!-- --></A><H3> |
| getTotalHitCount</H3> |
| <PRE> |
| public long <B>getTotalHitCount</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalHitCount()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns the total hits since start. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalHitCount()">getTotalHitCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTotalReadCount()"><!-- --></A><H3> |
| getTotalReadCount</H3> |
| <PRE> |
| public long <B>getTotalReadCount</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalReadCount()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns the total reads since start. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalReadCount()">getTotalReadCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTotalWriteCount()"><!-- --></A><H3> |
| getTotalWriteCount</H3> |
| <PRE> |
| public long <B>getTotalWriteCount</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalWriteCount()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns the total writes since start. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalWriteCount()">getTotalWriteCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getWriteCount()"><!-- --></A><H3> |
| getWriteCount</H3> |
| <PRE> |
| public long <B>getWriteCount</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getWriteCount()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns the write count since cache statistics were last reset |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getWriteCount()">getWriteCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="reset()"><!-- --></A><H3> |
| reset</H3> |
| <PRE> |
| public void <B>reset</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#reset()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Resets cache statistics |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="sinceDate()"><!-- --></A><H3> |
| sinceDate</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> <B>sinceDate</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#sinceDate()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns date since cache statistics collection were last reset. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#sinceDate()">sinceDate</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="startDate()"><!-- --></A><H3> |
| startDate</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> <B>startDate</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#startDate()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns date cache statistics collection started. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#startDate()">startDate</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getConfigId()"><!-- --></A><H3> |
| getConfigId</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getConfigId</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getContextRef()"><!-- --></A><H3> |
| getContextRef</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getContextRef</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCacheName()"><!-- --></A><H3> |
| getCacheName</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getCacheName</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getCacheName()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns the name of the cache |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getCacheName()">getCacheName</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getWriteCount(java.lang.String)"><!-- --></A><H3> |
| getWriteCount</H3> |
| <PRE> |
| public long <B>getWriteCount</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getWriteCount(java.lang.String)">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Gets number of total write requests for the given class since last reset. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getWriteCount(java.lang.String)">getWriteCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTotalWriteCount(java.lang.String)"><!-- --></A><H3> |
| getTotalWriteCount</H3> |
| <PRE> |
| public long <B>getTotalWriteCount</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalWriteCount(java.lang.String)">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Gets number of total write requests for the given class since start. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalWriteCount(java.lang.String)">getTotalWriteCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTotalReadCount(java.lang.String)"><!-- --></A><H3> |
| getTotalReadCount</H3> |
| <PRE> |
| public long <B>getTotalReadCount</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalReadCount(java.lang.String)">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Gets number of total read requests for the given class since start. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalReadCount(java.lang.String)">getTotalReadCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getTotalHitCount(java.lang.String)"><!-- --></A><H3> |
| getTotalHitCount</H3> |
| <PRE> |
| public long <B>getTotalHitCount</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalHitCount(java.lang.String)">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Gets number of total read requests that has been found in cache for the given class since start. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalHitCount(java.lang.String)">getTotalHitCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getReadCount(java.lang.String)"><!-- --></A><H3> |
| getReadCount</H3> |
| <PRE> |
| public long <B>getReadCount</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getReadCount(java.lang.String)">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Gets number of total read requests for the given class since last reset. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getReadCount(java.lang.String)">getReadCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getHitCount(java.lang.String)"><!-- --></A><H3> |
| getHitCount</H3> |
| <PRE> |
| public long <B>getHitCount</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> c)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getHitCount(java.lang.String)">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Gets number of total read requests that has been found in cache for the given class since last reset. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getHitCount(java.lang.String)">getHitCount</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLevel()"><!-- --></A><H3> |
| getLevel</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</A> <B>getLevel</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#getLevel()">Instrument</A></CODE></B></DD> |
| <DD>Gets the instrumentation level of this instrument. The instrumentation level |
| determines if and when the instrument will automatically start and stop. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#getLevel()">getLevel</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getLevel()">getLevel</A></CODE> in class <CODE><A HREF="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the instrumentation level of the instrument</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="cache(java.lang.String, boolean)"><!-- --></A><H3> |
| cache</H3> |
| <PRE> |
| public void <B>cache</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, |
| boolean enable)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#cache(java.lang.String, boolean)">DataCacheInstrument</A></CODE></B></DD> |
| <DD>This method is used to enable/disable caching for the specified className. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#cache(java.lang.String, boolean)">cache</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="listKnownTypes()"><!-- --></A><H3> |
| listKnownTypes</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A>> <B>listKnownTypes</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#listKnownTypes()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns the names of classes that are known to the cache and whether or not they are currently being cached. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#listKnownTypes()">listKnownTypes</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="collectStatistics(boolean)"><!-- --></A><H3> |
| collectStatistics</H3> |
| <PRE> |
| public void <B>collectStatistics</B>(boolean enable)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#collectStatistics(boolean)">collectStatistics</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>enable</CODE> - - If true, the cache will start collecting statistics. Else cache statistics will not be collected.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getStatisticsEnabled()"><!-- --></A><H3> |
| getStatisticsEnabled</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> <B>getStatisticsEnabled</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getStatisticsEnabled()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns true if cache statistics are currently being calculated. False otherwise. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getStatisticsEnabled()">getStatisticsEnabled</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCacheStatistics()"><!-- --></A><H3> |
| getCacheStatistics</H3> |
| <PRE> |
| public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,long[]> <B>getCacheStatistics</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getCacheStatistics()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Returns the CacheStatistics for the cache. |
| The format for this map is: |
| Type(String) => Enabled(Boolean),Read(Long),Hit(Long),Write(Long) |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getCacheStatistics()">getCacheStatistics</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clear()"><!-- --></A><H3> |
| clear</H3> |
| <PRE> |
| public void <B>clear</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#clear()">DataCacheInstrument</A></CODE></B></DD> |
| <DD>Clears all data from the DataCache. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#clear()">clear</A></CODE> in interface <CODE><A HREF="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</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/AbstractDataCacheInstrument.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/instrumentation/AbstractPreparedQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="AbstractDataCacheInstrument.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-2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |