blob: 5e0b2bf8894588e3820204bcbcf60e19bbd09203 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:00 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PreparedQueryCacheInstrument (OpenJPA Parent POM 2.4.3 API)</title>
<meta name="date" content="2018-06-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PreparedQueryCacheInstrument (OpenJPA Parent POM 2.4.3 API)";
}
//-->
</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/PreparedQueryCacheInstrument.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/InstrumentationManagerImpl.html" title="class in org.apache.openjpa.instrumentation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" target="_top">Frames</a></li>
<li><a href="PreparedQueryCacheInstrument.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:&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 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 PreparedQueryCacheInstrument" class="title">Interface PreparedQueryCacheInstrument</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/PreparedQueryCacheJMXInstrumentMBean.html" title="interface in org.apache.openjpa.instrumentation.jmx">PreparedQueryCacheJMXInstrumentMBean</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation">AbstractPreparedQueryCacheInstrument</a>, <a href="../../../../org/apache/openjpa/instrumentation/jmx/PreparedQueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">PreparedQueryCacheJMXInstrument</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">PreparedQueryCacheInstrument</span></pre>
</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">&nbsp;</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/PreparedQueryCacheInstrument.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/PreparedQueryCacheInstrument.html#getExecutionCount(java.lang.String)">getExecutionCount</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</code>
<div class="block">Returns number of total execution requests 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/PreparedQueryCacheInstrument.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/PreparedQueryCacheInstrument.html#getHitCount(java.lang.String)">getHitCount</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</code>
<div class="block">Returns number of total read requests that have been found in cache 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/PreparedQueryCacheInstrument.html#getTotalExecutionCount()">getTotalExecutionCount</a></strong>()</code>
<div class="block">Returns number of total exec 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/PreparedQueryCacheInstrument.html#getTotalExecutionCount(java.lang.String)">getTotalExecutionCount</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</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/PreparedQueryCacheInstrument.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="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getTotalHitCount(java.lang.String)">getTotalHitCount</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</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><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#queries()">queries</a></strong>()</code>
<div class="block">Returns all queries currently tracked in the cache.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#reset()">reset</a></strong>()</code>
<div class="block">Resets cache statistics</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.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/PreparedQueryCacheInstrument.html#sinceDate()">sinceDate</a></strong>()</code>
<div class="block">Returns date since cache statistics collection were last reset.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.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/PreparedQueryCacheInstrument.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&nbsp;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&nbsp;getTotalExecutionCount(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block">Returns number of total exec requests since start.</div>
</li>
</ul>
<a name="getExecutionCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutionCount</h4>
<pre>long&nbsp;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&nbsp;getExecutionCount(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block">Returns number of total execution requests since last reset</div>
</li>
</ul>
<a name="getHitCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHitCount</h4>
<pre>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 name="getHitCount(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHitCount</h4>
<pre>long&nbsp;getHitCount(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block">Returns number of total read requests that have been found in cache since
last reset.</div>
</li>
</ul>
<a name="getTotalHitCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalHitCount</h4>
<pre>long&nbsp;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&nbsp;getTotalHitCount(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block">Returns number of total read requests that has been found since start.</div>
</li>
</ul>
<a name="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>void&nbsp;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://docs.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;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://docs.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;startDate()</pre>
<div class="block">Returns date cache statistics collection started.</div>
</li>
</ul>
<a name="queries()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>queries</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;queries()</pre>
<div class="block">Returns all queries currently tracked in the cache.</div>
</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/PreparedQueryCacheInstrument.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/InstrumentationManagerImpl.html" title="class in org.apache.openjpa.instrumentation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" target="_top">Frames</a></li>
<li><a href="PreparedQueryCacheInstrument.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:&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 name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>