Google Git
Sign in
apache / openjpa-site / refs/heads/builds / . / 4.1.1 / apidocs / org / apache / openjpa / instrumentation / AbstractDataCacheInstrument.html
blob: 6d341233a8dbdd231d01eefd230028d4b0facc58 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang>
<head>
<!-- Generated by javadoc -->
<title>AbstractDataCacheInstrument (OpenJPA Parent POM 4.1.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractDataCacheInstrument (OpenJPA Parent POM 4.1.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.openjpa.instrumentation</a></div>
<h2 title="Class AbstractDataCacheInstrument" class="title">Class AbstractDataCacheInstrument</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../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><code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code>, <code><a href="../lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="jmx/DataCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">DataCacheJMXInstrument</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractDataCacheInstrument</span>
extends <a href="../lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</a>
implements <a href="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 =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NO_STATS">NO_STATS</a></span></code></th>
<td class="colLast">
<div class="block">Value indicating that cache statistics are not available.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractDataCacheInstrument</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cache(java.lang.String,boolean)">cache</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;className,
boolean&nbsp;enable)</code></th>
<td class="colLast">
<div class="block">This method is used to enable/disable caching for the specified className.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
<td class="colLast">
<div class="block">Clears all data from the DataCache.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectStatistics(boolean)">collectStatistics</a></span>&#8203;(boolean&nbsp;enable)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheName()">getCacheName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the name of the cache</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;long[]&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheStatistics()">getCacheStatistics</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the CacheStatistics for the cache.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigId()">getConfigId</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContextRef()">getContextRef</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHitCount()">getHitCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the hit count since cache statistics were last reset</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHitCount(java.lang.String)">getHitCount</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</code></th>
<td class="colLast">
<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 id="i9" class="rowColor">
<td class="colFirst"><code><a href="../lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLevel()">getLevel</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the instrumentation level of this instrument.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReadCount()">getReadCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the read count since cache statistics were last reset</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReadCount(java.lang.String)">getReadCount</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Gets number of total read requests for the given class since last reset.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatisticsEnabled()">getStatisticsEnabled</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if cache statistics are currently being calculated.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalHitCount()">getTotalHitCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the total hits since start.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalHitCount(java.lang.String)">getTotalHitCount</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</code></th>
<td class="colLast">
<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 id="i15" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalReadCount()">getTotalReadCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the total reads since start.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalReadCount(java.lang.String)">getTotalReadCount</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Gets number of total read requests for the given class since start.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalWriteCount()">getTotalWriteCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the total writes since start.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalWriteCount(java.lang.String)">getTotalWriteCount</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Gets number of total write requests for the given class since start.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWriteCount()">getWriteCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the write count since cache statistics were last reset</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWriteCount(java.lang.String)">getWriteCount</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Gets number of total write requests for the given class since last reset.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listKnownTypes()">listKnownTypes</a></span>()</code></th>
<td class="colLast">
<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 id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets cache statistics</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConfigId(java.lang.String)">setConfigId</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;cid)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContextRef(java.lang.String)">setContextRef</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;cref)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDataCache(org.apache.openjpa.datacache.DataCache)">setDataCache</a></span>&#8203;(<a href="../datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>&nbsp;dc)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDataCacheManager(org.apache.openjpa.datacache.DataCacheManager)">setDataCacheManager</a></span>&#8203;(<a href="../datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a>&nbsp;dcm)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sinceDate()">sinceDate</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns date since cache statistics collection were last reset.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startDate()">startDate</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns date cache statistics collection started.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.lib.instrumentation.AbstractInstrument">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.lib.instrumentation.<a href="../lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</a></h3>
<code><a href="../lib/instrumentation/AbstractInstrument.html#getContext()">getContext</a>, <a href="../lib/instrumentation/AbstractInstrument.html#getName()">getName</a>, <a href="../lib/instrumentation/AbstractInstrument.html#getOptions()">getOptions</a>, <a href="../lib/instrumentation/AbstractInstrument.html#getProvider()">getProvider</a>, <a href="../lib/instrumentation/AbstractInstrument.html#initialize()">initialize</a>, <a href="../lib/instrumentation/AbstractInstrument.html#isStarted()">isStarted</a>, <a href="../lib/instrumentation/AbstractInstrument.html#restart()">restart</a>, <a href="../lib/instrumentation/AbstractInstrument.html#setContext(java.lang.Object)">setContext</a>, <a href="../lib/instrumentation/AbstractInstrument.html#setOptions(java.lang.String)">setOptions</a>, <a href="../lib/instrumentation/AbstractInstrument.html#setProvider(org.apache.openjpa.lib.instrumentation.InstrumentationProvider)">setProvider</a>, <a href="../lib/instrumentation/AbstractInstrument.html#setStarted(boolean)">setStarted</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.lib.instrumentation.Instrument">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.lib.instrumentation.<a href="../lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a></h3>
<code><a href="../lib/instrumentation/Instrument.html#start()">start</a>, <a href="../lib/instrumentation/Instrument.html#stop()">stop</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="NO_STATS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NO_STATS</h4>
<pre>public static final&nbsp;long NO_STATS</pre>
<div class="block">Value indicating that cache statistics are not available.</div>
<dl>
<dt><span class="seeLabel">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>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractDataCacheInstrument</h4>
<pre>public&nbsp;AbstractDataCacheInstrument()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setDataCache(org.apache.openjpa.datacache.DataCache)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDataCache</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDataCache&#8203;(<a href="../datacache/DataCache.html" title="interface in org.apache.openjpa.datacache">DataCache</a>&nbsp;dc)</pre>
</li>
</ul>
<a id="setDataCacheManager(org.apache.openjpa.datacache.DataCacheManager)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDataCacheManager</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDataCacheManager&#8203;(<a href="../datacache/DataCacheManager.html" title="interface in org.apache.openjpa.datacache">DataCacheManager</a>&nbsp;dcm)</pre>
</li>
</ul>
<a id="setConfigId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfigId</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setConfigId&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;cid)</pre>
</li>
</ul>
<a id="setContextRef(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContextRef</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setContextRef&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;cref)</pre>
</li>
</ul>
<a id="getHitCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHitCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getHitCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getHitCount()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns the hit count since cache statistics were last reset</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getHitCount()">getHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getReadCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getReadCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getReadCount()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns the read count since cache statistics were last reset</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getReadCount()">getReadCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getTotalHitCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalHitCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getTotalHitCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getTotalHitCount()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns the total hits since start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getTotalHitCount()">getTotalHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getTotalReadCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalReadCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getTotalReadCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getTotalReadCount()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns the total reads since start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getTotalReadCount()">getTotalReadCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getTotalWriteCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalWriteCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getTotalWriteCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getTotalWriteCount()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns the total writes since start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getTotalWriteCount()">getTotalWriteCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getWriteCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getWriteCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getWriteCount()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns the write count since cache statistics were last reset</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getWriteCount()">getWriteCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;reset()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#reset()">DataCacheInstrument</a></code></span></div>
<div class="block">Resets cache statistics</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#reset()">reset</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="sinceDate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sinceDate</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a>&nbsp;sinceDate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#sinceDate()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns date since cache statistics collection were last reset.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#sinceDate()">sinceDate</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="startDate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startDate</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a>&nbsp;startDate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#startDate()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns date cache statistics collection started.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#startDate()">startDate</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getConfigId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigId</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getConfigId()</pre>
</li>
</ul>
<a id="getContextRef()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContextRef</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getContextRef()</pre>
</li>
</ul>
<a id="getCacheName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheName</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getCacheName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getCacheName()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns the name of the cache</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getCacheName()">getCacheName</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getWriteCount(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getWriteCount&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getWriteCount(java.lang.String)">DataCacheInstrument</a></code></span></div>
<div class="block">Gets number of total write requests for the given class since last reset.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getWriteCount(java.lang.String)">getWriteCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getTotalWriteCount(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalWriteCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getTotalWriteCount&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getTotalWriteCount(java.lang.String)">DataCacheInstrument</a></code></span></div>
<div class="block">Gets number of total write requests for the given class since start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getTotalWriteCount(java.lang.String)">getTotalWriteCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getTotalReadCount(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalReadCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getTotalReadCount&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getTotalReadCount(java.lang.String)">DataCacheInstrument</a></code></span></div>
<div class="block">Gets number of total read requests for the given class since start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getTotalReadCount(java.lang.String)">getTotalReadCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getTotalHitCount(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalHitCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getTotalHitCount&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getTotalHitCount(java.lang.String)">DataCacheInstrument</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getTotalHitCount(java.lang.String)">getTotalHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getReadCount(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getReadCount&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getReadCount(java.lang.String)">DataCacheInstrument</a></code></span></div>
<div class="block">Gets number of total read requests for the given class since last reset.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getReadCount(java.lang.String)">getReadCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getHitCount(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHitCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getHitCount&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getHitCount(java.lang.String)">DataCacheInstrument</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getHitCount(java.lang.String)">getHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLevel</h4>
<pre class="methodSignature">public&nbsp;<a href="../lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a>&nbsp;getLevel()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../lib/instrumentation/Instrument.html#getLevel()">Instrument</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../lib/instrumentation/Instrument.html#getLevel()">getLevel</a></code>&nbsp;in interface&nbsp;<code><a href="../lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../lib/instrumentation/AbstractInstrument.html#getLevel()">getLevel</a></code>&nbsp;in class&nbsp;<code><a href="../lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the instrumentation level of the instrument</dd>
</dl>
</li>
</ul>
<a id="cache(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cache</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;cache&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;className,
boolean&nbsp;enable)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#cache(java.lang.String,boolean)">DataCacheInstrument</a></code></span></div>
<div class="block">This method is used to enable/disable caching for the specified className.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#cache(java.lang.String,boolean)">cache</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="listKnownTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listKnownTypes</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a>&gt;&nbsp;listKnownTypes()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#listKnownTypes()">DataCacheInstrument</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#listKnownTypes()">listKnownTypes</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="collectStatistics(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectStatistics</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;collectStatistics&#8203;(boolean&nbsp;enable)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#collectStatistics(boolean)">collectStatistics</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
<dt><span class="paramLabel">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 id="getStatisticsEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatisticsEnabled</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a>&nbsp;getStatisticsEnabled()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getStatisticsEnabled()">DataCacheInstrument</a></code></span></div>
<div class="block">Returns true if cache statistics are currently being calculated. False otherwise.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getStatisticsEnabled()">getStatisticsEnabled</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="getCacheStatistics()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheStatistics</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;long[]&gt;&nbsp;getCacheStatistics()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#getCacheStatistics()">DataCacheInstrument</a></code></span></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><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#getCacheStatistics()">getCacheStatistics</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a id="clear()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clear()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="DataCacheInstrument.html#clear()">DataCacheInstrument</a></code></span></div>
<div class="block">Clears all data from the DataCache.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="DataCacheInstrument.html#clear()">clear</a></code>&nbsp;in interface&nbsp;<code><a href="DataCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">DataCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>