javadocAggregate/org/apache/calcite/rel/metadata/BuiltInMetadata.AllPredicates.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>BuiltInMetadata.AllPredicates (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.rel.metadata, class: BuiltInMetadata, interface: AllPredicates">
 <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.rel.metadata</a></div>
 <h1 title="Interface BuiltInMetadata.AllPredicates" class="title">Interface BuiltInMetadata.AllPredicates</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>Enclosing class:</dt>
 <dd><a href="BuiltInMetadata.html" title="class in org.apache.calcite.rel.metadata">BuiltInMetadata</a></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">BuiltInMetadata.AllPredicates</span><span class="extends-implements">
 extends <a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a></span></div>
 <div class="block">Metadata about the predicates that hold in the rows emitted from a
  relational expression.

  <p>The difference with respect to <a href="BuiltInMetadata.Predicates.html" title="interface in org.apache.calcite.rel.metadata"><code>BuiltInMetadata.Predicates</code></a> provider is that
  this provider tries to extract ALL predicates even if they are not
  applied on the output expressions of the relational expression; we rely
  on <a href="../../rex/RexTableInputRef.html" title="class in org.apache.calcite.rex"><code>RexTableInputRef</code></a> to reference origin columns in
  <a href="../core/TableScan.html" title="class in org.apache.calcite.rel.core"><code>TableScan</code></a> for the result predicates.</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 interface&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="BuiltInMetadata.AllPredicates.Handler.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.AllPredicates.Handler</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">Handler API.</div>
 </div>
 </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="MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a>&lt;<a href="BuiltInMetadata.AllPredicates.html" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.AllPredicates</a>&gt;</code></div>
 <div class="col-second even-row-color"><code><a href="#DEF" class="member-name-link">DEF</a></code></div>
 <div class="col-last even-row-color">&nbsp;</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>@Nullable <a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAllPredicates()" class="member-name-link">getAllPredicates</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Derives the predicates that hold on rows emitted from a relational
  expression.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.calcite.rel.metadata.Metadata">Methods inherited from interface&nbsp;org.apache.calcite.rel.metadata.<a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a></h3>
 <code><a href="Metadata.html#rel()">rel</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="DEF">
 <h3>DEF</h3>
 <div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type"><a href="MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a>&lt;<a href="BuiltInMetadata.AllPredicates.html" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.AllPredicates</a>&gt;</span>&nbsp;<span class="element-name">DEF</span></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="getAllPredicates()">
 <h3>getAllPredicates</h3>
 <div class="member-signature"><span class="return-type">@Nullable <a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span>&nbsp;<span class="element-name">getAllPredicates</span>()</div>
 <div class="block">Derives the predicates that hold on rows emitted from a relational
  expression.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>predicate list, or null if the provider cannot infer the
  lineage for any of the expressions contained in any of the predicates</dd>
 </dl>
 </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>
	<!DOCTYPE HTML>
	<html lang="en">
	<head>
	<!-- Generated by javadoc (17) -->
	<title>BuiltInMetadata.AllPredicates (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.rel.metadata, class: BuiltInMetadata, interface: AllPredicates">
	<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: </li>
	<li><a href="#nested-class-summary">Nested</a> \| </li>
	<li><a href="#field-summary">Field</a> \| </li>
	<li>Constr \| </li>
	<li><a href="#method-summary">Method</a></li>
	</ul>
	<ul class="sub-nav-list">
	<li>Detail: </li>
	<li><a href="#field-detail">Field</a> \| </li>
	<li>Constr \| </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> <a href="package-summary.html">org.apache.calcite.rel.metadata</a></div>
	<h1 title="Interface BuiltInMetadata.AllPredicates" class="title">Interface BuiltInMetadata.AllPredicates</h1>
	</div>
	<section class="class-description" id="class-description">
	<dl class="notes">
	<dt>All Superinterfaces:</dt>
	<dd><code><a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a></code></dd>
	</dl>
	<dl class="notes">
	<dt>Enclosing class:</dt>
	<dd><a href="BuiltInMetadata.html" title="class in org.apache.calcite.rel.metadata">BuiltInMetadata</a></dd>
	</dl>
	<hr>
	<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">BuiltInMetadata.AllPredicates</span><span class="extends-implements">
	extends <a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a></span></div>
	<div class="block">Metadata about the predicates that hold in the rows emitted from a
	relational expression.

	<p>The difference with respect to <a href="BuiltInMetadata.Predicates.html" title="interface in org.apache.calcite.rel.metadata"><code>BuiltInMetadata.Predicates</code></a> provider is that
	this provider tries to extract ALL predicates even if they are not
	applied on the output expressions of the relational expression; we rely
	on <a href="../../rex/RexTableInputRef.html" title="class in org.apache.calcite.rex"><code>RexTableInputRef</code></a> to reference origin columns in
	<a href="../core/TableScan.html" title="class in org.apache.calcite.rel.core"><code>TableScan</code></a> for the result predicates.</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 interface </code></div>
	<div class="col-second even-row-color"><code><a href="BuiltInMetadata.AllPredicates.Handler.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.AllPredicates.Handler</a></code></div>
	<div class="col-last even-row-color">
	<div class="block">Handler API.</div>
	</div>
	</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="MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a><<a href="BuiltInMetadata.AllPredicates.html" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.AllPredicates</a>></code></div>
	<div class="col-second even-row-color"><code><a href="#DEF" class="member-name-link">DEF</a></code></div>
	<div class="col-last even-row-color"> </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>@Nullable <a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></code></div>
	<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAllPredicates()" class="member-name-link">getAllPredicates</a>()</code></div>
	<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
	<div class="block">Derives the predicates that hold on rows emitted from a relational
	expression.</div>
	</div>
	</div>
	</div>
	</div>
	<div class="inherited-list">
	<h3 id="methods-inherited-from-class-org.apache.calcite.rel.metadata.Metadata">Methods inherited from interface org.apache.calcite.rel.metadata.<a href="Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a></h3>
	<code><a href="Metadata.html#rel()">rel</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="DEF">
	<h3>DEF</h3>
	<div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="MetadataDef.html" title="class in org.apache.calcite.rel.metadata">MetadataDef</a><<a href="BuiltInMetadata.AllPredicates.html" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.AllPredicates</a>></span> <span class="element-name">DEF</span></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="getAllPredicates()">
	<h3>getAllPredicates</h3>
	<div class="member-signature"><span class="return-type">@Nullable <a href="../../plan/RelOptPredicateList.html" title="class in org.apache.calcite.plan">RelOptPredicateList</a></span> <span class="element-name">getAllPredicates</span>()</div>
	<div class="block">Derives the predicates that hold on rows emitted from a relational
	expression.</div>
	<dl class="notes">
	<dt>Returns:</dt>
	<dd>predicate list, or null if the provider cannot infer the
	lineage for any of the expressions contained in any of the predicates</dd>
	</dl>
	</section>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</section>
	<!-- ========= END OF CLASS DATA ========= -->
	</main>
	<footer role="contentinfo">
	<hr>
	<p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
	</footer>
	</div>
	</div>
	</body>
	</html>