Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 3.1.2 / apidocs / org / apache / openjpa / instrumentation / AbstractPreparedQueryCacheInstrument.html
blob: 4d8edb18250b61e5b72f784fbb6573f4289e0b01 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_252) on Thu Sep 03 11:54:23 CEST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractPreparedQueryCacheInstrument (OpenJPA Parent POM 3.1.2 API)</title>
<meta name="date" content="2020-09-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractPreparedQueryCacheInstrument (OpenJPA Parent POM 3.1.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"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};
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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/AbstractPreparedQueryCacheInstrument.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/AbstractDataCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html" target="_top">Frames</a></li>
<li><a href="AbstractPreparedQueryCacheInstrument.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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><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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.openjpa.instrumentation</div>
<h2 title="Class AbstractPreparedQueryCacheInstrument" class="title">Class AbstractPreparedQueryCacheInstrument</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">org.apache.openjpa.lib.instrumentation.AbstractInstrument</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.instrumentation.AbstractPreparedQueryCacheInstrument</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/openjpa/instrumentation/jmx/PreparedQueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">PreparedQueryCacheJMXInstrument</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractPreparedQueryCacheInstrument</span>
extends <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</a>
implements <a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></pre>
<div class="block">Provides a basic instrument implementation wrapper for the prepared query cache. This
class can be extended to create a provider specific instrument for the
prepared query cache.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#NO_STATS">NO_STATS</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#AbstractPreparedQueryCacheInstrument--">AbstractPreparedQueryCacheInstrument</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getConfigId--">getConfigId</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getContextRef--">getContextRef</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getExecutionCount--">getExecutionCount</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getExecutionCount-java.lang.String-">getExecutionCount</a></span>(<a href="https://docs.oracle.com/javase/8/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 id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getHitCount--">getHitCount</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getHitCount-java.lang.String-">getHitCount</a></span>(<a href="https://docs.oracle.com/javase/8/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 id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/lib/instrumentation/InstrumentationLevel.html" title="enum in org.apache.openjpa.lib.instrumentation">InstrumentationLevel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getLevel--">getLevel</a></span>()</code>
<div class="block">Gets the instrumentation level of this instrument.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getTotalExecutionCount--">getTotalExecutionCount</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getTotalExecutionCount-java.lang.String-">getTotalExecutionCount</a></span>(<a href="https://docs.oracle.com/javase/8/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 id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getTotalHitCount--">getTotalHitCount</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#getTotalHitCount-java.lang.String-">getTotalHitCount</a></span>(<a href="https://docs.oracle.com/javase/8/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 id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/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><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#queries--">queries</a></span>()</code>
<div class="block">Returns all queries currently tracked in the cache.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#reset--">reset</a></span>()</code>
<div class="block">Resets cache statistics</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#setConfigId-java.lang.String-">setConfigId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cid)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#setContextRef-java.lang.String-">setContextRef</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cref)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#setPreparedQueryCache-org.apache.openjpa.kernel.PreparedQueryCache-">setPreparedQueryCache</a></span>(<a href="../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</a>&nbsp;qc)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#sinceDate--">sinceDate</a></span>()</code>
<div class="block">Returns date since cache statistics collection were last reset.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html#startDate--">startDate</a></span>()</code>
<div class="block">Returns date cache statistics collection started.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.lib.instrumentation.AbstractInstrument">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.lib.instrumentation.<a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</a></h3>
<code><a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getContext--">getContext</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getName--">getName</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getOptions--">getOptions</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getProvider--">getProvider</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#initialize--">initialize</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#isStarted--">isStarted</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#restart--">restart</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#setContext-java.lang.Object-">setContext</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#setOptions-java.lang.String-">setOptions</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#setProvider-org.apache.openjpa.lib.instrumentation.InstrumentationProvider-">setProvider</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#setStarted-boolean-">setStarted</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.lib.instrumentation.Instrument">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.lib.instrumentation.<a href="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html" title="interface in org.apache.openjpa.lib.instrumentation">Instrument</a></h3>
<code><a href="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#start--">start</a>, <a href="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#stop--">stop</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="NO_STATS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NO_STATS</h4>
<pre>public static final&nbsp;long NO_STATS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.openjpa.instrumentation.AbstractPreparedQueryCacheInstrument.NO_STATS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractPreparedQueryCacheInstrument--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractPreparedQueryCacheInstrument</h4>
<pre>public&nbsp;AbstractPreparedQueryCacheInstrument()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setConfigId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfigId</h4>
<pre>public&nbsp;void&nbsp;setConfigId(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cid)</pre>
</li>
</ul>
<a name="setContextRef-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContextRef</h4>
<pre>public&nbsp;void&nbsp;setContextRef(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cref)</pre>
</li>
</ul>
<a name="getConfigId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfigId</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getConfigId()</pre>
</li>
</ul>
<a name="getContextRef--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContextRef</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getContextRef()</pre>
</li>
</ul>
<a name="setPreparedQueryCache-org.apache.openjpa.kernel.PreparedQueryCache-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreparedQueryCache</h4>
<pre>public&nbsp;void&nbsp;setPreparedQueryCache(<a href="../../../../org/apache/openjpa/kernel/PreparedQueryCache.html" title="interface in org.apache.openjpa.kernel">PreparedQueryCache</a>&nbsp;qc)</pre>
</li>
</ul>
<a name="getExecutionCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutionCount</h4>
<pre>public&nbsp;long&nbsp;getExecutionCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getExecutionCount--">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Returns number of total execution requests since last reset</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getExecutionCount--">getExecutionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getExecutionCount-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutionCount</h4>
<pre>public&nbsp;long&nbsp;getExecutionCount(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getExecutionCount-java.lang.String-">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Returns number of total execution requests since last reset</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getExecutionCount-java.lang.String-">getExecutionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getTotalExecutionCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalExecutionCount</h4>
<pre>public&nbsp;long&nbsp;getTotalExecutionCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getTotalExecutionCount--">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Returns number of total exec requests since start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getTotalExecutionCount--">getTotalExecutionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getTotalExecutionCount-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalExecutionCount</h4>
<pre>public&nbsp;long&nbsp;getTotalExecutionCount(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getTotalExecutionCount-java.lang.String-">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Returns number of total exec requests since start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getTotalExecutionCount-java.lang.String-">getTotalExecutionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getHitCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHitCount</h4>
<pre>public&nbsp;long&nbsp;getHitCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getHitCount--">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Returns number of total read requests that have been found in cache since
last reset.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getHitCount--">getHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getHitCount-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHitCount</h4>
<pre>public&nbsp;long&nbsp;getHitCount(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getHitCount-java.lang.String-">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Returns number of total read requests that have been found in cache since
last reset.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getHitCount-java.lang.String-">getHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getTotalHitCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalHitCount</h4>
<pre>public&nbsp;long&nbsp;getTotalHitCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getTotalHitCount--">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Returns number of total read requests that has been found since start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getTotalHitCount--">getTotalHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getTotalHitCount-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalHitCount</h4>
<pre>public&nbsp;long&nbsp;getTotalHitCount(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;query)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getTotalHitCount-java.lang.String-">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Returns number of total read requests that has been found since start.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#getTotalHitCount-java.lang.String-">getTotalHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#reset--">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Resets cache statistics</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#reset--">reset</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="sinceDate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sinceDate</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;sinceDate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#sinceDate--">PreparedQueryCacheInstrument</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="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#sinceDate--">sinceDate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="startDate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startDate</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;startDate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#startDate--">PreparedQueryCacheInstrument</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="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#startDate--">startDate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="queries--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queries</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#queries--">PreparedQueryCacheInstrument</a></code></span></div>
<div class="block">Returns all queries currently tracked in the cache.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html#queries--">queries</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/PreparedQueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">PreparedQueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getLevel--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLevel</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/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="../../../../org/apache/openjpa/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="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#getLevel--">getLevel</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/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="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html#getLevel--">getLevel</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/openjpa/lib/instrumentation/AbstractInstrument.html" title="class in org.apache.openjpa.lib.instrumentation">AbstractInstrument</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the instrumentation level of the instrument</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/AbstractPreparedQueryCacheInstrument.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/AbstractDataCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/instrumentation/AbstractPreparedQueryCacheInstrument.html" target="_top">Frames</a></li>
<li><a href="AbstractPreparedQueryCacheInstrument.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>