| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DirectedGraph (Apache Calcite calcite API)</title> |
| <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="DirectedGraph (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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="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"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/util/graph/DepthFirstIterator.html" title="class in org.apache.calcite.util.graph"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.EdgeFactory.html" title="interface in org.apache.calcite.util.graph"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/util/graph/DirectedGraph.html" target="_top">Frames</a></li> |
| <li><a href="DirectedGraph.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.calcite.util.graph</div> |
| <h2 title="Interface DirectedGraph" class="title">Interface DirectedGraph<V,E></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>V</code> - Vertex type</dd> |
| <dd><code>E</code> - Edge type</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/calcite/util/graph/AttributedDirectedGraph.html" title="class in org.apache.calcite.util.graph">AttributedDirectedGraph</a>, <a href="../../../../../org/apache/calcite/util/graph/DefaultDirectedGraph.html" title="class in org.apache.calcite.util.graph">DefaultDirectedGraph</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">DirectedGraph<V,E></span></pre> |
| <div class="block">Directed graph.</div> |
| </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">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.EdgeFactory.html" title="interface in org.apache.calcite.util.graph">DirectedGraph.EdgeFactory</a><<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.EdgeFactory.html" title="type parameter in DirectedGraph.EdgeFactory">V</a>,<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.EdgeFactory.html" title="type parameter in DirectedGraph.EdgeFactory">E</a>></span></code> |
| <div class="block">Factory for edges.</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="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="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html#addEdge-V-V-">addEdge</a></span>(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex, |
| <a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> targetVertex)</code> |
| <div class="block">Adds an edge to this graph.</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/calcite/util/graph/DirectedGraph.html#addVertex-V-">addVertex</a></span>(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</code> |
| <div class="block">Adds a vertex to this graph.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html#edgeSet--">edgeSet</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html#getEdge-V-V-">getEdge</a></span>(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source, |
| <a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> target)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html#getInwardEdges-V-">getInwardEdges</a></span>(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html#getOutwardEdges-V-">getOutwardEdges</a></span>(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html#removeAllVertices-java.util.Collection-">removeAllVertices</a></span>(<a href="https://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/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a>> collection)</code> |
| <div class="block">Removes from this graph all vertices that are in <code>collection</code>, |
| and the edges into and out of those vertices.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html#removeEdge-V-V-">removeEdge</a></span>(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex, |
| <a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> targetVertex)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html#vertexSet--">vertexSet</a></span>()</code> </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="addVertex-java.lang.Object-"> |
| <!-- --> |
| </a><a name="addVertex-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addVertex</h4> |
| <pre>boolean addVertex(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</pre> |
| <div class="block">Adds a vertex to this graph.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vertex</code> - Vertex</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether vertex was added</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addEdge-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="addEdge-V-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEdge</h4> |
| <pre><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a> addEdge(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex, |
| <a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> targetVertex)</pre> |
| <div class="block">Adds an edge to this graph.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vertex</code> - Source vertex</dd> |
| <dd><code>targetVertex</code> - Target vertex</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>New edge, if added, otherwise null</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if either vertex is not already in graph</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEdge-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="getEdge-V-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEdge</h4> |
| <pre><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a> getEdge(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source, |
| <a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> target)</pre> |
| </li> |
| </ul> |
| <a name="removeEdge-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="removeEdge-V-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeEdge</h4> |
| <pre>boolean removeEdge(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex, |
| <a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> targetVertex)</pre> |
| </li> |
| </ul> |
| <a name="vertexSet--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>vertexSet</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a>> vertexSet()</pre> |
| </li> |
| </ul> |
| <a name="removeAllVertices-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAllVertices</h4> |
| <pre>void removeAllVertices(<a href="https://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/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a>> collection)</pre> |
| <div class="block">Removes from this graph all vertices that are in <code>collection</code>, |
| and the edges into and out of those vertices.</div> |
| </li> |
| </ul> |
| <a name="getOutwardEdges-java.lang.Object-"> |
| <!-- --> |
| </a><a name="getOutwardEdges-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutwardEdges</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a>> getOutwardEdges(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source)</pre> |
| </li> |
| </ul> |
| <a name="getInwardEdges-java.lang.Object-"> |
| <!-- --> |
| </a><a name="getInwardEdges-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInwardEdges</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a>> getInwardEdges(<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</pre> |
| </li> |
| </ul> |
| <a name="edgeSet--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>edgeSet</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.html" title="type parameter in DirectedGraph">E</a>> edgeSet()</pre> |
| </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="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"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/util/graph/DepthFirstIterator.html" title="class in org.apache.calcite.util.graph"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/util/graph/DirectedGraph.EdgeFactory.html" title="interface in org.apache.calcite.util.graph"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/util/graph/DirectedGraph.html" target="_top">Frames</a></li> |
| <li><a href="DirectedGraph.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 © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |