http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Deadtime.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Deadtime.html b/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Deadtime.html new file mode 100644 index 0000000..d2e160b --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Deadtime.html @@ -0,0 +1,393 @@ +<!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 Sun Feb 26 17:08:09 EST 2017 --> +<title>Deadtime (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<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="Deadtime (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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/Deadtime.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>Prev Class</li> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Filters.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Deadtime.html" target="_top">Frames</a></li> +<li><a href="Deadtime.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.analytics.sensors</div> +<h2 title="Class Deadtime" class="title">Class Deadtime<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.analytics.sensors.Deadtime<T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - tuple type</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><T></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Deadtime<T></span> +extends java.lang.Object +implements <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><T></pre> +<div class="block">Deadtime <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function"><code>Predicate</code></a>. + <p> + <a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html#test-T-"><code>test()</code></a> returns true on its initial call + and then false for any calls occurring during the following deadtime period. + After the end of a deadtime period, the next call to <code>test()</code> + returns true and a new deadtime period is begun. + </p><p> + The deadtime period may be changed while the topology is running + via <a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html#setPeriod-long-java.util.concurrent.TimeUnit-"><code>setPeriod(long, TimeUnit)</code></a>. + </p></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/edgent/analytics/sensors/Filters.html#deadtime-org.apache.edgent.topology.TStream-long-java.util.concurrent.TimeUnit-"><code>Filters.deadtime()</code></a>, +<a href="../../../../../serialized-form.html#org.apache.edgent.analytics.sensors.Deadtime">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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"> </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/analytics/sensors/Deadtime.html#Deadtime--">Deadtime</a></span>()</code> +<div class="block">Create a new Deadtime Predicate</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html#Deadtime-long-java.util.concurrent.TimeUnit-">Deadtime</a></span>(long deadtimePeriod, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Create a new Deadtime Predicate</div> +</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html#setPeriod-long-java.util.concurrent.TimeUnit-">setPeriod</a></span>(long deadtimePeriod, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Set the deadtime period</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html#test-T-">test</a></span>(<a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html" title="type parameter in Deadtime">T</a> value)</code> +<div class="block">Test the deadtime predicate.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html#toString--">toString</a></span>()</code> +<div class="block">Returns a String for development/debug support.</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 java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="Deadtime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Deadtime</h4> +<pre>public Deadtime()</pre> +<div class="block">Create a new Deadtime Predicate + <p> + Same as <code>Deadtime(0, TimeUnit.SECONDS)</code></div> +</li> +</ul> +<a name="Deadtime-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Deadtime</h4> +<pre>public Deadtime(long deadtimePeriod, + java.util.concurrent.TimeUnit unit)</pre> +<div class="block">Create a new Deadtime Predicate + <p> + The first received tuple is always "accepted".</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deadtimePeriod</code> - see <a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html#setPeriod-long-java.util.concurrent.TimeUnit-"><code>setPeriod()</code></a></dd> +<dd><code>unit</code> - <code>TimeUnit</code> of <code>deadtimePeriod</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setPeriod-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPeriod</h4> +<pre>public void setPeriod(long deadtimePeriod, + java.util.concurrent.TimeUnit unit)</pre> +<div class="block">Set the deadtime period + <p> + The end of a currently active deadtime period is shortened or extended + to match the new deadtime period specification. + </p><p> + The deadtime period behavior is subject to the accuracy + of the system's <code>System.currentTimeMillis()</code>. + A period of less than 1ms is equivalent to specifying 0. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>deadtimePeriod</code> - the amount of time for <code>test()</code> + to return false after returning true. + Specify a value of 0 for no deadtime period. + Must be >= 0.</dd> +<dd><code>unit</code> - <code>TimeUnit</code> of <code>deadtimePeriod</code></dd> +</dl> +</li> +</ul> +<a name="test-java.lang.Object-"> +<!-- --> +</a><a name="test-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>test</h4> +<pre>public boolean test(<a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html" title="type parameter in Deadtime">T</a> value)</pre> +<div class="block">Test the deadtime predicate.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/edgent/function/Predicate.html#test-T-">test</a></code> in interface <code><a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><<a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html" title="type parameter in Deadtime">T</a>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - ignored</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>false if in a deadtime period, true otherwise</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns a String for development/debug support. Content subject to change.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></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/Deadtime.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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Filters.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Deadtime.html" target="_top">Frames</a></li> +<li><a href="Deadtime.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Filters.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Filters.html b/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Filters.html new file mode 100644 index 0000000..f0001c1 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Filters.html @@ -0,0 +1,387 @@ +<!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 Sun Feb 26 17:08:09 EST 2017 --> +<title>Filters (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<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="Filters (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Filters.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/analytics/sensors/Deadtime.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Filters.html" target="_top">Frames</a></li> +<li><a href="Filters.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.edgent.analytics.sensors</div> +<h2 title="Class Filters" class="title">Class Filters</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.analytics.sensors.Filters</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Filters</span> +extends java.lang.Object</pre> +<div class="block">Filters aimed at sensors.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static <T,V> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Filters.html#deadband-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.Predicate-">deadband</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> stream, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,V> value, + <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><V> inBand)</code> +<div class="block">Deadband filter.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <T,V> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Filters.html#deadband-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.Predicate-long-java.util.concurrent.TimeUnit-">deadband</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> stream, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,V> value, + <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><V> inBand, + long maximumSuppression, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Deadband filter with maximum suppression time.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Filters.html#deadtime-org.apache.edgent.topology.TStream-long-java.util.concurrent.TimeUnit-">deadtime</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> stream, + long deadtimePeriod, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Deadtime filter.</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 java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="deadband-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.Predicate-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deadband</h4> +<pre>public static <T,V> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> deadband(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> stream, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,V> value, + <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><V> inBand, + long maximumSuppression, + java.util.concurrent.TimeUnit unit)</pre> +<div class="block">Deadband filter with maximum suppression time. + + A filter that discards any tuples that are in the deadband, uninteresting to downstream consumers. + <P> + A tuple <code>t</code> is passed through the deadband filter if: + <UL> + <LI> + <code>inBand.test(value.apply(t))</code> is false, that is the tuple's value is outside of the deadband + </LI> + <LI> + OR <code>inBand.test(value.apply(t))</code> is true AND the last tuple's value was outside of the deadband. + This corresponds to the first tuple's value inside the deadband after a period being outside it. + </LI> + <LI> + OR it has been more than <code>maximumSuppression</code> seconds (in unit <code>unit</code>) + </LI> + <LI> + OR it is the first tuple (effectively the state of the filter starts as outside of the deadband). + </LI> + </UL></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type.</dd> +<dd><code>V</code> - Value type for the deadband function.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream containing readings.</dd> +<dd><code>value</code> - Function to obtain the tuple's value passed to the deadband function.</dd> +<dd><code>inBand</code> - Function that defines the deadband.</dd> +<dd><code>maximumSuppression</code> - Maximum amount of time to suppress values that are in the deadband.</dd> +<dd><code>unit</code> - Unit for <code>maximumSuppression</code>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Filtered stream.</dd> +</dl> +</li> +</ul> +<a name="deadband-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.Predicate-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deadband</h4> +<pre>public static <T,V> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> deadband(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> stream, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,V> value, + <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><V> inBand)</pre> +<div class="block">Deadband filter. + + A filter that discards any tuples that are in the deadband, uninteresting to downstream consumers. + <P> + A tuple <code>t</code> is passed through the deadband filter if: + <UL> + <LI> + <code>inBand.test(value.apply(t))</code> is false, that is the value is outside of the deadband + </LI> + <LI> + OR <code>inBand.test(value.apply(t))</code> is true and the last value was outside of the deadband. + This corresponds to the first value inside the deadband after a period being outside it. + </LI> + <LI> + OR it is the first tuple (effectively the state of the filter starts as outside of the deadband). + </LI> + </UL> + <P> + Here's an example of how <code>deadband()</code> would pass through tuples for a sequence of + values against the shaded dead band area. Circled values are ones that are passed through + the filter to the returned stream. + <BR> + <UL> + <LI>All tuples with a value outside the dead band.</LI> + <LI>Two tuples with values within the dead band that are the first time values return to being in band + after being outside of the dead band.</LI> + <LI>The first tuple.</LI> + </UL> + <BR> + <img src="doc-files/deadband.png" alt="Deadband example"></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Tuple type.</dd> +<dd><code>V</code> - Value type for the deadband function.</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream containing readings.</dd> +<dd><code>value</code> - Function to obtain the value passed to the deadband function.</dd> +<dd><code>inBand</code> - Function that defines the deadband.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Filtered stream.</dd> +</dl> +</li> +</ul> +<a name="deadtime-org.apache.edgent.topology.TStream-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>deadtime</h4> +<pre>public static <T> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> deadtime(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> stream, + long deadtimePeriod, + java.util.concurrent.TimeUnit unit)</pre> +<div class="block">Deadtime filter. + + A filter that discards tuples for a period of time after passing + a tuple. + <p> + E.g., for a deadtime period of 30 minutes, after letting a tuple + pass through, any tuples received during the next 30 minutes are + filtered out. Then the next arriving tuple is passed through and + a new deadtime period is begun. + </p><p> + Use <a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html" title="class in org.apache.edgent.analytics.sensors"><code>Deadtime</code></a> directly if you need to change the deadtime period + while the topology is running. + </p></div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - tuple type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - TStream to add deadtime filter to</dd> +<dd><code>deadtimePeriod</code> - the deadtime period in <code>unit</code></dd> +<dd><code>unit</code> - the <code>TimeUnit</code> to apply to <code>deadtimePeriod</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the deadtime filtered stream</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html" title="class in org.apache.edgent.analytics.sensors"><code>Deadtime</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/Filters.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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Deadtime.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Filters.html" target="_top">Frames</a></li> +<li><a href="Filters.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Range.BoundType.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Range.BoundType.html b/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Range.BoundType.html new file mode 100644 index 0000000..ebd9c64 --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Range.BoundType.html @@ -0,0 +1,354 @@ +<!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 Sun Feb 26 17:08:09 EST 2017 --> +<title>Range.BoundType (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<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="Range.BoundType (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Range.BoundType.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/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Ranges.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Range.BoundType.html" target="_top">Frames</a></li> +<li><a href="Range.BoundType.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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.analytics.sensors</div> +<h2 title="Enum Range.BoundType" class="title">Enum Range.BoundType</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.analytics.sensors.Range.BoundType</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a><<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> extends java.lang.Comparable<?>></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="typeNameLabel">Range.BoundType</span> +extends java.lang.Enum<<a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>></pre> +<div class="block">Exclude or include an endpoint value in the range.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html#CLOSED">CLOSED</a></span></code> +<div class="block">inclusive</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html#OPEN">OPEN</a></span></code> +<div class="block">exclusive</div> +</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="OPEN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OPEN</h4> +<pre>public static final <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a> OPEN</pre> +<div class="block">exclusive</div> +</li> +</ul> +<a name="CLOSED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CLOSED</h4> +<pre>public static final <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a> CLOSED</pre> +<div class="block">inclusive</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (Range.BoundType c : Range.BoundType.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/Range.BoundType.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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Ranges.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Range.BoundType.html" target="_top">Frames</a></li> +<li><a href="Range.BoundType.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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 © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/dbd20469/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Range.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Range.html b/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Range.html new file mode 100644 index 0000000..6ecd5fd --- /dev/null +++ b/site/javadoc/r1.1.0/org/apache/edgent/analytics/sensors/Range.html @@ -0,0 +1,696 @@ +<!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 Sun Feb 26 17:08:09 EST 2017 --> +<title>Range (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> +<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="Range (Edgent v1.1.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Range.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/analytics/sensors/Filters.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Range.html" target="_top">Frames</a></li> +<li><a href="Range.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.edgent.analytics.sensors</div> +<h2 title="Class Range" class="title">Class Range<T extends java.lang.Comparable<?>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.analytics.sensors.Range<T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - a <code>Comparable</code> value type</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><T></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">Range<T extends java.lang.Comparable<?>></span> +extends java.lang.Object +implements <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><T>, java.io.Serializable</pre> +<div class="block">A generic immutable range of values and a way to + check a value for containment in the range. + <p> + Useful in filtering in predicates. + <p> + A Range consists of a lower and upper endpoint and a <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><code>Range.BoundType</code></a> + for each endpoint. + <p> + <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html#CLOSED"><code>Range.BoundType.CLOSED</code></a> includes the endpoint's value in the range and + is represented as "[" or "]" in the string form for a lower and upper bound + type respectively. + <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html#OPEN"><code>Range.BoundType.OPEN</code></a> excludes the endpoint's value in the range and + is represented as "(" or ")" in the string form for a lower and upper bound + type respectively. e.g. <code>"[2..5)"</code> + <p> + Typically, the convenience methods in <a href="../../../../../org/apache/edgent/analytics/sensors/Ranges.html" title="class in org.apache.edgent.analytics.sensors"><code>Ranges</code></a> are used to + construct a Range. + <p> + <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#contains-T-"><code>contains()</code></a> is used to check for containment: + e.g. + <pre><code> + Ranges.closed(2,4).contains(2); // returns true + Ranges.open(2,4).contains(2); // returns false + Ranges.atLeast(2).contains(2); // returns true + Ranges.greaterThan(2).contains(2); // returns false + Ranges.atMost(2).contains(2); // returns true + Ranges.lessThan(2).contains(2); // returns false + </code></pre> + + <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#toString--"><code>toString()</code></a> yields a convenient string representation and a + Range may be created from the string representation. + <pre><code> + String s = Ranges.closed(2,4).toString(); // yields "[2..4]" + Range<Integer> range = Ranges.valueOfInteger(s); // yields a Range<Integer>(2,4) + </code></pre> + <p> + Range works with Gson (<code>new Gson().toJson(Range<T>)</code>. + As as documented by Gson, for generic types you must use + <code>Gson.fromJson(String, java.lang.reflect.Type)</code> to + create a Range from its json. + <p> + Sample use in a TStream context: + <pre><code> + TStream<JsonObject> jStream = ...; + TStream<JsonObject> filtered = Filters.deadband(jStream, + json -> json.getProperty("pressureReading").asInteger(), + Ranges.closed(10, 30)); + </code></pre></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.edgent.analytics.sensors.Range">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a></span></code> +<div class="block">Exclude or include an endpoint value in the range.</div> +</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#contains-T-">contains</a></span>(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> v)</code> +<div class="block">Determine if the Region contains the value.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#contains-T-java.util.Comparator-">contains</a></span>(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> v, + java.util.Comparator<<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>> cmp)</code> +<div class="block">Determine if the Region contains the value.</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/analytics/sensors/Range.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code> +<div class="block">Returns true if o is a Range having equal endpoints and bound types to this Range.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#hasLowerEndpoint--">hasLowerEndpoint</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#hasUpperEndpoint--">hasUpperEndpoint</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#lowerBoundType--">lowerBoundType</a></span>()</code> +<div class="block">Get the BoundType for the lowerEndpoint.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#lowerEndpoint--">lowerEndpoint</a></span>()</code> +<div class="block">Get the range's lower endpoint.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static <T extends java.lang.Comparable<?>><br><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#range-T-org.apache.edgent.analytics.sensors.Range.BoundType-T-org.apache.edgent.analytics.sensors.Range.BoundType-">range</a></span>(T lowerEndpoint, + <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a> lbt, + T upperEndpoint, + <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a> ubt)</code> +<div class="block">Create a new Range<T></div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#test-T-">test</a></span>(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> value)</code> +<div class="block">Predicate.test() implementation.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#toString--">toString</a></span>()</code> +<div class="block">Yields <code>"<lowerBoundType><lowerEndpoint>..<upperEndpoint><upperBoundType>"</code>.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#toStringUnsigned--">toStringUnsigned</a></span>()</code> +<div class="block">Return a String treating the endpoints as an unsigned value.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#upperBoundType--">upperBoundType</a></span>()</code> +<div class="block">Get the BoundType for the upperEndpoint.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#upperEndpoint--">upperEndpoint</a></span>()</code> +<div class="block">Get the range's upper endpoint.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>static <T extends java.lang.Comparable<?>><br><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#valueOf-java.lang.String-org.apache.edgent.function.Function-">valueOf</a></span>(java.lang.String toStringValue, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><java.lang.String,T> fromString)</code> +<div class="block">Create a Range from a String produced by toString().</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 java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="range-java.lang.Comparable-org.apache.edgent.analytics.sensors.Range.BoundType-java.lang.Comparable-org.apache.edgent.analytics.sensors.Range.BoundType-"> +<!-- --> +</a><a name="range-T-org.apache.edgent.analytics.sensors.Range.BoundType-T-org.apache.edgent.analytics.sensors.Range.BoundType-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>range</h4> +<pre>public static <T extends java.lang.Comparable<?>> <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a><T> range(T lowerEndpoint, + <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a> lbt, + T upperEndpoint, + <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a> ubt)</pre> +<div class="block">Create a new Range<T> + <p> + See <a href="../../../../../org/apache/edgent/analytics/sensors/Ranges.html" title="class in org.apache.edgent.analytics.sensors"><code>Ranges</code></a> for a collection of convenience constructors.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - a Comparable type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>lowerEndpoint</code> - null for an infinite value (and lbt must be OPEN)</dd> +<dd><code>lbt</code> - <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><code>Range.BoundType</code></a> for the lowerEndpoint</dd> +<dd><code>upperEndpoint</code> - null for an infinite value (and ubt must be OPEN)</dd> +<dd><code>ubt</code> - <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><code>Range.BoundType</code></a> for the upperEndpoint</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Range</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object o)</pre> +<div class="block">Returns true if o is a Range having equal endpoints and bound types to this Range.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hasLowerEndpoint--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasLowerEndpoint</h4> +<pre>public boolean hasLowerEndpoint()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true iff the Range's lower endpoint isn't unbounded/infinite</dd> +</dl> +</li> +</ul> +<a name="lowerEndpoint--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lowerEndpoint</h4> +<pre>public <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> lowerEndpoint()</pre> +<div class="block">Get the range's lower endpoint.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the endpoint</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if hasLowerEndpoint()==false</dd> +</dl> +</li> +</ul> +<a name="hasUpperEndpoint--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasUpperEndpoint</h4> +<pre>public boolean hasUpperEndpoint()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true iff the Range's upper endpoint isn't unbounded/infinite</dd> +</dl> +</li> +</ul> +<a name="upperEndpoint--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>upperEndpoint</h4> +<pre>public <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> upperEndpoint()</pre> +<div class="block">Get the range's upper endpoint.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the endpoint</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if hasUpperEndpoint()==false</dd> +</dl> +</li> +</ul> +<a name="lowerBoundType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lowerBoundType</h4> +<pre>public <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a> lowerBoundType()</pre> +<div class="block">Get the BoundType for the lowerEndpoint.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the BoundType</dd> +</dl> +</li> +</ul> +<a name="upperBoundType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>upperBoundType</h4> +<pre>public <a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors">Range.BoundType</a> upperBoundType()</pre> +<div class="block">Get the BoundType for the upperEndpoint.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the BoundType</dd> +</dl> +</li> +</ul> +<a name="contains-java.lang.Comparable-java.util.Comparator-"> +<!-- --> +</a><a name="contains-T-java.util.Comparator-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> v, + java.util.Comparator<<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a>> cmp)</pre> +<div class="block">Determine if the Region contains the value. + <p> + <code>contains(v)</code> typically suffices. This + can be used in cases where it isn't sufficient. + E.g., for unsigned byte comparisons + <pre> + Comparator<Byte> unsignedByteComparator = new Comparator<Byte>() { + public int compare(Byte b1, Byte b2) { + return Integer.compareUnsigned(Byte.toUnsignedInt(b1), Byte.toUnsignedInt(b2)); + } + public boolean equals(Object o2) { return o2==this; } + }; + Range<Byte> unsignedByteRange = Ranges.valueOfByte("[0..255]"); + unsignedByteRange.contains(byteValue, unsignedByteComparator); + </pre></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>v</code> - the value to check for containment</dd> +<dd><code>cmp</code> - the Comparator to use</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the Region contains the value</dd> +</dl> +</li> +</ul> +<a name="contains-java.lang.Comparable-"> +<!-- --> +</a><a name="contains-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> v)</pre> +<div class="block">Determine if the Region contains the value. + <p> + The Comparable's compareTo() is used for the comparisons. + <p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>v</code> - the value to check for containment</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the Region contains the value</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#contains-T-java.util.Comparator-"><code>contains(Comparable, Comparator)</code></a></dd> +</dl> +</li> +</ul> +<a name="test-java.lang.Comparable-"> +<!-- --> +</a><a name="test-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>test</h4> +<pre>public boolean test(<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> value)</pre> +<div class="block">Predicate.test() implementation. Identical to contains(value).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/edgent/function/Predicate.html#test-T-">test</a></code> in interface <code><a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><<a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="type parameter in Range">T</a> extends java.lang.Comparable<?>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - Value to be tested.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>True if this predicate is true for <code>value</code> otherwise false.</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-org.apache.edgent.function.Function-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <T extends java.lang.Comparable<?>> <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html" title="class in org.apache.edgent.analytics.sensors">Range</a><T> valueOf(java.lang.String toStringValue, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><java.lang.String,T> fromString)</pre> +<div class="block">Create a Range from a String produced by toString(). + <p> + See <a href="../../../../../org/apache/edgent/analytics/sensors/Ranges.html" title="class in org.apache.edgent.analytics.sensors"><code>Ranges</code></a> for a collection of valueOf methods + for several types of <code>T</code>.</div> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - a Comparable type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>toStringValue</code> - value from toString() or has the same syntax.</dd> +<dd><code>fromString</code> - function to create a T from its String value from + the parsed toStringValue. Should throw an IllegalArgumentException + if unable to perform the conversion.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Range</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if unable to parse or convert to + endpoint in toStringValue to a T.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Yields <code>"<lowerBoundType><lowerEndpoint>..<upperEndpoint><upperBoundType>"</code>. + <p> + lowerBoundType is either "[" or "(" for BoundType.CLOSED or OPEN respectively. + upperBoundType is either "]" or ")" for BoundType.CLOSED or OPEN respectively. + <p> + The endpoint value "*" is used to indicate an infinite value. + Otherwise, endpoint.toString() is used to get the endpoint's value. + <p> + Likely yields an undesirable result when wanting to treat + a Byte, Short, Integer, or Long T in an unsigned fashion. + See toStringUnsigned(). + <p> + No special processing is performed to escape/encode a "." present + in an endpoint.toString() value. Hence Range<T>.toString() for + a <code>T</code> of <code>String</code> (of value "." or with embedded ".."), + or some other non-numeric type may yield values that are not amenable + to parsing by <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#valueOf-java.lang.String-org.apache.edgent.function.Function-"><code>valueOf(String, Function)</code></a>. + <br> + .e.g., + <pre> + "[120..156)" // lowerEndpoint=120 inclusive, upperEndpoint=156 exclusive + "[120..*)" // an "atLeast" 120 range + </pre></div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toStringUnsigned--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toStringUnsigned</h4> +<pre>public java.lang.String toStringUnsigned()</pre> +<div class="block">Return a String treating the endpoints as an unsigned value.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>String with same form as <a href="../../../../../org/apache/edgent/analytics/sensors/Range.html#toString--"><code>toString()</code></a></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if the Range is not one of + Byte, Short, Integer, Long</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/Range.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 class="aboutLanguage"><a href="http://edgent.incubator.apache.org";>Apache Edgent (incubating)</a></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Filters.html" title="class in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/edgent/analytics/sensors/Range.BoundType.html" title="enum in org.apache.edgent.analytics.sensors"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/analytics/sensors/Range.html" target="_top">Frames</a></li> +<li><a href="Range.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> +</body> +</html>
