Repository: incubator-edgent-website Updated Branches: refs/heads/master 8dfb358ab -> 85b6530db
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/85b6530d/site/javadoc/r0.4.0/org/apache/edgent/graph/spi/AbstractGraph.html ---------------------------------------------------------------------- diff --git a/site/javadoc/r0.4.0/org/apache/edgent/graph/spi/AbstractGraph.html b/site/javadoc/r0.4.0/org/apache/edgent/graph/spi/AbstractGraph.html new file mode 100644 index 0000000..79771b1 --- /dev/null +++ b/site/javadoc/r0.4.0/org/apache/edgent/graph/spi/AbstractGraph.html @@ -0,0 +1,388 @@ +<!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_92) on Tue Jul 26 12:40:38 PDT 2016 --> +<title>AbstractGraph (Edgent v0.4.0)</title> +<meta name="date" content="2016-07-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="AbstractGraph (Edgent v0.4.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/AbstractGraph.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/graph/spi/AbstractVertex.html" title="class in org.apache.edgent.graph.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/graph/spi/AbstractGraph.html" target="_top">Frames</a></li> +<li><a href="AbstractGraph.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.graph.spi</div> +<h2 title="Class AbstractGraph" class="title">Class AbstractGraph<G></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.edgent.graph.spi.AbstractGraph<G></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>G</code> - unnecessary?</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/edgent/runtime/etiao/graph/DirectGraph.html" title="class in org.apache.edgent.runtime.etiao.graph">DirectGraph</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">AbstractGraph<G></span> +extends java.lang.Object +implements <a href="../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a></pre> +<div class="block">A skeletal implementation of the <a href="../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph"><code>Graph</code></a> interface, + to minimize the effort required to implement the interface.</div> +</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/graph/spi/AbstractGraph.html#AbstractGraph--">AbstractGraph</a></span>()</code> </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/graph/spi/AbstractGraph.html#peekAll-org.apache.edgent.function.Supplier-org.apache.edgent.function.Predicate-">peekAll</a></span>(<a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><? extends <a href="../../../../../org/apache/edgent/oplet/core/Peek.html" title="class in org.apache.edgent.oplet.core">Peek</a><?>> supplier, + <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><<a href="../../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph">Vertex</a><?,?,?>> select)</code> +<div class="block">Insert Peek oplets returned by the specified <code>Supplier</code> into + the outputs of all of the oplets which satisfy the specified + <code>Predicate</code> and where the output's <a href="../../../../../org/apache/edgent/graph/Connector.html#isConnected--"><code>Connector.isConnected()</code></a> + is true.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><N extends <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet">Oplet</a><C,P>,C,P><br><a href="../../../../../org/apache/edgent/graph/Connector.html" title="interface in org.apache.edgent.graph">Connector</a><P></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/graph/spi/AbstractGraph.html#pipe-org.apache.edgent.graph.Connector-N-">pipe</a></span>(<a href="../../../../../org/apache/edgent/graph/Connector.html" title="interface in org.apache.edgent.graph">Connector</a><C> output, + N oplet)</code> +<div class="block">Create a new connected <a href="../../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph"><code>Vertex</code></a> associated with the + specified <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet"><code>Oplet</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><N extends <a href="../../../../../org/apache/edgent/oplet/core/Source.html" title="class in org.apache.edgent.oplet.core">Source</a><P>,P><br><a href="../../../../../org/apache/edgent/graph/Connector.html" title="interface in org.apache.edgent.graph">Connector</a><P></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/graph/spi/AbstractGraph.html#source-N-">source</a></span>(N oplet)</code> +<div class="block">Create a new unconnected <a href="../../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph"><code>Vertex</code></a> associated with the + specified source <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet"><code>Oplet</code></a>.</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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.graph.Graph"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.edgent.graph.<a href="../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a></h3> +<code><a href="../../../../../org/apache/edgent/graph/Graph.html#getEdges--">getEdges</a>, <a href="../../../../../org/apache/edgent/graph/Graph.html#getVertices--">getVertices</a>, <a href="../../../../../org/apache/edgent/graph/Graph.html#insert-N-int-int-">insert</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="AbstractGraph--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractGraph</h4> +<pre>public AbstractGraph()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="source-org.apache.edgent.oplet.core.Source-"> +<!-- --> +</a><a name="source-N-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>source</h4> +<pre>public <N extends <a href="../../../../../org/apache/edgent/oplet/core/Source.html" title="class in org.apache.edgent.oplet.core">Source</a><P>,P> <a href="../../../../../org/apache/edgent/graph/Connector.html" title="interface in org.apache.edgent.graph">Connector</a><P> source(N oplet)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/edgent/graph/Graph.html#source-N-">Graph</a></code></span></div> +<div class="block">Create a new unconnected <a href="../../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph"><code>Vertex</code></a> associated with the + specified source <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet"><code>Oplet</code></a>. + <p> + The <code>Vertex</code> for the oplet has 0 input connectors and one output connector.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/edgent/graph/Graph.html#source-N-">source</a></code> in interface <code><a href="../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a></code></dd> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>N</code> - a Source type</dd> +<dd><code>P</code> - tuple type</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>oplet</code> - the source oplet</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the output connector for the newly created vertex.</dd> +</dl> +</li> +</ul> +<a name="pipe-org.apache.edgent.graph.Connector-org.apache.edgent.oplet.Oplet-"> +<!-- --> +</a><a name="pipe-org.apache.edgent.graph.Connector-N-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>pipe</h4> +<pre>public <N extends <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet">Oplet</a><C,P>,C,P> <a href="../../../../../org/apache/edgent/graph/Connector.html" title="interface in org.apache.edgent.graph">Connector</a><P> pipe(<a href="../../../../../org/apache/edgent/graph/Connector.html" title="interface in org.apache.edgent.graph">Connector</a><C> output, + N oplet)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/edgent/graph/Graph.html#pipe-org.apache.edgent.graph.Connector-N-">Graph</a></code></span></div> +<div class="block">Create a new connected <a href="../../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph"><code>Vertex</code></a> associated with the + specified <a href="../../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet"><code>Oplet</code></a>. + <p> + The new <code>Vertex</code> has one input and one output <code>Connector</code>. + An <a href="../../../../../org/apache/edgent/graph/Edge.html" title="interface in org.apache.edgent.graph"><code>Edge</code></a> is created connecting the specified output connector to + the new vertice's input connector.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/edgent/graph/Graph.html#pipe-org.apache.edgent.graph.Connector-N-">pipe</a></code> in interface <code><a href="../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a></code></dd> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>N</code> - an Oplet type</dd> +<dd><code>C</code> - tuple type of input streams</dd> +<dd><code>P</code> - tuple type of output streams</dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>output</code> - the output connector to connect to the vertice's input connector</dd> +<dd><code>oplet</code> - the oplet to associate with the new <code>Vertex</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the output connector for the new <code>Vertex</code></dd> +</dl> +</li> +</ul> +<a name="peekAll-org.apache.edgent.function.Supplier-org.apache.edgent.function.Predicate-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>peekAll</h4> +<pre>public void peekAll(<a href="../../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><? extends <a href="../../../../../org/apache/edgent/oplet/core/Peek.html" title="class in org.apache.edgent.oplet.core">Peek</a><?>> supplier, + <a href="../../../../../org/apache/edgent/function/Predicate.html" title="interface in org.apache.edgent.function">Predicate</a><<a href="../../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph">Vertex</a><?,?,?>> select)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/edgent/graph/Graph.html#peekAll-org.apache.edgent.function.Supplier-org.apache.edgent.function.Predicate-">Graph</a></code></span></div> +<div class="block">Insert Peek oplets returned by the specified <code>Supplier</code> into + the outputs of all of the oplets which satisfy the specified + <code>Predicate</code> and where the output's <a href="../../../../../org/apache/edgent/graph/Connector.html#isConnected--"><code>Connector.isConnected()</code></a> + is true.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/edgent/graph/Graph.html#peekAll-org.apache.edgent.function.Supplier-org.apache.edgent.function.Predicate-">peekAll</a></code> in interface <code><a href="../../../../../org/apache/edgent/graph/Graph.html" title="interface in org.apache.edgent.graph">Graph</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>supplier</code> - Function which provides a Peek oplet to insert</dd> +<dd><code>select</code> - Vertex selection Predicate</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/AbstractGraph.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/graph/spi/AbstractVertex.html" title="class in org.apache.edgent.graph.spi"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/edgent/graph/spi/AbstractGraph.html" target="_top">Frames</a></li> +<li><a href="AbstractGraph.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 © 2016 The Apache Software Foundation. All Rights Reserved - 54ea8ac-20160726-1240</small></p> +</body> +</html>
