| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_112) on Mon Dec 18 11:25:19 EST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Graph (Apache Edgent (incubating) v1.2.0 API)</title> |
| <meta name="date" content="2017-12-18"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Graph (Apache Edgent (incubating) v1.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Graph.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/graph/Edge.html" title="interface in org.apache.edgent.graph"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/edgent/graph/Graph.html" target="_top">Frames</a></li> |
| <li><a href="Graph.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.graph</div> |
| <h2 title="Interface Graph" class="title">Interface Graph</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/edgent/graph/spi/AbstractGraph.html" title="class in org.apache.edgent.graph.spi">AbstractGraph</a>, <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 interface <span class="typeNameLabel">Graph</span></pre> |
| <div class="block">A generic directed graph of vertices, connectors and edges. |
| <p> |
| The graph consists of <a href="../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph"><code>Vertex</code></a> objects, each having |
| 0 or more input and/or output <a href="../../../../org/apache/edgent/graph/Connector.html" title="interface in org.apache.edgent.graph"><code>Connector</code></a> objects. |
| <a href="../../../../org/apache/edgent/graph/Edge.html" title="interface in org.apache.edgent.graph"><code>Edge</code></a> objects connect an output connector to |
| an input connector. |
| <p> |
| A vertex has an associated <a href="../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet"><code>Oplet</code></a> instance that will be executed |
| at runtime.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/edgent/graph/Edge.html" title="interface in org.apache.edgent.graph">Edge</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/graph/Graph.html#getEdges--">getEdges</a></span>()</code> |
| <div class="block">Return an unmodifiable view of all edges in this graph.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph">Vertex</a><? extends <a href="../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet">Oplet</a><?,?>,?,?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/graph/Graph.html#getVertices--">getVertices</a></span>()</code> |
| <div class="block">Return an unmodifiable view of all vertices in this graph.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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/Vertex.html" title="interface in org.apache.edgent.graph">Vertex</a><N,C,P></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/graph/Graph.html#insert-N-int-int-">insert</a></span>(N oplet, |
| int inputs, |
| int outputs)</code> |
| <div class="block">Add a new unconnected <code>Vertex</code> into the graph.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/graph/Graph.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="i4" class="altColor"> |
| <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/Graph.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="i5" class="rowColor"> |
| <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/Graph.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> |
| </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="insert-org.apache.edgent.oplet.Oplet-int-int-"> |
| <!-- --> |
| </a><a name="insert-N-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insert</h4> |
| <pre><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/Vertex.html" title="interface in org.apache.edgent.graph">Vertex</a><N,C,P> insert(N oplet, |
| int inputs, |
| int outputs)</pre> |
| <div class="block">Add a new unconnected <code>Vertex</code> into the graph. |
| <p></div> |
| <dl> |
| <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>oplet</code> - the oplet to associate with the new vertex</dd> |
| <dd><code>inputs</code> - the number of input connectors for the new vertex</dd> |
| <dd><code>outputs</code> - the number of output connectors for the new vertex</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <code>Vertex</code> for the oplet</dd> |
| </dl> |
| </li> |
| </ul> |
| <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><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">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="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><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">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="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="blockList"> |
| <li class="blockList"> |
| <h4>peekAll</h4> |
| <pre>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">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="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> |
| <a name="getVertices--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVertices</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph">Vertex</a><? extends <a href="../../../../org/apache/edgent/oplet/Oplet.html" title="interface in org.apache.edgent.oplet">Oplet</a><?,?>,?,?>> getVertices()</pre> |
| <div class="block">Return an unmodifiable view of all vertices in this graph.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>unmodifiable view of all vertices in this graph</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEdges--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEdges</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/edgent/graph/Edge.html" title="interface in org.apache.edgent.graph">Edge</a>> getEdges()</pre> |
| <div class="block">Return an unmodifiable view of all edges in this graph.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the collection</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/Graph.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/graph/Edge.html" title="interface in org.apache.edgent.graph"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/edgent/graph/Vertex.html" title="interface in org.apache.edgent.graph"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/edgent/graph/Graph.html" target="_top">Frames</a></li> |
| <li><a href="Graph.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 © 2016–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |