Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.2 / apidocs / org / apache / openjpa / instrumentation / AbstractQueryCacheInstrument.html
blob: db3b0ef30e272cfcb17d9287dcd340c957e4391e [file] [log] [blame]
<!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>AbstractQueryCacheInstrument (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="AbstractQueryCacheInstrument (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/AbstractQueryCacheInstrument.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/AbstractPreparedQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.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/AbstractQueryCacheInstrument.html" target="_top">Frames</a></li>
<li><a href="AbstractQueryCacheInstrument.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><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 AbstractQueryCacheInstrument" class="title">Class AbstractQueryCacheInstrument</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/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.AbstractQueryCacheInstrument</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/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</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/QueryCacheJMXInstrument.html" title="class in org.apache.openjpa.instrumentation.jmx">QueryCacheJMXInstrument</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractQueryCacheInstrument</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/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</a></pre>
<div class="block">Provides a basic instrument implementation wrapper for the query cache. This
class can be extended to create a provider specific instrument for the
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="overviewSummary" 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><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html#NO_STATS">NO_STATS</a></strong></code>
<div class="block">Value indicating that cache statistics are not available.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html#AbstractQueryCacheInstrument()">AbstractQueryCacheInstrument</a></strong>()</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="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/AbstractQueryCacheInstrument.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><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/AbstractQueryCacheInstrument.html#getConfigId()">getConfigId</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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/AbstractQueryCacheInstrument.html#getContextRef()">getContextRef</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.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/AbstractQueryCacheInstrument.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/AbstractQueryCacheInstrument.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>&nbsp;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/AbstractQueryCacheInstrument.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/AbstractQueryCacheInstrument.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>&nbsp;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><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><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html#getLevel()">getLevel</a></strong>()</code>
<div class="block">Gets the instrumentation level of this instrument.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html#getTotalEvictionCount()">getTotalEvictionCount</a></strong>()</code>
<div class="block">Returns number of total eviction 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/AbstractQueryCacheInstrument.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/AbstractQueryCacheInstrument.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>&nbsp;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="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.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/AbstractQueryCacheInstrument.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>&nbsp;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="altColor">
<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>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html#queryKeys()">queryKeys</a></strong>()</code>
<div class="block">Returns all query keys 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/AbstractQueryCacheInstrument.html#reset()">reset</a></strong>()</code>
<div class="block">Resets cache statistics</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html#setConfigId(java.lang.String)">setConfigId</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>&nbsp;cid)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html#setContextRef(java.lang.String)">setContextRef</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>&nbsp;cref)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html#setPreparedQueryCache(org.apache.openjpa.datacache.QueryCache)">setPreparedQueryCache</a></strong>(<a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a>&nbsp;qc)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/instrumentation/AbstractQueryCacheInstrument.html#setQueryCache(org.apache.openjpa.datacache.QueryCache)">setQueryCache</a></strong>(<a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a>&nbsp;qc)</code>&nbsp;</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/AbstractQueryCacheInstrument.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://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/AbstractQueryCacheInstrument.html#startDate()">startDate</a></strong>()</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="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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>
<div class="block">Value indicating that cache statistics are not available.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.openjpa.instrumentation.AbstractQueryCacheInstrument.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="AbstractQueryCacheInstrument()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractQueryCacheInstrument</h4>
<pre>public&nbsp;AbstractQueryCacheInstrument()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setQueryCache(org.apache.openjpa.datacache.QueryCache)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueryCache</h4>
<pre>public&nbsp;void&nbsp;setQueryCache(<a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</a>&nbsp;qc)</pre>
</li>
</ul>
<a name="setConfigId(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfigId</h4>
<pre>public&nbsp;void&nbsp;setConfigId(<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>&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="http://download.oracle.com/javase/6/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="http://download.oracle.com/javase/6/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="http://download.oracle.com/javase/6/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.datacache.QueryCache)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreparedQueryCache</h4>
<pre>public&nbsp;void&nbsp;setPreparedQueryCache(<a href="../../../../org/apache/openjpa/datacache/QueryCache.html" title="interface in org.apache.openjpa.datacache">QueryCache</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"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getExecutionCount()">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns number of total execution requests since last reset</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getExecutionCount()">getExecutionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queryKey)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getExecutionCount(java.lang.String)">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns number of total execution requests since last reset for
the specified string-ified query key.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getExecutionCount(java.lang.String)">getExecutionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</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"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalExecutionCount()">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns number of total exec requests since start.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalExecutionCount()">getTotalExecutionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queryKey)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalExecutionCount(java.lang.String)">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns number of total exec requests since start for
the specified string-ified query key.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalExecutionCount(java.lang.String)">getTotalExecutionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</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"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getHitCount()">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns number of total read requests that have been found in cache since
last reset.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getHitCount()">getHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queryKey)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getHitCount(java.lang.String)">QueryCacheInstrument</a></code></strong></div>
<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>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getHitCount(java.lang.String)">getHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</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"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalHitCount()">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns number of total read requests that has been found since start.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalHitCount()">getTotalHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;queryKey)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalHitCount(java.lang.String)">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns number of total read requests that has been found since start for
the specified string-ified query key.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalHitCount(java.lang.String)">getTotalHitCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</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"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#reset()">QueryCacheInstrument</a></code></strong></div>
<div class="block">Resets cache statistics</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#reset()">reset</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="sinceDate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sinceDate</h4>
<pre>public&nbsp;<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>&nbsp;sinceDate()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#sinceDate()">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns date since cache statistics collection were last reset.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#sinceDate()">sinceDate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="startDate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startDate</h4>
<pre>public&nbsp;<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>&nbsp;startDate()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#startDate()">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns date cache statistics collection started.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#startDate()">startDate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getEvictionCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEvictionCount</h4>
<pre>public&nbsp;long&nbsp;getEvictionCount()</pre>
<div class="block">Returns number of total evictions since last reset</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getEvictionCount()">getEvictionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="getTotalEvictionCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalEvictionCount</h4>
<pre>public&nbsp;long&nbsp;getTotalEvictionCount()</pre>
<div class="block">Returns number of total eviction requests since start.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#getTotalEvictionCount()">getTotalEvictionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="queryKeys()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryKeys</h4>
<pre>public&nbsp;<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>&lt;<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>&gt;&nbsp;queryKeys()</pre>
<div class="block">Returns all query keys currently tracked in the cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#queryKeys()">queryKeys</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</a></code></dd>
</dl>
</li>
</ul>
<a name="count()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre>public&nbsp;long&nbsp;count()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#count()">QueryCacheInstrument</a></code></strong></div>
<div class="block">Returns the number of total entries in the cache.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html#count()">count</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/instrumentation/QueryCacheInstrument.html" title="interface in org.apache.openjpa.instrumentation">QueryCacheInstrument</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>entries</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"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/lib/instrumentation/Instrument.html#getLevel()">Instrument</a></code></strong></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><strong>Specified by:</strong></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><strong>Overrides:</strong></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="strong">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><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/AbstractQueryCacheInstrument.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/AbstractPreparedQueryCacheInstrument.html" title="class in org.apache.openjpa.instrumentation"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/instrumentation/DataCacheInstrument.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/AbstractQueryCacheInstrument.html" target="_top">Frames</a></li>
<li><a href="AbstractQueryCacheInstrument.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><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;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>