| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>DirectedGraph (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <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.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.util.graph</a></div> |
| <h1 title="Interface DirectedGraph" class="title">Interface DirectedGraph<V,<wbr>E></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>V</code> - Vertex type</dd> |
| <dd><code>E</code> - Edge type</dd> |
| </dl> |
| <dl class="notes"> |
| <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> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">DirectedGraph<V,<wbr>E></span></div> |
| <div class="block">Directed graph.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="DirectedGraph.EdgeFactory.html" class="type-name-link" title="interface in org.apache.calcite.util.graph">DirectedGraph.EdgeFactory</a><<a href="DirectedGraph.EdgeFactory.html" title="type parameter in DirectedGraph.EdgeFactory">V</a>,<wbr><a href="DirectedGraph.EdgeFactory.html" title="type parameter in DirectedGraph.EdgeFactory">E</a>></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Factory for edges.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addEdge(V,V)" class="member-name-link">addEdge</a><wbr>(<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></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds an edge to this graph.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addVertex(V)" class="member-name-link">addVertex</a><wbr>(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds a vertex to this graph.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#edgeSet()" class="member-name-link">edgeSet</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEdge(V,V)" class="member-name-link">getEdge</a><wbr>(<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></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getInwardEdges(V)" class="member-name-link">getInwardEdges</a><wbr>(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOutwardEdges(V)" class="member-name-link">getOutwardEdges</a><wbr>(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeAllVertices(java.util.Collection)" class="member-name-link">removeAllVertices</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a>> collection)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#removeEdge(V,V)" class="member-name-link">removeEdge</a><wbr>(<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></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><? extends <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#vertexSet()" class="member-name-link">vertexSet</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="addVertex(V)"> |
| <h3 id="addVertex(java.lang.Object)">addVertex</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">addVertex</span><wbr><span class="parameters">(<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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>vertex</code> - Vertex</dd> |
| <dt>Returns:</dt> |
| <dd>Whether vertex was added</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addEdge(V,V)"> |
| <h3 id="addEdge(java.lang.Object,java.lang.Object)">addEdge</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a></span> <span class="element-name">addEdge</span><wbr><span class="parameters">(<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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>vertex</code> - Source vertex</dd> |
| <dd><code>targetVertex</code> - Target vertex</dd> |
| <dt>Returns:</dt> |
| <dd>New edge, if added, otherwise null</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if either vertex is not already in graph</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEdge(V,V)"> |
| <h3 id="getEdge(java.lang.Object,java.lang.Object)">getEdge</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a></span> <span class="element-name">getEdge</span><wbr><span class="parameters">(<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> |
| <section class="detail" id="removeEdge(V,V)"> |
| <h3 id="removeEdge(java.lang.Object,java.lang.Object)">removeEdge</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">removeEdge</span><wbr><span class="parameters">(<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> |
| <section class="detail" id="vertexSet()"> |
| <h3>vertexSet</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><? extends <a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a>></span> <span class="element-name">vertexSet</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeAllVertices(java.util.Collection)"> |
| <h3>removeAllVertices</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">removeAllVertices</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">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> |
| <section class="detail" id="getOutwardEdges(V)"> |
| <h3 id="getOutwardEdges(java.lang.Object)">getOutwardEdges</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></span> <span class="element-name">getOutwardEdges</span><wbr><span class="parameters">(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> source)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInwardEdges(V)"> |
| <h3 id="getInwardEdges(java.lang.Object)">getInwardEdges</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></span> <span class="element-name">getInwardEdges</span><wbr><span class="parameters">(<a href="DirectedGraph.html" title="type parameter in DirectedGraph">V</a> vertex)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="edgeSet()"> |
| <h3>edgeSet</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="DirectedGraph.html" title="type parameter in DirectedGraph">E</a>></span> <span class="element-name">edgeSet</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
