4.1.1/apidocs/org/apache/openjpa/instrumentation/QueryCacheInstrument.html - openjpa-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang>
 <head>
 <!-- Generated by javadoc -->
 <title>QueryCacheInstrument (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="QueryCacheInstrument (OpenJPA Parent POM 4.1.1 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/QueryCacheInstrument.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>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&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="Interface QueryCacheInstrument" class="title">Interface QueryCacheInstrument</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Known Subinterfaces:</dt>
 <dd><code><a href="jmx/QueryCacheJMXInstrumentMBean.html" title="interface in org.apache.openjpa.instrumentation.jmx">QueryCacheJMXInstrumentMBean</a></code></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="AbstractQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation">AbstractQueryCacheInstrument</a></code>, <code><a href="jmx/QueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">QueryCacheJMXInstrument</a></code></dd>
 </dl>
 <hr>
 <pre>public interface <span class="typeNameLabel">QueryCacheInstrument</span></pre>
 <div class="block">Interface for providing instrumented data cache metrics and operations.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>long</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#count()">count</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the number of total entries in the cache.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>long</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEvictionCount()">getEvictionCount</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns number of total evictions since last reset</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>long</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutionCount()">getExecutionCount</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns number of total execution requests since last reset</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>long</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutionCount(java.lang.String)">getExecutionCount</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;queryKey)</code></th>
 <td class="colLast">
 <div class="block">Returns number of total execution requests since last reset for
  the specified string-ified query key.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <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 number of total read requests that have been found in cache since
  last reset.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <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;queryKey)</code></th>
 <td class="colLast">
 <div class="block">Returns number of total read requests that have been found in cache since
  last reset for the specified string-ified query key.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>long</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalEvictionCount()">getTotalEvictionCount</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns number of total eviction requests since start.</div>
 </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="#getTotalExecutionCount()">getTotalExecutionCount</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns number of total exec requests since start.</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="#getTotalExecutionCount(java.lang.String)">getTotalExecutionCount</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;queryKey)</code></th>
 <td class="colLast">
 <div class="block">Returns number of total exec requests since start for
  the specified string-ified query key.</div>
 </td>
 </tr>
 <tr id="i9" 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 number of total read requests that has been found since start.</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="#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;queryKey)</code></th>
 <td class="colLast">
 <div class="block">Returns number of total read requests that has been found since start for
  the specified string-ified query key.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</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>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryKeys()">queryKeys</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns all the string-ified keys for query results in the cache.</div>
 </td>
 </tr>
 <tr id="i12" 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="i13" 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="i14" 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>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="getTotalExecutionCount()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTotalExecutionCount</h4>
 <pre class="methodSignature">long&nbsp;getTotalExecutionCount()</pre>
 <div class="block">Returns number of total exec requests since start.</div>
 </li>
 </ul>
 <a id="getTotalExecutionCount(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTotalExecutionCount</h4>
 <pre class="methodSignature">long&nbsp;getTotalExecutionCount&#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;queryKey)</pre>
 <div class="block">Returns number of total exec requests since start for
  the specified string-ified query key.</div>
 </li>
 </ul>
 <a id="getExecutionCount()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getExecutionCount</h4>
 <pre class="methodSignature">long&nbsp;getExecutionCount()</pre>
 <div class="block">Returns number of total execution requests since last reset</div>
 </li>
 </ul>
 <a id="getExecutionCount(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getExecutionCount</h4>
 <pre class="methodSignature">long&nbsp;getExecutionCount&#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;queryKey)</pre>
 <div class="block">Returns number of total execution requests since last reset for
  the specified string-ified query key.</div>
 </li>
 </ul>
 <a id="getHitCount()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getHitCount</h4>
 <pre class="methodSignature">long&nbsp;getHitCount()</pre>
 <div class="block">Returns number of total read requests that have been found in cache since
  last reset.</div>
 </li>
 </ul>
 <a id="getHitCount(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getHitCount</h4>
 <pre class="methodSignature">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;queryKey)</pre>
 <div class="block">Returns number of total read requests that have been found in cache since
  last reset for the specified string-ified query key.</div>
 </li>
 </ul>
 <a id="getTotalHitCount()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTotalHitCount</h4>
 <pre class="methodSignature">long&nbsp;getTotalHitCount()</pre>
 <div class="block">Returns number of total read requests that has been found since start.</div>
 </li>
 </ul>
 <a id="getTotalHitCount(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTotalHitCount</h4>
 <pre class="methodSignature">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;queryKey)</pre>
 <div class="block">Returns number of total read requests that has been found since start for
  the specified string-ified query key.</div>
 </li>
 </ul>
 <a id="reset()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>reset</h4>
 <pre class="methodSignature">void&nbsp;reset()</pre>
 <div class="block">Resets cache statistics</div>
 </li>
 </ul>
 <a id="sinceDate()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>sinceDate</h4>
 <pre class="methodSignature"><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">Returns date since cache statistics collection were last reset.</div>
 </li>
 </ul>
 <a id="startDate()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>startDate</h4>
 <pre class="methodSignature"><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">Returns date cache statistics collection started.</div>
 </li>
 </ul>
 <a id="queryKeys()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>queryKeys</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</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>&gt;&nbsp;queryKeys()</pre>
 <div class="block">Returns all the string-ified keys for query results in the cache.</div>
 </li>
 </ul>
 <a id="getEvictionCount()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getEvictionCount</h4>
 <pre class="methodSignature">long&nbsp;getEvictionCount()</pre>
 <div class="block">Returns number of total evictions since last reset</div>
 </li>
 </ul>
 <a id="getTotalEvictionCount()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTotalEvictionCount</h4>
 <pre class="methodSignature">long&nbsp;getTotalEvictionCount()</pre>
 <div class="block">Returns number of total eviction requests since start.</div>
 </li>
 </ul>
 <a id="count()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>count</h4>
 <pre class="methodSignature">long&nbsp;count()</pre>
 <div class="block">Returns the number of total entries in the cache.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>entries</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/QueryCacheInstrument.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>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&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>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang>
	<head>
	<!-- Generated by javadoc -->
	<title>QueryCacheInstrument (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="QueryCacheInstrument (OpenJPA Parent POM 4.1.1 API)";
	}
	}
	catch(err) {
	}
	//-->
	var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/QueryCacheInstrument.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 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: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </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"> </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> <a href="package-summary.html">org.apache.openjpa.instrumentation</a></div>
	<h2 title="Interface QueryCacheInstrument" class="title">Interface QueryCacheInstrument</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<dl>
	<dt>All Known Subinterfaces:</dt>
	<dd><code><a href="jmx/QueryCacheJMXInstrumentMBean.html" title="interface in org.apache.openjpa.instrumentation.jmx">QueryCacheJMXInstrumentMBean</a></code></dd>
	</dl>
	<dl>
	<dt>All Known Implementing Classes:</dt>
	<dd><code><a href="AbstractQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation">AbstractQueryCacheInstrument</a></code>, <code><a href="jmx/QueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">QueryCacheJMXInstrument</a></code></dd>
	</dl>
	<hr>
	<pre>public interface <span class="typeNameLabel">QueryCacheInstrument</span></pre>
	<div class="block">Interface for providing instrumented data cache metrics and operations.</div>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>long</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#count()">count</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns the number of total entries in the cache.</div>
	</td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code>long</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEvictionCount()">getEvictionCount</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns number of total evictions since last reset</div>
	</td>
	</tr>
	<tr id="i2" class="altColor">
	<td class="colFirst"><code>long</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutionCount()">getExecutionCount</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns number of total execution requests since last reset</div>
	</td>
	</tr>
	<tr id="i3" class="rowColor">
	<td class="colFirst"><code>long</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutionCount(java.lang.String)">getExecutionCount</a></span>(<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> queryKey)</code></th>
	<td class="colLast">
	<div class="block">Returns number of total execution requests since last reset for
	the specified string-ified query key.</div>
	</td>
	</tr>
	<tr id="i4" class="altColor">
	<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 number of total read requests that have been found in cache since
	last reset.</div>
	</td>
	</tr>
	<tr id="i5" class="rowColor">
	<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>(<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> queryKey)</code></th>
	<td class="colLast">
	<div class="block">Returns number of total read requests that have been found in cache since
	last reset for the specified string-ified query key.</div>
	</td>
	</tr>
	<tr id="i6" class="altColor">
	<td class="colFirst"><code>long</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalEvictionCount()">getTotalEvictionCount</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns number of total eviction requests since start.</div>
	</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="#getTotalExecutionCount()">getTotalExecutionCount</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns number of total exec requests since start.</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="#getTotalExecutionCount(java.lang.String)">getTotalExecutionCount</a></span>(<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> queryKey)</code></th>
	<td class="colLast">
	<div class="block">Returns number of total exec requests since start for
	the specified string-ified query key.</div>
	</td>
	</tr>
	<tr id="i9" 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 number of total read requests that has been found since start.</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="#getTotalHitCount(java.lang.String)">getTotalHitCount</a></span>(<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> queryKey)</code></th>
	<td class="colLast">
	<div class="block">Returns number of total read requests that has been found since start for
	the specified string-ified query key.</div>
	</td>
	</tr>
	<tr id="i11" class="rowColor">
	<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<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="#queryKeys()">queryKeys</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns all the string-ified keys for query results in the cache.</div>
	</td>
	</tr>
	<tr id="i12" 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="i13" 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="i14" 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>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ METHOD DETAIL ========== -->
	<section>
	<ul class="blockList">
	<li class="blockList"><a id="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a id="getTotalExecutionCount()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getTotalExecutionCount</h4>
	<pre class="methodSignature">long getTotalExecutionCount()</pre>
	<div class="block">Returns number of total exec requests since start.</div>
	</li>
	</ul>
	<a id="getTotalExecutionCount(java.lang.String)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getTotalExecutionCount</h4>
	<pre class="methodSignature">long getTotalExecutionCount(<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> queryKey)</pre>
	<div class="block">Returns number of total exec requests since start for
	the specified string-ified query key.</div>
	</li>
	</ul>
	<a id="getExecutionCount()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getExecutionCount</h4>
	<pre class="methodSignature">long getExecutionCount()</pre>
	<div class="block">Returns number of total execution requests since last reset</div>
	</li>
	</ul>
	<a id="getExecutionCount(java.lang.String)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getExecutionCount</h4>
	<pre class="methodSignature">long getExecutionCount(<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> queryKey)</pre>
	<div class="block">Returns number of total execution requests since last reset for
	the specified string-ified query key.</div>
	</li>
	</ul>
	<a id="getHitCount()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getHitCount</h4>
	<pre class="methodSignature">long getHitCount()</pre>
	<div class="block">Returns number of total read requests that have been found in cache since
	last reset.</div>
	</li>
	</ul>
	<a id="getHitCount(java.lang.String)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getHitCount</h4>
	<pre class="methodSignature">long getHitCount(<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> queryKey)</pre>
	<div class="block">Returns number of total read requests that have been found in cache since
	last reset for the specified string-ified query key.</div>
	</li>
	</ul>
	<a id="getTotalHitCount()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getTotalHitCount</h4>
	<pre class="methodSignature">long getTotalHitCount()</pre>
	<div class="block">Returns number of total read requests that has been found since start.</div>
	</li>
	</ul>
	<a id="getTotalHitCount(java.lang.String)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getTotalHitCount</h4>
	<pre class="methodSignature">long getTotalHitCount(<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> queryKey)</pre>
	<div class="block">Returns number of total read requests that has been found since start for
	the specified string-ified query key.</div>
	</li>
	</ul>
	<a id="reset()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>reset</h4>
	<pre class="methodSignature">void reset()</pre>
	<div class="block">Resets cache statistics</div>
	</li>
	</ul>
	<a id="sinceDate()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>sinceDate</h4>
	<pre class="methodSignature"><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> sinceDate()</pre>
	<div class="block">Returns date since cache statistics collection were last reset.</div>
	</li>
	</ul>
	<a id="startDate()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>startDate</h4>
	<pre class="methodSignature"><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> startDate()</pre>
	<div class="block">Returns date cache statistics collection started.</div>
	</li>
	</ul>
	<a id="queryKeys()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>queryKeys</h4>
	<pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<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>> queryKeys()</pre>
	<div class="block">Returns all the string-ified keys for query results in the cache.</div>
	</li>
	</ul>
	<a id="getEvictionCount()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getEvictionCount</h4>
	<pre class="methodSignature">long getEvictionCount()</pre>
	<div class="block">Returns number of total evictions since last reset</div>
	</li>
	</ul>
	<a id="getTotalEvictionCount()">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getTotalEvictionCount</h4>
	<pre class="methodSignature">long getTotalEvictionCount()</pre>
	<div class="block">Returns number of total eviction requests since start.</div>
	</li>
	</ul>
	<a id="count()">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>count</h4>
	<pre class="methodSignature">long count()</pre>
	<div class="block">Returns the number of total entries in the cache.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>entries</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/QueryCacheInstrument.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 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: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </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 © 2006–2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
	</footer>
	</body>
	</html>