| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>EnumerableTableScan (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.adapter.enumerable, class: EnumerableTableScan"> |
| <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":9,"i1":41,"i2":10,"i3":9,"i4":9,"i5":9,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.adapter.enumerable</a></div> |
| <h1 title="Class EnumerableTableScan" class="title">Class EnumerableTableScan</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance"><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.AbstractRelNode</a> |
| <div class="inheritance"><a href="../../rel/core/TableScan.html" title="class in org.apache.calcite.rel.core">org.apache.calcite.rel.core.TableScan</a> |
| <div class="inheritance">org.apache.calcite.adapter.enumerable.EnumerableTableScan</div> |
| </div> |
| </div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code>, <code><a href="EnumerableRel.html" title="interface in org.apache.calcite.adapter.enumerable">EnumerableRel</a></code>, <code><a href="../../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code>, <code><a href="../../rel/hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></code>, <code><a href="../../rel/PhysicalNode.html" title="interface in org.apache.calcite.rel">PhysicalNode</a></code>, <code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">EnumerableTableScan</span> |
| extends <a href="../../rel/core/TableScan.html" title="class in org.apache.calcite.rel.core">TableScan</a> |
| implements <a href="EnumerableRel.html" title="interface in org.apache.calcite.adapter.enumerable">EnumerableRel</a></pre> |
| <div class="block">Implementation of <a href="../../rel/core/TableScan.html" title="class in org.apache.calcite.rel.core"><code>TableScan</code></a> in |
| <a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable"><code>enumerable calling convention</code></a>.</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="inheritedList"> |
| <h2>Nested classes/interfaces inherited from interface org.apache.calcite.adapter.enumerable.<a href="EnumerableRel.html" title="interface in org.apache.calcite.adapter.enumerable">EnumerableRel</a></h2> |
| <a id="nested.classes.inherited.from.class.org.apache.calcite.adapter.enumerable.EnumerableRel"> |
| <!-- --> |
| </a><code><a href="EnumerableRel.Prefer.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableRel.Prefer</a>, <a href="EnumerableRel.Result.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableRel.Result</a></code></div> |
| <div class="inheritedList"> |
| <h2>Nested classes/interfaces inherited from interface org.apache.calcite.rel.<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h2> |
| <a id="nested.classes.inherited.from.class.org.apache.calcite.rel.RelNode"> |
| <!-- --> |
| </a><code><a href="../../rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="inheritedList"> |
| <h3>Fields inherited from class org.apache.calcite.rel.core.<a href="../../rel/core/TableScan.html" title="class in org.apache.calcite.rel.core">TableScan</a></h3> |
| <a id="fields.inherited.from.class.org.apache.calcite.rel.core.TableScan"> |
| <!-- --> |
| </a><code><a href="../../rel/core/TableScan.html#hints">hints</a>, <a href="../../rel/core/TableScan.html#table">table</a></code></div> |
| <div class="inheritedList"> |
| <h3>Fields inherited from class org.apache.calcite.rel.<a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3> |
| <a id="fields.inherited.from.class.org.apache.calcite.rel.AbstractRelNode"> |
| <!-- --> |
| </a><code><a href="../../rel/AbstractRelNode.html#digest">digest</a>, <a href="../../rel/AbstractRelNode.html#id">id</a>, <a href="../../rel/AbstractRelNode.html#rowType">rowType</a>, <a href="../../rel/AbstractRelNode.html#traitSet">traitSet</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelOptTable,java.lang.Class)">EnumerableTableScan</a></span>​(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a> elementType)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an EnumerableTableScan.</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="t1" class="tableTab" onclick="show(1);">Static 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="t4" class="tableTab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated 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>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canHandle(org.apache.calcite.plan.RelOptTable)">canHandle</a></span>​(<a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> relOptTable)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether EnumerableTableScan can generate code to handle a |
| particular variant of the Table SPI.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canHandle(org.apache.calcite.schema.Table)">canHandle</a></span>​(<a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a> table)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></span>​(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a copy of this relational expression, perhaps changing traits and |
| inputs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>static <a href="EnumerableTableScan.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableScan</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelOptTable)">create</a></span>​(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> relOptTable)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an EnumerableTableScan.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deduceElementType(org.apache.calcite.schema.Table)">deduceElementType</a></span>​(<a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a> table)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>static <a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deduceFormat(org.apache.calcite.plan.RelOptTable)">deduceFormat</a></span>​(<a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code><a href="../../plan/DeriveMode.html" title="enum in org.apache.calcite.plan">DeriveMode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDeriveMode()">getDeriveMode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns mode of derivation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code><a href="EnumerableRel.Result.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableRel.Result</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#implement(org.apache.calcite.adapter.enumerable.EnumerableRelImplementor,org.apache.calcite.adapter.enumerable.EnumerableRel.Prefer)">implement</a></span>​(<a href="EnumerableRelImplementor.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableRelImplementor</a> implementor, |
| <a href="EnumerableRel.Prefer.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableRel.Prefer</a> pref)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a plan for this expression according to a calling convention.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#passThrough(org.apache.calcite.plan.RelTraitSet)">passThrough</a></span>​(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> required)</code></th> |
| <td class="colLast"> |
| <div class="block">Code snippet to demonstrate how to generate IndexScan on demand |
| by passing required collation through TableScan.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class org.apache.calcite.rel.core.<a href="../../rel/core/TableScan.html" title="class in org.apache.calcite.rel.core">TableScan</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.rel.core.TableScan"> |
| <!-- --> |
| </a><code><a href="../../rel/core/TableScan.html#accept(org.apache.calcite.rel.RelShuttle)">accept</a>, <a href="../../rel/core/TableScan.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a>, <a href="../../rel/core/TableScan.html#deriveRowType()">deriveRowType</a>, <a href="../../rel/core/TableScan.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a>, <a href="../../rel/core/TableScan.html#explainTerms(org.apache.calcite.rel.RelWriter)">explainTerms</a>, <a href="../../rel/core/TableScan.html#getHints()">getHints</a>, <a href="../../rel/core/TableScan.html#getTable()">getTable</a>, <a href="../../rel/core/TableScan.html#identity()">identity</a>, <a href="../../rel/core/TableScan.html#identity(org.apache.calcite.plan.RelOptTable)">identity</a>, <a href="../../rel/core/TableScan.html#project(org.apache.calcite.util.ImmutableBitSet,java.util.Set,org.apache.calcite.tools.RelBuilder)">project</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class org.apache.calcite.rel.<a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.rel.AbstractRelNode"> |
| <!-- --> |
| </a><code><a href="../../rel/AbstractRelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</a>, <a href="../../rel/AbstractRelNode.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a>, <a href="../../rel/AbstractRelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a>, <a href="../../rel/AbstractRelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a>, <a href="../../rel/AbstractRelNode.html#deepEquals(java.lang.Object)">deepEquals</a>, <a href="../../rel/AbstractRelNode.html#deepHashCode()">deepHashCode</a>, <a href="../../rel/AbstractRelNode.html#equals(java.lang.Object)">equals</a>, <a href="../../rel/AbstractRelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a>, <a href="../../rel/AbstractRelNode.html#getCluster()">getCluster</a>, <a href="../../rel/AbstractRelNode.html#getConvention()">getConvention</a>, <a href="../../rel/AbstractRelNode.html#getCorrelVariable()">getCorrelVariable</a>, <a href="../../rel/AbstractRelNode.html#getDescription()">getDescription</a>, <a href="../../rel/AbstractRelNode.html#getDigest()">getDigest</a>, <a href="../../rel/AbstractRelNode.html#getExpectedInputRowType(int)">getExpectedInputRowType</a>, <a href="../../rel/AbstractRelNode.html#getId()">getId</a>, <a href="../../rel/AbstractRelNode.html#getInput(int)">getInput</a>, <a href="../../rel/AbstractRelNode.html#getInputs()">getInputs</a>, <a href="../../rel/AbstractRelNode.html#getRelDigest()">getRelDigest</a>, <a href="../../rel/AbstractRelNode.html#getRelTypeName()">getRelTypeName</a>, <a href="../../rel/AbstractRelNode.html#getRowType()">getRowType</a>, <a href="../../rel/AbstractRelNode.html#getTraitSet()">getTraitSet</a>, <a href="../../rel/AbstractRelNode.html#getVariablesSet()">getVariablesSet</a>, <a href="../../rel/AbstractRelNode.html#hashCode()">hashCode</a>, <a href="../../rel/AbstractRelNode.html#isEnforcer()">isEnforcer</a>, <a href="../../rel/AbstractRelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a>, <a href="../../rel/AbstractRelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a>, <a href="../../rel/AbstractRelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a>, <a href="../../rel/AbstractRelNode.html#recomputeDigest()">recomputeDigest</a>, <a href="../../rel/AbstractRelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="../../rel/AbstractRelNode.html#replaceInput(int,org.apache.calcite.rel.RelNode)">replaceInput</a>, <a href="../../rel/AbstractRelNode.html#sole(java.util.List)">sole</a>, <a href="../../rel/AbstractRelNode.html#toString()">toString</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.apache.calcite.adapter.enumerable.<a href="EnumerableRel.html" title="interface in org.apache.calcite.adapter.enumerable">EnumerableRel</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.EnumerableRel"> |
| <!-- --> |
| </a><code><a href="EnumerableRel.html#deriveTraits(org.apache.calcite.plan.RelTraitSet,int)">deriveTraits</a>, <a href="EnumerableRel.html#passThroughTraits(org.apache.calcite.plan.RelTraitSet)">passThroughTraits</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.apache.calcite.rel.hint.<a href="../../rel/hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.rel.hint.Hintable"> |
| <!-- --> |
| </a><code><a href="../../rel/hint/Hintable.html#attachHints(java.util.List)">attachHints</a>, <a href="../../rel/hint/Hintable.html#withHints(java.util.List)">withHints</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.apache.calcite.rel.<a href="../../rel/PhysicalNode.html" title="interface in org.apache.calcite.rel">PhysicalNode</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.rel.PhysicalNode"> |
| <!-- --> |
| </a><code><a href="../../rel/PhysicalNode.html#derive(java.util.List)">derive</a>, <a href="../../rel/PhysicalNode.html#derive(org.apache.calcite.plan.RelTraitSet,int)">derive</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.apache.calcite.rel.<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.rel.RelNode"> |
| <!-- --> |
| </a><code><a href="../../rel/RelNode.html#accept(org.apache.calcite.rel.RelShuttle)">accept</a>, <a href="../../rel/RelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</a>, <a href="../../rel/RelNode.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a>, <a href="../../rel/RelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a>, <a href="../../rel/RelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a>, <a href="../../rel/RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a>, <a href="../../rel/RelNode.html#deepEquals(java.lang.Object)">deepEquals</a>, <a href="../../rel/RelNode.html#deepHashCode()">deepHashCode</a>, <a href="../../rel/RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a>, <a href="../../rel/RelNode.html#explain()">explain</a>, <a href="../../rel/RelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a>, <a href="../../rel/RelNode.html#getConvention()">getConvention</a>, <a href="../../rel/RelNode.html#getCorrelVariable()">getCorrelVariable</a>, <a href="../../rel/RelNode.html#getDigest()">getDigest</a>, <a href="../../rel/RelNode.html#getExpectedInputRowType(int)">getExpectedInputRowType</a>, <a href="../../rel/RelNode.html#getInput(int)">getInput</a>, <a href="../../rel/RelNode.html#getInputs()">getInputs</a>, <a href="../../rel/RelNode.html#getRelDigest()">getRelDigest</a>, <a href="../../rel/RelNode.html#getRelTypeName()">getRelTypeName</a>, <a href="../../rel/RelNode.html#getRowType()">getRowType</a>, <a href="../../rel/RelNode.html#getTable()">getTable</a>, <a href="../../rel/RelNode.html#getVariablesSet()">getVariablesSet</a>, <a href="../../rel/RelNode.html#isEnforcer()">isEnforcer</a>, <a href="../../rel/RelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a>, <a href="../../rel/RelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a>, <a href="../../rel/RelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a>, <a href="../../rel/RelNode.html#recomputeDigest()">recomputeDigest</a>, <a href="../../rel/RelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="../../rel/RelNode.html#replaceInput(int,org.apache.calcite.rel.RelNode)">replaceInput</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.apache.calcite.plan.<a href="../../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.plan.RelOptNode"> |
| <!-- --> |
| </a><code><a href="../../plan/RelOptNode.html#getCluster()">getCluster</a>, <a href="../../plan/RelOptNode.html#getDescription()">getDescription</a>, <a href="../../plan/RelOptNode.html#getId()">getId</a>, <a href="../../plan/RelOptNode.html#getTraitSet()">getTraitSet</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelOptTable,java.lang.Class)">EnumerableTableScan</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">EnumerableTableScan</span>​(<span class="arguments"><a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a> elementType)</span></div> |
| <div class="block">Creates an EnumerableTableScan. |
| |
| <p>Use <a href="#create(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelOptTable)"><code>create(org.apache.calcite.plan.RelOptCluster, org.apache.calcite.plan.RelOptTable)</code></a> unless you know what you are doing.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ 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="passThrough(org.apache.calcite.plan.RelTraitSet)">passThrough</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="memberName">passThrough</span>​(<span class="arguments"><a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> required)</span></div> |
| <div class="block">Code snippet to demonstrate how to generate IndexScan on demand |
| by passing required collation through TableScan.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../rel/PhysicalNode.html#passThrough(org.apache.calcite.plan.RelTraitSet)">passThrough</a></code> in interface <code><a href="../../rel/PhysicalNode.html" title="interface in org.apache.calcite.rel">PhysicalNode</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IndexScan if there is index available on collation keys</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getDeriveMode()">getDeriveMode</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../plan/DeriveMode.html" title="enum in org.apache.calcite.plan">DeriveMode</a></span> <span class="memberName">getDeriveMode</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../rel/PhysicalNode.html#getDeriveMode()">PhysicalNode</a></code></span></div> |
| <div class="block">Returns mode of derivation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="EnumerableRel.html#getDeriveMode()">getDeriveMode</a></code> in interface <code><a href="EnumerableRel.html" title="interface in org.apache.calcite.adapter.enumerable">EnumerableRel</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../rel/PhysicalNode.html#getDeriveMode()">getDeriveMode</a></code> in interface <code><a href="../../rel/PhysicalNode.html" title="interface in org.apache.calcite.rel">PhysicalNode</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="create(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelOptTable)">create</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="EnumerableTableScan.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableScan</a></span> <span class="memberName">create</span>​(<span class="arguments"><a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> relOptTable)</span></div> |
| <div class="block">Creates an EnumerableTableScan.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="canHandle(org.apache.calcite.schema.Table)">canHandle</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">canHandle</span>​(<span class="arguments"><a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a> table)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Returns whether EnumerableTableScan can generate code to handle a |
| particular variant of the Table SPI.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="canHandle(org.apache.calcite.plan.RelOptTable)">canHandle</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">canHandle</span>​(<span class="arguments"><a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> relOptTable)</span></div> |
| <div class="block">Returns whether EnumerableTableScan can generate code to handle a |
| particular variant of the Table SPI.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="deduceElementType(org.apache.calcite.schema.Table)">deduceElementType</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a></span> <span class="memberName">deduceElementType</span>​(<span class="arguments"><a href="../../schema/Table.html" title="interface in org.apache.calcite.schema">Table</a> table)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="deduceFormat(org.apache.calcite.plan.RelOptTable)">deduceFormat</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="JavaRowFormat.html" title="enum in org.apache.calcite.adapter.enumerable">JavaRowFormat</a></span> <span class="memberName">deduceFormat</span>​(<span class="arguments"><a href="../../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="memberName">copy</span>​(<span class="arguments"><a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../rel/RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">RelNode</a></code></span></div> |
| <div class="block">Creates a copy of this relational expression, perhaps changing traits and |
| inputs. |
| |
| <p>Sub-classes with other important attributes are encouraged to create |
| variants of this method with more parameters.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../rel/RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code> in interface <code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../rel/AbstractRelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code> in class <code><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>traitSet</code> - Trait set</dd> |
| <dd><code>inputs</code> - Inputs</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Copy of this relational expression, substituting traits and |
| inputs</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="implement(org.apache.calcite.adapter.enumerable.EnumerableRelImplementor,org.apache.calcite.adapter.enumerable.EnumerableRel.Prefer)">implement</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="EnumerableRel.Result.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableRel.Result</a></span> <span class="memberName">implement</span>​(<span class="arguments"><a href="EnumerableRelImplementor.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableRelImplementor</a> implementor, |
| <a href="EnumerableRel.Prefer.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableRel.Prefer</a> pref)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="EnumerableRel.html#implement(org.apache.calcite.adapter.enumerable.EnumerableRelImplementor,org.apache.calcite.adapter.enumerable.EnumerableRel.Prefer)">EnumerableRel</a></code></span></div> |
| <div class="block">Creates a plan for this expression according to a calling convention.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="EnumerableRel.html#implement(org.apache.calcite.adapter.enumerable.EnumerableRelImplementor,org.apache.calcite.adapter.enumerable.EnumerableRel.Prefer)">implement</a></code> in interface <code><a href="EnumerableRel.html" title="interface in org.apache.calcite.adapter.enumerable">EnumerableRel</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>implementor</code> - Implementor</dd> |
| <dd><code>pref</code> - Preferred representation for rows in result expression</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Plan for this expression according to a calling convention</dd> |
| </dl> |
| </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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |