| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_121) on Fri Jan 06 19:36:25 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AbstractDataCacheInstrument (OpenJPA Parent POM 2.4.2 API)</title> |
| <meta name="date" content="2017-01-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractDataCacheInstrument (OpenJPA Parent POM 2.4.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractDataCacheInstrument.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html" target="_top">Frames</a></li> |
| <li><a href="AbstractDataCacheInstrument.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.instrumentation</div> |
| <h2 title="Class AbstractDataCacheInstrument" class="title">Class AbstractDataCacheInstrument</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><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></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">org.apache.openjpa.lib.instrumentation.AbstractInstrument</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openjpa.instrumentation.AbstractDataCacheInstrument</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <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>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/openjpa/instrumentation/jmx/DataCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">DataCacheJMXInstrument</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">AbstractDataCacheInstrument</span> |
| extends <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</a> |
| implements <a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></pre> |
| <div class="block">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.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#NO_STATS">NO_STATS</a></strong></code> |
| <div class="block">Value indicating that cache statistics are not available.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#AbstractDataCacheInstrument()">AbstractDataCacheInstrument</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#cache(java.lang.String,%20boolean)">cache</a></strong>(<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> |
| <div class="block">This method is used to enable/disable caching for the specified className.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#clear()">clear</a></strong>()</code> |
| <div class="block">Clears all data from the DataCache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#collectStatistics(boolean)">collectStatistics</a></strong>(boolean enable)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getCacheName()">getCacheName</a></strong>()</code> |
| <div class="block">Returns the name of the cache</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getCacheStatistics()">getCacheStatistics</a></strong>()</code> |
| <div class="block">Returns the CacheStatistics for the cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getConfigId()">getConfigId</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getContextRef()">getContextRef</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getHitCount()">getHitCount</a></strong>()</code> |
| <div class="block">Returns the hit count since cache statistics were last reset</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getHitCount(java.lang.String)">getHitCount</a></strong>(<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> |
| <div class="block">Gets number of total read requests that has been found in cache for the given class since last reset.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getLevel()">getLevel</a></strong>()</code> |
| <div class="block">Gets the instrumentation level of this instrument.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getReadCount()">getReadCount</a></strong>()</code> |
| <div class="block">Returns the read count since cache statistics were last reset</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getReadCount(java.lang.String)">getReadCount</a></strong>(<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> |
| <div class="block">Gets number of total read requests for the given class since last reset.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getStatisticsEnabled()">getStatisticsEnabled</a></strong>()</code> |
| <div class="block">Returns true if cache statistics are currently being calculated.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalHitCount()">getTotalHitCount</a></strong>()</code> |
| <div class="block">Returns the total hits since start.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalHitCount(java.lang.String)">getTotalHitCount</a></strong>(<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> |
| <div class="block">Gets number of total read requests that has been found in cache for the given class since start.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalReadCount()">getTotalReadCount</a></strong>()</code> |
| <div class="block">Returns the total reads since start.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalReadCount(java.lang.String)">getTotalReadCount</a></strong>(<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> |
| <div class="block">Gets number of total read requests for the given class since start.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalWriteCount()">getTotalWriteCount</a></strong>()</code> |
| <div class="block">Returns the total writes since start.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getTotalWriteCount(java.lang.String)">getTotalWriteCount</a></strong>(<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> |
| <div class="block">Gets number of total write requests for the given class since start.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getWriteCount()">getWriteCount</a></strong>()</code> |
| <div class="block">Returns the write count since cache statistics were last reset</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#getWriteCount(java.lang.String)">getWriteCount</a></strong>(<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> |
| <div class="block">Gets number of total write requests for the given class since last reset.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#listKnownTypes()">listKnownTypes</a></strong>()</code> |
| <div class="block">Returns the names of classes that are known to the cache and whether or not they are currently being cached.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#reset()">reset</a></strong>()</code> |
| <div class="block">Resets cache statistics</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#setConfigId(java.lang.String)">setConfigId</a></strong>(<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> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#setContextRef(java.lang.String)">setContextRef</a></strong>(<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> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#setDataCache(org.apache.openjpa.datacache.DataCache)">setDataCache</a></strong>(<a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a> dc)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#setDataCacheManager(org.apache.openjpa.datacache.DataCacheManager)">setDataCacheManager</a></strong>(<a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a> dcm)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#sinceDate()">sinceDate</a></strong>()</code> |
| <div class="block">Returns date since cache statistics collection were last reset.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><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></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html#startDate()">startDate</a></strong>()</code> |
| <div class="block">Returns date cache statistics collection started.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.lib.instrumentation.AbstractInstrument"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.lib.instrumentation.Instrument"> |
| <!-- --> |
| </a> |
| <h3>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></h3> |
| <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></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="NO_STATS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NO_STATS</h4> |
| <pre>public static final long NO_STATS</pre> |
| <div class="block">Value indicating that cache statistics are not available.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.instrumentation.AbstractDataCacheInstrument.NO_STATS">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractDataCacheInstrument()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractDataCacheInstrument</h4> |
| <pre>public AbstractDataCacheInstrument()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setDataCache(org.apache.openjpa.datacache.DataCache)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataCache</h4> |
| <pre>public void setDataCache(<a href="../../../../org/apache/openjpa/datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a> dc)</pre> |
| </li> |
| </ul> |
| <a name="setDataCacheManager(org.apache.openjpa.datacache.DataCacheManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataCacheManager</h4> |
| <pre>public void setDataCacheManager(<a href="../../../../org/apache/openjpa/datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a> dcm)</pre> |
| </li> |
| </ul> |
| <a name="setConfigId(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfigId</h4> |
| <pre>public void setConfigId(<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> |
| </li> |
| </ul> |
| <a name="setContextRef(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContextRef</h4> |
| <pre>public void setContextRef(<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> |
| </li> |
| </ul> |
| <a name="getHitCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHitCount</h4> |
| <pre>public long getHitCount()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getHitCount()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns the hit count since cache statistics were last reset</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadCount</h4> |
| <pre>public long getReadCount()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getReadCount()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns the read count since cache statistics were last reset</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTotalHitCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalHitCount</h4> |
| <pre>public long getTotalHitCount()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalHitCount()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns the total hits since start.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTotalReadCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalReadCount</h4> |
| <pre>public long getTotalReadCount()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalReadCount()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns the total reads since start.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTotalWriteCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalWriteCount</h4> |
| <pre>public long getTotalWriteCount()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalWriteCount()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns the total writes since start.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriteCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteCount</h4> |
| <pre>public long getWriteCount()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getWriteCount()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns the write count since cache statistics were last reset</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#reset()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Resets cache statistics</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sinceDate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sinceDate</h4> |
| <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> sinceDate()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#sinceDate()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns date since cache statistics collection were last reset.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startDate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startDate</h4> |
| <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> startDate()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#startDate()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns date cache statistics collection started.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfigId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigId</h4> |
| <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> getConfigId()</pre> |
| </li> |
| </ul> |
| <a name="getContextRef()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContextRef</h4> |
| <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> getContextRef()</pre> |
| </li> |
| </ul> |
| <a name="getCacheName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheName</h4> |
| <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> getCacheName()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getCacheName()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns the name of the cache</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriteCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteCount</h4> |
| <pre>public long getWriteCount(<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> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getWriteCount(java.lang.String)">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Gets number of total write requests for the given class since last reset.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTotalWriteCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalWriteCount</h4> |
| <pre>public long getTotalWriteCount(<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> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalWriteCount(java.lang.String)">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Gets number of total write requests for the given class since start.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTotalReadCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalReadCount</h4> |
| <pre>public long getTotalReadCount(<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> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalReadCount(java.lang.String)">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Gets number of total read requests for the given class since start.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTotalHitCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalHitCount</h4> |
| <pre>public long getTotalHitCount(<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> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getTotalHitCount(java.lang.String)">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Gets number of total read requests that has been found in cache for the given class since start.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReadCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReadCount</h4> |
| <pre>public long getReadCount(<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> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getReadCount(java.lang.String)">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Gets number of total read requests for the given class since last reset.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getHitCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHitCount</h4> |
| <pre>public long getHitCount(<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> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getHitCount(java.lang.String)">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Gets number of total read requests that has been found in cache for the given class since last reset.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLevel</h4> |
| <pre>public <a href="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a> getLevel()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#getLevel()">Instrument</a></code></strong></div> |
| <div class="block">Gets the instrumentation level of this instrument. The instrumentation level |
| determines if and when the instrument will automatically start and stop.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <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></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the instrumentation level of the instrument</dd></dl> |
| </li> |
| </ul> |
| <a name="cache(java.lang.String, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cache</h4> |
| <pre>public void cache(<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> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#cache(java.lang.String,%20boolean)">DataCacheInstrument</a></code></strong></div> |
| <div class="block">This method is used to enable/disable caching for the specified className.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#cache(java.lang.String,%20boolean)">cache</a></code> in interface <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listKnownTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listKnownTypes</h4> |
| <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>> listKnownTypes()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#listKnownTypes()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns the names of classes that are known to the cache and whether or not they are currently being cached.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="collectStatistics(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>collectStatistics</h4> |
| <pre>public void collectStatistics(boolean enable)</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>enable</code> - - If true, the cache will start collecting statistics. Else cache statistics will not be collected.</dd></dl> |
| </li> |
| </ul> |
| <a name="getStatisticsEnabled()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatisticsEnabled</h4> |
| <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> getStatisticsEnabled()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getStatisticsEnabled()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns true if cache statistics are currently being calculated. False otherwise.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCacheStatistics()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCacheStatistics</h4> |
| <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[]> getCacheStatistics()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#getCacheStatistics()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Returns the CacheStatistics for the cache. |
| The format for this map is: |
| Type(String) => Enabled(Boolean),Read(Long),Hit(Long),Write(Long)</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clear()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>clear</h4> |
| <pre>public void clear()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.html#clear()">DataCacheInstrument</a></code></strong></div> |
| <div class="block">Clears all data from the DataCache.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <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></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractDataCacheInstrument.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/instrumentation/AbstractDataCacheInstrument.html" target="_top">Frames</a></li> |
| <li><a href="AbstractDataCacheInstrument.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
