Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / schema / TranslatableTable.html
blob: f773201ae8f1044928fca5b572307672de4f4656 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TranslatableTable (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.schema, interface: TranslatableTable">
<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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.schema</a></div>
<h1 title="Interface TranslatableTable" class="title">Interface TranslatableTable</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../adapter/cassandra/CassandraTable.html" title="class in org.apache.calcite.adapter.cassandra">CassandraTable</a></code>, <code><a href="../adapter/csv/CsvTranslatableTable.html" title="class in org.apache.calcite.adapter.csv">CsvTranslatableTable</a></code>, <code><a href="../adapter/file/CsvTranslatableTable.html" title="class in org.apache.calcite.adapter.file">CsvTranslatableTable</a></code>, <code><a href="../adapter/druid/DruidTable.html" title="class in org.apache.calcite.adapter.druid">DruidTable</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchTable.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchTable</a></code>, <code><a href="../adapter/geode/rel/GeodeTable.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeTable</a></code>, <code><a href="../adapter/innodb/InnodbTable.html" title="class in org.apache.calcite.adapter.innodb">InnodbTable</a></code>, <code><a href="../adapter/jdbc/JdbcTable.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTable</a></code>, <code><a href="impl/MaterializedViewTable.html" title="class in org.apache.calcite.schema.impl">MaterializedViewTable</a></code>, <code><a href="../test/catalog/MockCatalogReader.MockDynamicTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockDynamicTable</a></code>, <code><a href="../test/catalog/MockCatalogReader.MockModifiableViewRelOptTable.MockModifiableViewTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockModifiableViewRelOptTable.MockModifiableViewTable</a></code>, <code><a href="impl/ModifiableViewTable.html" title="class in org.apache.calcite.schema.impl">ModifiableViewTable</a></code>, <code><a href="../adapter/mongodb/MongoTable.html" title="class in org.apache.calcite.adapter.mongodb">MongoTable</a></code>, <code><a href="../adapter/pig/PigTable.html" title="class in org.apache.calcite.adapter.pig">PigTable</a></code>, <code><a href="../util/Smalls.SimpleTable.html" title="class in org.apache.calcite.util">Smalls.SimpleTable</a></code>, <code><a href="impl/StarTable.html" title="class in org.apache.calcite.schema.impl">StarTable</a></code>, <code><a href="impl/ViewTable.html" title="class in org.apache.calcite.schema.impl">ViewTable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">TranslatableTable</span><span class="extends-implements">
extends <a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></span></div>
<div class="block">Extension to <a href="Table.html" title="interface in org.apache.calcite.schema"><code>Table</code></a> that specifies how it is to be translated to
a <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expression</code></a>.
<p>It is optional for a Table to implement this interface. If Table does
not implement this interface, it will be converted to an
<a href="../adapter/enumerable/EnumerableTableScan.html" title="class in org.apache.calcite.adapter.enumerable"><code>EnumerableTableScan</code></a>.
Generally a Table will implement this interface to
create a particular subclass of RelNode, and also register rules that act
on that particular subclass of RelNode.</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></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><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toRel(org.apache.calcite.plan.RelOptTable.ToRelContext,org.apache.calcite.plan.RelOptTable)" class="member-name-link">toRel</a><wbr>(<a href="../plan/RelOptTable.ToRelContext.html" title="interface in org.apache.calcite.plan">RelOptTable.ToRelContext</a>&nbsp;context,
<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a>&nbsp;relOptTable)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts this table into a <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expression</code></a>.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.schema.Table">Methods inherited from interface&nbsp;org.apache.calcite.schema.<a href="Table.html" title="interface in org.apache.calcite.schema">Table</a></h3>
<code><a href="Table.html#getJdbcTableType()">getJdbcTableType</a>, <a href="Table.html#getRowType(org.apache.calcite.rel.type.RelDataTypeFactory)">getRowType</a>, <a href="Table.html#getStatistic()">getStatistic</a>, <a href="Table.html#isRolledUp(java.lang.String)">isRolledUp</a>, <a href="Table.html#rolledUpColumnValidInsideAgg(java.lang.String,org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.SqlNode,org.apache.calcite.config.CalciteConnectionConfig)">rolledUpColumnValidInsideAgg</a></code></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="toRel(org.apache.calcite.plan.RelOptTable.ToRelContext,org.apache.calcite.plan.RelOptTable)">
<h3>toRel</h3>
<div class="member-signature"><span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span>&nbsp;<span class="element-name">toRel</span><wbr><span class="parameters">(<a href="../plan/RelOptTable.ToRelContext.html" title="interface in org.apache.calcite.plan">RelOptTable.ToRelContext</a>&nbsp;context,
<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a>&nbsp;relOptTable)</span></div>
<div class="block">Converts this table into a <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expression</code></a>.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>