| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelMetadataProvider (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.rel.metadata, interface: RelMetadataProvider"> |
| <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>Nested | </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.rel.metadata</a></div> |
| <h1 title="Interface RelMetadataProvider" class="title">Interface RelMetadataProvider</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="CachingRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">CachingRelMetadataProvider</a></code>, <code><a href="ChainedRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">ChainedRelMetadataProvider</a></code>, <code><a href="DefaultRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">DefaultRelMetadataProvider</a></code>, <code><a href="JaninoRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">JaninoRelMetadataProvider</a></code>, <code><a href="ReflectiveRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">ReflectiveRelMetadataProvider</a></code>, <code><a href="../../plan/volcano/VolcanoRelMetadataProvider.html" title="class in org.apache.calcite.plan.volcano">VolcanoRelMetadataProvider</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RelMetadataProvider</span></div> |
| <div class="block">RelMetadataProvider defines an interface for obtaining metadata about |
| relational expressions. This interface is weakly-typed and is not intended to |
| be called directly in most contexts; instead, use a strongly-typed facade |
| such as <a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata"><code>RelMetadataQuery</code></a>. |
| |
| <p>For background and motivation, see <a href="http://wiki.eigenbase.org/RelationalExpressionMetadata">wiki</a>. |
| |
| <p>If your provider is not a singleton, we recommend that you implement |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link"><code>Object.equals(Object)</code></a> and <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link"><code>Object.hashCode()</code></a> methods. This |
| makes the cache of <a href="JaninoRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata"><code>JaninoRelMetadataProvider</code></a> more effective.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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 method-summary-table-tab6"><code><@Nullable M extends @Nullable <a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>><br>@Nullable <a href="UnboundMetadata.html" title="interface in org.apache.calcite.rel.metadata">UnboundMetadata</a><M></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#apply(java.lang.Class,java.lang.Class)" class="member-name-link">apply</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> relClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends @Nullable M> metadataClass)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata"><code>RelMetadataQuery</code></a>.</div> |
| </div> |
| </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="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a><?>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#handlers(java.lang.Class)" class="member-name-link">handlers</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a><?>> handlerClass)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Retrieves a list of <a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata"><code>MetadataHandler</code></a> for implements a particular |
| <a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata"><code>MetadataHandler</code></a>.class.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><M extends <a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>><br>com.google.common.collect.Multimap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a>,<wbr><a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a><M>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#handlers(org.apache.calcite.rel.metadata.MetadataDef)" class="member-name-link">handlers</a><wbr>(<a href="MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a><M> def)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </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="apply(java.lang.Class,java.lang.Class)"> |
| <h3>apply</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="type-parameters"><@Nullable M extends @Nullable <a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>></span> |
| <span class="return-type">@Nullable <a href="UnboundMetadata.html" title="interface in org.apache.calcite.rel.metadata">UnboundMetadata</a><M></span> <span class="element-name">apply</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> relClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends @Nullable M> metadataClass)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use <a href="RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata"><code>RelMetadataQuery</code></a>.</div> |
| </div> |
| <div class="block">Retrieves metadata of a particular type and for a particular sub-class |
| of relational expression. |
| |
| <p>The object returned is a function. It can be applied to a relational |
| expression of the given type to create a metadata object.</p> |
| |
| <p>For example, you might call</p> |
| |
| <blockquote><pre> |
| RelMetadataProvider provider; |
| LogicalFilter filter; |
| RexNode predicate; |
| Function<RelNode, Metadata> function = |
| provider.apply(LogicalFilter.class, Selectivity.class}; |
| Selectivity selectivity = function.apply(filter); |
| Double d = selectivity.selectivity(predicate); |
| </pre></blockquote></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>relClass</code> - Type of relational expression</dd> |
| <dd><code>metadataClass</code> - Type of metadata</dd> |
| <dt>Returns:</dt> |
| <dd>Function that will field a metadata instance; or null if this |
| provider cannot supply metadata of this type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handlers(org.apache.calcite.rel.metadata.MetadataDef)"> |
| <h3>handlers</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="type-parameters"><M extends <a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>></span> |
| <span class="return-type">com.google.common.collect.Multimap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a>,<wbr><a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a><M>></span> <span class="element-name">handlers</span><wbr><span class="parameters">(<a href="MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a><M> def)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="handlers(java.lang.Class)"> |
| <h3>handlers</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="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a><?>></span> <span class="element-name">handlers</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a><?>> handlerClass)</span></div> |
| <div class="block">Retrieves a list of <a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata"><code>MetadataHandler</code></a> for implements a particular |
| <a href="MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata"><code>MetadataHandler</code></a>.class. The resolution order is specificity of the relNode class, |
| with preference given to handlers that occur earlier in the list. |
| |
| For instance, given a return list of {A, B, C} where A implements RelNode and Scan, |
| B implements Scan, and C implements LogicalScan and Filter. |
| |
| Scan dispatches to a.method(Scan) |
| LogicalFilter dispatches to c.method(Filter). |
| LogicalScan dispatches to c.method(LogicalScan). |
| Aggregate dispatches to a.method(RelNode). |
| |
| The behavior is undefined if the class hierarchy for dispatching is not a tree.</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> |
