blob: 1bed1724b2211e9b91e361088bc9b4f6df1574db [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>BuiltInMetadata (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">
<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 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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&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><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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="Class BuiltInMetadata" class="title">Class BuiltInMetadata</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.calcite.rel.metadata.BuiltInMetadata</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">BuiltInMetadata</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Contains the interfaces for several common forms of metadata.</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">Class</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.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.AllPredicates</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the predicates that hold in the rows emitted from a
relational expression.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.Collation.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Collation</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about which columns are sorted.</div>
</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.ColumnOrigin.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.ColumnOrigin</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the origins of columns.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.ColumnUniqueness.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.ColumnUniqueness</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about whether a set of columns uniquely identifies a row.</div>
</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.CumulativeCost.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.CumulativeCost</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the cost of evaluating a relational expression, including
all of its inputs.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.DistinctRowCount.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.DistinctRowCount</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about the number of distinct rows returned by a set of columns
in a relational expression.</div>
</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.Distribution.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Distribution</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about how a relational expression is distributed.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.ExplainVisibility.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.ExplainVisibility</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about whether a relational expression should appear in a plan.</div>
</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.ExpressionLineage.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.ExpressionLineage</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the origins of expressions.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.LowerBoundCost.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.LowerBoundCost</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata to get the lower bound cost of a RelNode.</div>
</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.MaxRowCount.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.MaxRowCount</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the maximum number of rows returned by a relational
expression.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.Memory.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Memory</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about the memory use of an operator.</div>
</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.MinRowCount.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.MinRowCount</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the minimum number of rows returned by a relational
expression.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.NodeTypes.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.NodeTypes</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about the node types in a relational expression.</div>
</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.NonCumulativeCost.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.NonCumulativeCost</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the cost of evaluating a relational expression, not
including its inputs.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.Parallelism.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Parallelism</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about the degree of parallelism of a relational expression, and
how its operators are assigned to processes with independent resource
pools.</div>
</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.PercentageOriginalRows.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.PercentageOriginalRows</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the proportion of original rows that remain in a relational
expression.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.PopulationSize.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.PopulationSize</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about the number of distinct values in the original source of a
column or set of columns.</div>
</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.Predicates.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Predicates</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the predicates that hold in the rows emitted from a
relational expression.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.RowCount.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.RowCount</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about the number of rows returned by a relational expression.</div>
</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.Selectivity.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Selectivity</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata about the selectivity of a predicate.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.Size.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.Size</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about the size of rows and columns.</div>
</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.TableReferences.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.TableReferences</a></code></div>
<div class="col-last even-row-color">
<div class="block">Metadata to obtain references to tables used by a given expression.</div>
</div>
<div class="col-first odd-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="BuiltInMetadata.UniqueKeys.html" class="type-name-link" title="interface in org.apache.calcite.rel.metadata">BuiltInMetadata.UniqueKeys</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Metadata about which combinations of columns are unique identifiers.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BuiltInMetadata</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 class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>BuiltInMetadata</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">BuiltInMetadata</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>