| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_121) on Fri Jan 06 19:36:25 UTC 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>QueryCacheInstrument (OpenJPA Parent POM 2.4.2 API)</title> |
| <meta name="date" content="2017-01-06"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="QueryCacheInstrument (OpenJPA Parent POM 2.4.2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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"> |
| <li><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/instrumentation/QueryCacheInstrument.html" target="_top">Frames</a></li> |
| <li><a href="QueryCacheInstrument.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>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 name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openjpa.instrumentation</div> |
| <h2 title="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><a href="../../../../org/apache/openjpa/instrumentation/jmx/QueryCacheJMXInstrumentMBean.html" title="interface in org.apache.openjpa.instrumentation.jmx">QueryCacheJMXInstrumentMBean</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation">AbstractQueryCacheInstrument</a>, <a href="../../../../org/apache/openjpa/instrumentation/jmx/QueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">QueryCacheJMXInstrument</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">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 =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#count()">count</a></strong>()</code> |
| <div class="block">Returns the number of total entries in the cache.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getEvictionCount()">getEvictionCount</a></strong>()</code> |
| <div class="block">Returns number of total evictions since last reset</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getExecutionCount()">getExecutionCount</a></strong>()</code> |
| <div class="block">Returns number of total execution requests since last reset</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getExecutionCount(java.lang.String)">getExecutionCount</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queryKey)</code> |
| <div class="block">Returns number of total execution requests since last reset for |
| the specified string-ified query key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getHitCount()">getHitCount</a></strong>()</code> |
| <div class="block">Returns number of total read requests that have been found in cache since |
| last reset.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getHitCount(java.lang.String)">getHitCount</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queryKey)</code> |
| <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 class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalEvictionCount()">getTotalEvictionCount</a></strong>()</code> |
| <div class="block">Returns number of total eviction requests since start.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalExecutionCount()">getTotalExecutionCount</a></strong>()</code> |
| <div class="block">Returns number of total exec requests since start.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalExecutionCount(java.lang.String)">getTotalExecutionCount</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queryKey)</code> |
| <div class="block">Returns number of total exec requests since start for |
| the specified string-ified query key.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalHitCount()">getTotalHitCount</a></strong>()</code> |
| <div class="block">Returns number of total read requests that has been found since start.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalHitCount(java.lang.String)">getTotalHitCount</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queryKey)</code> |
| <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 class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#queryKeys()">queryKeys</a></strong>()</code> |
| <div class="block">Returns all the string-ified keys for query results in the cache.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#reset()">reset</a></strong>()</code> |
| <div class="block">Resets cache statistics</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#sinceDate()">sinceDate</a></strong>()</code> |
| <div class="block">Returns date since cache statistics collection were last reset.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#startDate()">startDate</a></strong>()</code> |
| <div class="block">Returns date cache statistics collection started.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getTotalExecutionCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalExecutionCount</h4> |
| <pre>long getTotalExecutionCount()</pre> |
| <div class="block">Returns number of total exec requests since start.</div> |
| </li> |
| </ul> |
| <a name="getTotalExecutionCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalExecutionCount</h4> |
| <pre>long getTotalExecutionCount(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> queryKey)</pre> |
| <div class="block">Returns number of total exec requests since start for |
| the specified string-ified query key.</div> |
| </li> |
| </ul> |
| <a name="getExecutionCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutionCount</h4> |
| <pre>long getExecutionCount()</pre> |
| <div class="block">Returns number of total execution requests since last reset</div> |
| </li> |
| </ul> |
| <a name="getExecutionCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutionCount</h4> |
| <pre>long getExecutionCount(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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 name="getHitCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHitCount</h4> |
| <pre>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 name="getHitCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHitCount</h4> |
| <pre>long getHitCount(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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 name="getTotalHitCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalHitCount</h4> |
| <pre>long getTotalHitCount()</pre> |
| <div class="block">Returns number of total read requests that has been found since start.</div> |
| </li> |
| </ul> |
| <a name="getTotalHitCount(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalHitCount</h4> |
| <pre>long getTotalHitCount(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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 name="reset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>void reset()</pre> |
| <div class="block">Resets cache statistics</div> |
| </li> |
| </ul> |
| <a name="sinceDate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sinceDate</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> sinceDate()</pre> |
| <div class="block">Returns date since cache statistics collection were last reset.</div> |
| </li> |
| </ul> |
| <a name="startDate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startDate</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> startDate()</pre> |
| <div class="block">Returns date cache statistics collection started.</div> |
| </li> |
| </ul> |
| <a name="queryKeys()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryKeys</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> queryKeys()</pre> |
| <div class="block">Returns all the string-ified keys for query results in the cache.</div> |
| </li> |
| </ul> |
| <a name="getEvictionCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictionCount</h4> |
| <pre>long getEvictionCount()</pre> |
| <div class="block">Returns number of total evictions since last reset</div> |
| </li> |
| </ul> |
| <a name="getTotalEvictionCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalEvictionCount</h4> |
| <pre>long getTotalEvictionCount()</pre> |
| <div class="block">Returns number of total eviction requests since start.</div> |
| </li> |
| </ul> |
| <a name="count()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>count</h4> |
| <pre>long count()</pre> |
| <div class="block">Returns the number of total entries in the cache.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>entries</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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"> |
| <li><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/instrumentation/QueryCacheInstrument.html" target="_top">Frames</a></li> |
| <li><a href="QueryCacheInstrument.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>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 name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |