blob: e663ed187efc1edc9bfa4c39dc3871dba951f125 [file] [log] [blame]
<!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>MongoRel (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="MongoRel (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"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";
</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/adapter/mongodb/MongoProject.html" title="class in org.apache.calcite.adapter.mongodb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/adapter/mongodb/MongoRel.Implementor.html" title="class in org.apache.calcite.adapter.mongodb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/adapter/mongodb/MongoRel.html" target="_top">Frames</a></li>
<li><a href="MongoRel.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.calcite.adapter.mongodb</div>
<h2 title="Interface MongoRel" class="title">Interface MongoRel</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>, <a href="../../../../../org/apache/calcite/plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/calcite/adapter/mongodb/MongoAggregate.html" title="class in org.apache.calcite.adapter.mongodb">MongoAggregate</a>, <a href="../../../../../org/apache/calcite/adapter/mongodb/MongoFilter.html" title="class in org.apache.calcite.adapter.mongodb">MongoFilter</a>, <a href="../../../../../org/apache/calcite/adapter/mongodb/MongoProject.html" title="class in org.apache.calcite.adapter.mongodb">MongoProject</a>, <a href="../../../../../org/apache/calcite/adapter/mongodb/MongoSort.html" title="class in org.apache.calcite.adapter.mongodb">MongoSort</a>, <a href="../../../../../org/apache/calcite/adapter/mongodb/MongoTableScan.html" title="class in org.apache.calcite.adapter.mongodb">MongoTableScan</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MongoRel</span>
extends <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></pre>
<div class="block">Relational expression that uses Mongo calling convention.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/adapter/mongodb/MongoRel.Implementor.html" title="class in org.apache.calcite.adapter.mongodb">MongoRel.Implementor</a></span></code>
<div class="block">Callback for the implementation process that converts a tree of
<a href="../../../../../org/apache/calcite/adapter/mongodb/MongoRel.html" title="interface in org.apache.calcite.adapter.mongodb"><code>MongoRel</code></a> nodes into a MongoDB query.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.calcite.rel.RelNode">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.rel.<a href="../../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h3>
<code><a href="../../../../../org/apache/calcite/rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/calcite/plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/adapter/mongodb/MongoRel.html#CONVENTION">CONVENTION</a></span></code>
<div class="block">Calling convention for relational operations that occur in MongoDB.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/adapter/mongodb/MongoRel.html#implement-org.apache.calcite.adapter.mongodb.MongoRel.Implementor-">implement</a></span>(<a href="../../../../../org/apache/calcite/adapter/mongodb/MongoRel.Implementor.html" title="class in org.apache.calcite.adapter.mongodb">MongoRel.Implementor</a>&nbsp;implementor)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.rel.RelNode">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.rel.<a href="../../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h3>
<code><a href="../../../../../org/apache/calcite/rel/RelNode.html#accept-org.apache.calcite.rel.RelShuttle-">accept</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#accept-org.apache.calcite.rex.RexShuttle-">accept</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#childrenAccept-org.apache.calcite.rel.RelVisitor-">childrenAccept</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#collectVariablesSet-java.util.Set-">collectVariablesSet</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#collectVariablesUsed-java.util.Set-">collectVariablesUsed</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#computeSelfCost-org.apache.calcite.plan.RelOptPlanner-">computeSelfCost</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#computeSelfCost-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.metadata.RelMetadataQuery-">computeSelfCost</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#copy-org.apache.calcite.plan.RelTraitSet-java.util.List-">copy</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#estimateRowCount-org.apache.calcite.rel.metadata.RelMetadataQuery-">estimateRowCount</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#explain-org.apache.calcite.rel.RelWriter-">explain</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getChildExps--">getChildExps</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getCollationList--">getCollationList</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getConvention--">getConvention</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getCorrelVariable--">getCorrelVariable</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getDigest--">getDigest</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getExpectedInputRowType-int-">getExpectedInputRowType</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getInput-int-">getInput</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getInputs--">getInputs</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getQuery--">getQuery</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getRelDigest--">getRelDigest</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getRelTypeName--">getRelTypeName</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getRows--">getRows</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getRowType--">getRowType</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getTable--">getTable</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getVariablesSet--">getVariablesSet</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getVariablesStopped--">getVariablesStopped</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#isDistinct--">isDistinct</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#isEnforcer--">isEnforcer</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#isKey-org.apache.calcite.util.ImmutableBitSet-">isKey</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#isValid-boolean-">isValid</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#isValid-org.apache.calcite.util.Litmus-org.apache.calcite.rel.RelNode.Context-">isValid</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#metadata-java.lang.Class-org.apache.calcite.rel.metadata.RelMetadataQuery-">metadata</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#onRegister-org.apache.calcite.plan.RelOptPlanner-">onRegister</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#recomputeDigest--">recomputeDigest</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#register-org.apache.calcite.plan.RelOptPlanner-">register</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#replaceInput-int-org.apache.calcite.rel.RelNode-">replaceInput</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.plan.RelOptNode">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.plan.<a href="../../../../../org/apache/calcite/plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></h3>
<code><a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getCluster--">getCluster</a>, <a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getDescription--">getDescription</a>, <a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getId--">getId</a>, <a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getTraitSet--">getTraitSet</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CONVENTION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CONVENTION</h4>
<pre>static final&nbsp;<a href="../../../../../org/apache/calcite/plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a> CONVENTION</pre>
<div class="block">Calling convention for relational operations that occur in MongoDB.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="implement-org.apache.calcite.adapter.mongodb.MongoRel.Implementor-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>implement</h4>
<pre>void&nbsp;implement(<a href="../../../../../org/apache/calcite/adapter/mongodb/MongoRel.Implementor.html" title="class in org.apache.calcite.adapter.mongodb">MongoRel.Implementor</a>&nbsp;implementor)</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/adapter/mongodb/MongoProject.html" title="class in org.apache.calcite.adapter.mongodb"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/adapter/mongodb/MongoRel.Implementor.html" title="class in org.apache.calcite.adapter.mongodb"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/adapter/mongodb/MongoRel.html" target="_top">Frames</a></li>
<li><a href="MongoRel.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>