| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>DirectedGraph (Apache Calcite calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.util.graph, interface: DirectedGraph"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"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"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.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"> |
| <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> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.util.graph</a></div> |
| <h1 title="Interface DirectedGraph" class="title">Interface DirectedGraph<V,​E></h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <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><code><a href="AttributedDirectedGraph.html" title="class in org.apache.calcite.util.graph">AttributedDirectedGraph</a></code>, <code><a href="DefaultDirectedGraph.html" title="class in org.apache.calcite.util.graph">DefaultDirectedGraph</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">DirectedGraph<V,​E></span></pre> |
| <div class="block">Directed graph.</div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="nestedClassSummary"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h2>Nested Class Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="DirectedGraph.EdgeFactory.html" title="interface in org.apache.calcite.util.graph">DirectedGraph.EdgeFactory</a><<a href="DirectedGraph.EdgeFactory.html" title="type parameter in DirectedGraph.EdgeFactory">V</a>,​<a href="DirectedGraph.EdgeFactory.html" title="type parameter in DirectedGraph.EdgeFactory">E</a>></span></code></th> |
| <td class="colLast"> |
| <div class="block">Factory for edges.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>@Nullable <a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addEdge(V,V)">addEdge</a></span>​(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex, |
| <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> targetVertex)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds an edge to this graph.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addVertex(V)">addVertex</a></span>​(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a vertex to this graph.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#edgeSet()">edgeSet</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>@Nullable <a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEdge(V,V)">getEdge</a></span>​(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source, |
| <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> target)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInwardEdges(V)">getInwardEdges</a></span>​(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutwardEdges(V)">getOutwardEdges</a></span>​(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAllVertices(java.util.Collection)">removeAllVertices</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a>> collection)</code></th> |
| <td class="colLast"> |
| <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 class="rowColor" id="i7"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeEdge(V,V)">removeEdge</a></span>​(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex, |
| <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> targetVertex)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><? extends <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#vertexSet()">vertexSet</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addVertex(java.lang.Object)"> |
| <!-- --> |
| </a><a id="addVertex(V)">addVertex</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">addVertex</span>​(<span class="arguments"><a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addEdge(java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a id="addEdge(V,V)">addEdge</a></h3> |
| <div class="memberSignature"><span class="returnType">@Nullable <a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a></span> <span class="memberName">addEdge</span>​(<span class="arguments"><a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex, |
| <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> targetVertex)</span></div> |
| <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/9/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if either vertex is not already in graph</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getEdge(java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a id="getEdge(V,V)">getEdge</a></h3> |
| <div class="memberSignature"><span class="returnType">@Nullable <a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a></span> <span class="memberName">getEdge</span>​(<span class="arguments"><a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source, |
| <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> target)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeEdge(java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a id="removeEdge(V,V)">removeEdge</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">removeEdge</span>​(<span class="arguments"><a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex, |
| <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> targetVertex)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="vertexSet()">vertexSet</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><? extends <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a>></span> <span class="memberName">vertexSet</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeAllVertices(java.util.Collection)">removeAllVertices</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">removeAllVertices</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a>> collection)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOutwardEdges(java.lang.Object)"> |
| <!-- --> |
| </a><a id="getOutwardEdges(V)">getOutwardEdges</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></span> <span class="memberName">getOutwardEdges</span>​(<span class="arguments"><a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getInwardEdges(java.lang.Object)"> |
| <!-- --> |
| </a><a id="getInwardEdges(V)">getInwardEdges</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></span> <span class="memberName">getInwardEdges</span>​(<span class="arguments"><a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="edgeSet()">edgeSet</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></span> <span class="memberName">edgeSet</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.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"> |
| <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> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |