| <!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>RelMetadataProvider (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="RelMetadataProvider (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":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/rel/metadata/RelMdUtil.html" title="class in org.apache.calcite.rel.metadata"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/rel/metadata/RelMetadataProvider.html" target="_top">Frames</a></li> |
| <li><a href="RelMetadataProvider.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.calcite.rel.metadata</div> |
| <h2 title="Interface RelMetadataProvider" class="title">Interface RelMetadataProvider</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/calcite/rel/metadata/CachingRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">CachingRelMetadataProvider</a>, <a href="../../../../../org/apache/calcite/rel/metadata/ChainedRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">ChainedRelMetadataProvider</a>, <a href="../../../../../org/apache/calcite/rel/metadata/DefaultRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">DefaultRelMetadataProvider</a>, <a href="../../../../../org/apache/calcite/rel/metadata/JaninoRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">JaninoRelMetadataProvider</a>, <a href="../../../../../org/apache/calcite/rel/metadata/ReflectiveRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata">ReflectiveRelMetadataProvider</a>, <a href="../../../../../org/apache/calcite/plan/volcano/VolcanoRelMetadataProvider.html" title="class in org.apache.calcite.plan.volcano">VolcanoRelMetadataProvider</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RelMetadataProvider</span></pre> |
| <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="../../../../../org/apache/calcite/rel/metadata/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/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang"><code>Object.equals(Object)</code></a> and <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang"><code>Object.hashCode()</code></a> methods. This |
| makes the cache of <a href="../../../../../org/apache/calcite/rel/metadata/JaninoRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata"><code>JaninoRelMetadataProvider</code></a> more effective.</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><M extends <a href="../../../../../org/apache/calcite/rel/metadata/Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>><br><a href="../../../../../org/apache/calcite/rel/metadata/UnboundMetadata.html" title="interface in org.apache.calcite.rel.metadata">UnboundMetadata</a><M></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html#apply-java.lang.Class-java.lang.Class-">apply</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> relClass, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends M> metadataClass)</code> |
| <div class="block">Retrieves metadata of a particular type and for a particular sub-class |
| of relational expression.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><M extends <a href="../../../../../org/apache/calcite/rel/metadata/Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>><br>com.google.common.collect.Multimap<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a>,<a href="../../../../../org/apache/calcite/rel/metadata/MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a><M>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html#handlers-org.apache.calcite.rel.metadata.MetadataDef-">handlers</a></span>(<a href="../../../../../org/apache/calcite/rel/metadata/MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a><M> def)</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="apply-java.lang.Class-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre><M extends <a href="../../../../../org/apache/calcite/rel/metadata/Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>> <a href="../../../../../org/apache/calcite/rel/metadata/UnboundMetadata.html" title="interface in org.apache.calcite.rel.metadata">UnboundMetadata</a><M> apply(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> relClass, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends M> metadataClass)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>relClass</code> - Type of relational expression</dd> |
| <dd><code>metadataClass</code> - Type of metadata</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Function that will field a metadata instance; or null if this |
| provider cannot supply metadata of this type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handlers-org.apache.calcite.rel.metadata.MetadataDef-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>handlers</h4> |
| <pre><M extends <a href="../../../../../org/apache/calcite/rel/metadata/Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>> com.google.common.collect.Multimap<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a>,<a href="../../../../../org/apache/calcite/rel/metadata/MetadataHandler.html" title="interface in org.apache.calcite.rel.metadata">MetadataHandler</a><M>> handlers(<a href="../../../../../org/apache/calcite/rel/metadata/MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a><M> def)</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/rel/metadata/RelMdUtil.html" title="class in org.apache.calcite.rel.metadata"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/rel/metadata/RelMetadataProvider.html" target="_top">Frames</a></li> |
| <li><a href="RelMetadataProvider.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 © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |
