Google Git
Sign in
apache / incubator-retired-edgent-website / 1d74f4c030b7ba91ee3052633b8aafac15d6919c / . / site / javadoc / latest / org / apache / edgent / streamscope / StreamScopeBean.html
blob: 0a925b17dd2d1418ccced49be1dfc9ad2b167a04 [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 (1.8.0_112) on Mon Dec 18 11:25:21 EST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StreamScopeBean (Apache Edgent (incubating) v1.2.0 API)</title>
<meta name="date" content="2017-12-18">
<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="StreamScopeBean (Apache Edgent (incubating) v1.2.0 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};
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/StreamScopeBean.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/edgent/streamscope/StreamScope.TriggerManager.html" title="class in org.apache.edgent.streamscope"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/edgent/streamscope/StreamScopeRegistry.html" title="class in org.apache.edgent.streamscope"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/edgent/streamscope/StreamScopeBean.html" target="_top">Frames</a></li>
<li><a href="StreamScopeBean.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>Field&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>Field&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.edgent.streamscope</div>
<h2 title="Class StreamScopeBean" class="title">Class StreamScopeBean</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://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>org.apache.edgent.streamscope.StreamScopeBean</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">StreamScopeBean</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></pre>
<div class="block">Implementation of <a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans"><code>StreamScopeMXBean</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/edgent/streamscope/StreamScopeRegistryBean.html" title="class in org.apache.edgent.streamscope"><code>StreamScopeRegistryBean</code></a></dd>
</dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.edgent.streamscope.mbeans.StreamScopeMXBean">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.edgent.streamscope.mbeans.<a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></h3>
<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#TYPE">TYPE</a></code></li>
</ul>
</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/edgent/streamscope/StreamScopeBean.html#StreamScopeBean-org.apache.edgent.streamscope.StreamScope-">StreamScopeBean</a></span>(<a href="../../../../org/apache/edgent/streamscope/StreamScope.html" title="class in org.apache.edgent.streamscope">StreamScope</a>&lt;?&gt;&nbsp;streamScope)</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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/streamscope/StreamScopeBean.html#getSampleCount--">getSampleCount</a></span>()</code>
<div class="block">Get the number of Samples currently captured</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://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/edgent/streamscope/StreamScopeBean.html#getSamples--">getSamples</a></span>()</code>
<div class="block">Get all captured tuples as JSON.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/streamscope/StreamScopeBean.html#isEnabled--">isEnabled</a></span>()</code>
<div class="block">Is tuple capture enabled?</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/streamscope/StreamScopeBean.html#isPaused--">isPaused</a></span>()</code>
<div class="block">Is capture paused?</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/streamscope/StreamScopeBean.html#setCaptureByCount-int-">setCaptureByCount</a></span>(int&nbsp;count)</code>
<div class="block">Capture the first and every nth tuple</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/streamscope/StreamScopeBean.html#setCaptureByTime-long-java.util.concurrent.TimeUnit-">setCaptureByTime</a></span>(long&nbsp;elapsed,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Capture the 1st tuple and then the next tuple after <code>period</code>
<code>unit</code> time has elapsed since the previous captured tuple.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/streamscope/StreamScopeBean.html#setEnabled-boolean-">setEnabled</a></span>(boolean&nbsp;isEnabled)</code>
<div class="block">Enable or disable tuple capture.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/streamscope/StreamScopeBean.html#setMaxRetentionCount-int-">setMaxRetentionCount</a></span>(int&nbsp;maxCount)</code>
<div class="block">Set the maximum number of tuples to retain.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/streamscope/StreamScopeBean.html#setMaxRetentionTime-long-java.util.concurrent.TimeUnit-">setMaxRetentionTime</a></span>(long&nbsp;age,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</code>
<div class="block">Set the maximum retention time of a tuple.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/streamscope/StreamScopeBean.html#setPaused-boolean-">setPaused</a></span>(boolean&nbsp;paused)</code>
<div class="block">Set capture paused control</div>
</td>
</tr>
</table>
<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://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StreamScopeBean-org.apache.edgent.streamscope.StreamScope-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StreamScopeBean</h4>
<pre>public&nbsp;StreamScopeBean(<a href="../../../../org/apache/edgent/streamscope/StreamScope.html" title="class in org.apache.edgent.streamscope">StreamScope</a>&lt;?&gt;&nbsp;streamScope)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isEnabled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnabled</h4>
<pre>public&nbsp;boolean&nbsp;isEnabled()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#isEnabled--">StreamScopeMXBean</a></code></span></div>
<div class="block">Is tuple capture enabled?</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#isEnabled--">isEnabled</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if enabled.</dd>
</dl>
</li>
</ul>
<a name="setEnabled-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnabled</h4>
<pre>public&nbsp;void&nbsp;setEnabled(boolean&nbsp;isEnabled)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setEnabled-boolean-">StreamScopeMXBean</a></code></span></div>
<div class="block">Enable or disable tuple capture.
<P>
Disabling releases the capture buffer.
</P></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setEnabled-boolean-">setEnabled</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>isEnabled</code> - true to enable, false to disable.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setPaused-boolean-"><code>StreamScopeMXBean.setPaused(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="isPaused--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPaused</h4>
<pre>public&nbsp;boolean&nbsp;isPaused()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#isPaused--">StreamScopeMXBean</a></code></span></div>
<div class="block">Is capture paused?</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#isPaused--">isPaused</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if paused</dd>
</dl>
</li>
</ul>
<a name="setPaused-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPaused</h4>
<pre>public&nbsp;void&nbsp;setPaused(boolean&nbsp;paused)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setPaused-boolean-">StreamScopeMXBean</a></code></span></div>
<div class="block">Set capture paused control
<P>
Pausing doesn't affect the capture buffer's current contents.
</P></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setPaused-boolean-">setPaused</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>paused</code> - true to pause, false to clear pause.</dd>
</dl>
</li>
</ul>
<a name="getSamples--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSamples</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSamples()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#getSamples--">StreamScopeMXBean</a></code></span></div>
<div class="block">Get all captured tuples as JSON.
<P>
The JSON is that generated by <code>Gson.toJson(StreamScope.getSamples())</code>.
</P><P>
The JSON is an array of <a href="../../../../org/apache/edgent/streamscope/StreamScope.Sample.html" title="class in org.apache.edgent.streamscope"><code>Sample</code></a> JSON objects.
Each Sample JSON object consists of:
<UL>
<LI>ts - long. capture timestamp in millis from System.currentTimeMillis()</LI>
<LI>nanos - long. capture nanosecond timestamp from System.nanoTime()</LI>
<LI>tuple - see below</LI>
</UL>
The value of the "tuple" property is:
<UL>
<LI>for a primitive tuple type like String, Numeric or Boolean it's a
JSON string, numeric, or boolean value respectively.</LI>
<LI>Arrays or collections are a JSON array of JSON elements for the members.</LI>
<LI>For other types it's a JSON object with the type's
members and JSON encoding of their values.</LI>
</UL>
<P>
The returned samples are removed from the capture buffer.
</P></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#getSamples--">getSamples</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JSON of the captured samples</dd>
</dl>
</li>
</ul>
<a name="getSampleCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSampleCount</h4>
<pre>public&nbsp;int&nbsp;getSampleCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#getSampleCount--">StreamScopeMXBean</a></code></span></div>
<div class="block">Get the number of Samples currently captured</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#getSampleCount--">getSampleCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the count</dd>
</dl>
</li>
</ul>
<a name="setMaxRetentionCount-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxRetentionCount</h4>
<pre>public&nbsp;void&nbsp;setMaxRetentionCount(int&nbsp;maxCount)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setMaxRetentionCount-int-">StreamScopeMXBean</a></code></span></div>
<div class="block">Set the maximum number of tuples to retain.
<P>
The capture buffer is cleared.
</P></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setMaxRetentionCount-int-">setMaxRetentionCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxCount</code> - the maximum number of tuples to retain.
Specify 0 to disable count based retention.</dd>
</dl>
</li>
</ul>
<a name="setMaxRetentionTime-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxRetentionTime</h4>
<pre>public&nbsp;void&nbsp;setMaxRetentionTime(long&nbsp;age,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setMaxRetentionTime-long-java.util.concurrent.TimeUnit-">StreamScopeMXBean</a></code></span></div>
<div class="block">Set the maximum retention time of a tuple.
<P>
The capture buffer is cleared.
</P></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setMaxRetentionTime-long-java.util.concurrent.TimeUnit-">setMaxRetentionTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>age</code> - the amount of time to retain a tuple.
Specify 0 to disable age based retention.</dd>
<dd><code>unit</code> - <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent"><code>TimeUnit</code></a></dd>
</dl>
</li>
</ul>
<a name="setCaptureByCount-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCaptureByCount</h4>
<pre>public&nbsp;void&nbsp;setCaptureByCount(int&nbsp;count)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setCaptureByCount-int-">StreamScopeMXBean</a></code></span></div>
<div class="block">Capture the first and every nth tuple</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setCaptureByCount-int-">setCaptureByCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>count</code> - the nth value interval</dd>
</dl>
</li>
</ul>
<a name="setCaptureByTime-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCaptureByTime</h4>
<pre>public&nbsp;void&nbsp;setCaptureByTime(long&nbsp;elapsed,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setCaptureByTime-long-java.util.concurrent.TimeUnit-">StreamScopeMXBean</a></code></span></div>
<div class="block">Capture the 1st tuple and then the next tuple after <code>period</code>
<code>unit</code> time has elapsed since the previous captured tuple.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html#setCaptureByTime-long-java.util.concurrent.TimeUnit-">setCaptureByTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/edgent/streamscope/mbeans/StreamScopeMXBean.html" title="interface in org.apache.edgent.streamscope.mbeans">StreamScopeMXBean</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elapsed</code> - time to delay until next capture</dd>
<dd><code>unit</code> - <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent"><code>TimeUnit</code></a></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/StreamScopeBean.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/edgent/streamscope/StreamScope.TriggerManager.html" title="class in org.apache.edgent.streamscope"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/edgent/streamscope/StreamScopeRegistry.html" title="class in org.apache.edgent.streamscope"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/edgent/streamscope/StreamScopeBean.html" target="_top">Frames</a></li>
<li><a href="StreamScopeBean.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>Field&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>Field&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; 2016&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>