blob: 124a57c542c90510d60a25133bdcdb50dc1e0775 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>CassandraRel (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.adapter.cassandra, interface: CassandraRel">
<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><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&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><a href="#field-detail">Field</a>&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.adapter.cassandra</a></div>
<h1 title="Interface CassandraRel" class="title">Interface CassandraRel</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code>, <code><a href="../../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="CassandraFilter.html" title="class in org.apache.calcite.adapter.cassandra">CassandraFilter</a></code>, <code><a href="CassandraLimit.html" title="class in org.apache.calcite.adapter.cassandra">CassandraLimit</a></code>, <code><a href="CassandraProject.html" title="class in org.apache.calcite.adapter.cassandra">CassandraProject</a></code>, <code><a href="CassandraSort.html" title="class in org.apache.calcite.adapter.cassandra">CassandraSort</a></code>, <code><a href="CassandraTableScan.html" title="class in org.apache.calcite.adapter.cassandra">CassandraTableScan</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">CassandraRel</span><span class="extends-implements">
extends <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span></div>
<div class="block">Relational expression that uses Cassandra calling convention.</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 class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="CassandraRel.Implementor.html" class="type-name-link" title="class in org.apache.calcite.adapter.cassandra">CassandraRel.Implementor</a></code></div>
<div class="col-last even-row-color">
<div class="block">Callback for the implementation process that converts a tree of
<a href="CassandraRel.html" title="interface in org.apache.calcite.adapter.cassandra"><code>CassandraRel</code></a> nodes into a CQL query.</div>
</div>
</div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.calcite.rel.RelNode">Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.rel.<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h2>
<code><a href="../../rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</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">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></div>
<div class="col-second even-row-color"><code><a href="#CONVENTION" class="member-name-link">CONVENTION</a></code></div>
<div class="col-last even-row-color">
<div class="block">Calling convention for relational operations that occur in Cassandra.</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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#implement(org.apache.calcite.adapter.cassandra.CassandraRel.Implementor)" class="member-name-link">implement</a><wbr>(<a href="CassandraRel.Implementor.html" title="class in org.apache.calcite.adapter.cassandra">CassandraRel.Implementor</a>&nbsp;implementor)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.rel.RelNode">Methods inherited from interface&nbsp;org.apache.calcite.rel.<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h3>
<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#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</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#fieldIsNullable(int)">fieldIsNullable</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="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.plan.RelOptNode">Methods inherited from interface&nbsp;org.apache.calcite.plan.<a href="../../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></h3>
<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="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="CONVENTION">
<h3>CONVENTION</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type"><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></span>&nbsp;<span class="element-name">CONVENTION</span></div>
<div class="block">Calling convention for relational operations that occur in Cassandra.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="implement(org.apache.calcite.adapter.cassandra.CassandraRel.Implementor)">
<h3>implement</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">implement</span><wbr><span class="parameters">(<a href="CassandraRel.Implementor.html" title="class in org.apache.calcite.adapter.cassandra">CassandraRel.Implementor</a>&nbsp;implementor)</span></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>