blob: eccfc4544dacdb27e9f2082e209030997bbaac81 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>MongoRel (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.mongodb, interface: MongoRel">
<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":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";
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:&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="subNavList">
<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="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>&nbsp;<a href="package-summary.html">org.apache.calcite.adapter.mongodb</a></div>
<h1 title="Interface MongoRel" class="title">Interface MongoRel</h1>
</div>
<div class="contentContainer">
<section class="description">
<dl>
<dt>All Superinterfaces:</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="../../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>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="MongoAggregate.html" title="class in org.apache.calcite.adapter.mongodb">MongoAggregate</a></code>, <code><a href="MongoFilter.html" title="class in org.apache.calcite.adapter.mongodb">MongoFilter</a></code>, <code><a href="MongoProject.html" title="class in org.apache.calcite.adapter.mongodb">MongoProject</a></code>, <code><a href="MongoSort.html" title="class in org.apache.calcite.adapter.mongodb">MongoSort</a></code>, <code><a href="MongoTableScan.html" title="class in org.apache.calcite.adapter.mongodb">MongoTableScan</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">MongoRel</span>
extends <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></pre>
<div class="block">Relational expression that uses Mongo calling convention.</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="memberSummary">
<table>
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MongoRel.Implementor.html" title="class in org.apache.calcite.adapter.mongodb">MongoRel.Implementor</a></span></code></th>
<td class="colLast">
<div class="block">Callback for the implementation process that converts a tree of
<a href="MongoRel.html" title="interface in org.apache.calcite.adapter.mongodb"><code>MongoRel</code></a> nodes into a MongoDB query.</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="inheritedList">
<h2>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>
<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="memberSummary">
<table>
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CONVENTION">CONVENTION</a></span></code></th>
<td class="colLast">
<div class="block">Calling convention for relational operations that occur in MongoDB.</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="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="t3" class="tableTab" onclick="show(4);">Abstract 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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#implement(org.apache.calcite.adapter.mongodb.MongoRel.Implementor)">implement</a></span>&#8203;(<a href="MongoRel.Implementor.html" title="class in org.apache.calcite.adapter.mongodb">MongoRel.Implementor</a>&nbsp;implementor)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;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#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="inheritedList">
<h3>Methods inherited from interface&nbsp;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">
<!-- ============ FIELD DETAIL =========== -->
<li class="blockList">
<section class="fieldDetails"><a id="field.detail">
<!-- -->
</a>
<h2>Field Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="CONVENTION">CONVENTION</a></h3>
<div class="memberSignature"><span class="modifiers">static final</span>&nbsp;<span class="returnType"><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></span>&nbsp;<span class="memberName">CONVENTION</span></div>
<div class="block">Calling convention for relational operations that occur in MongoDB.</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="implement(org.apache.calcite.adapter.mongodb.MongoRel.Implementor)">implement</a></h3>
<div class="memberSignature"><span class="returnType">void</span>&nbsp;<span class="memberName">implement</span>&#8203;(<span class="arguments"><a href="MongoRel.Implementor.html" title="class in org.apache.calcite.adapter.mongodb">MongoRel.Implementor</a>&nbsp;implementor)</span></div>
</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:&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="subNavList">
<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>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>