blob: cfa5d010059516203d6d0d46166ddbb9c0f53c39 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Expression</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/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="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Expression";
}
}
catch(err) {
}
//-->
var data = {"i0":18,"i1":18,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.iceberg.expressions</a></div>
<h2 title="Interface Expression" class="title">Interface Expression</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code>java.io.Serializable</code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="Aggregate.html" title="class in org.apache.iceberg.expressions">Aggregate</a></code>, <code><a href="And.html" title="class in org.apache.iceberg.expressions">And</a></code>, <code><a href="BoundAggregate.html" title="class in org.apache.iceberg.expressions">BoundAggregate</a></code>, <code><a href="BoundLiteralPredicate.html" title="class in org.apache.iceberg.expressions">BoundLiteralPredicate</a></code>, <code><a href="BoundPredicate.html" title="class in org.apache.iceberg.expressions">BoundPredicate</a></code>, <code><a href="BoundSetPredicate.html" title="class in org.apache.iceberg.expressions">BoundSetPredicate</a></code>, <code><a href="BoundUnaryPredicate.html" title="class in org.apache.iceberg.expressions">BoundUnaryPredicate</a></code>, <code><a href="CountAggregate.html" title="class in org.apache.iceberg.expressions">CountAggregate</a></code>, <code><a href="CountNonNull.html" title="class in org.apache.iceberg.expressions">CountNonNull</a></code>, <code><a href="CountStar.html" title="class in org.apache.iceberg.expressions">CountStar</a></code>, <code><a href="False.html" title="class in org.apache.iceberg.expressions">False</a></code>, <code><a href="MaxAggregate.html" title="class in org.apache.iceberg.expressions">MaxAggregate</a></code>, <code><a href="MinAggregate.html" title="class in org.apache.iceberg.expressions">MinAggregate</a></code>, <code><a href="Not.html" title="class in org.apache.iceberg.expressions">Not</a></code>, <code><a href="Or.html" title="class in org.apache.iceberg.expressions">Or</a></code>, <code><a href="Predicate.html" title="class in org.apache.iceberg.expressions">Predicate</a></code>, <code><a href="True.html" title="class in org.apache.iceberg.expressions">True</a></code>, <code><a href="UnboundAggregate.html" title="class in org.apache.iceberg.expressions">UnboundAggregate</a></code>, <code><a href="UnboundPredicate.html" title="class in org.apache.iceberg.expressions">UnboundPredicate</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Expression</span>
extends java.io.Serializable</pre>
<div class="block">Represents a boolean expression tree.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<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>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Expression.Operation.html" title="enum in org.apache.iceberg.expressions">Expression.Operation</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<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>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEquivalentTo(org.apache.iceberg.expressions.Expression)">isEquivalentTo</a></span>&#8203;(<a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Returns whether this expression will accept the same values as another.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default <a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#negate()">negate</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the negation of this expression, equivalent to not(this).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="Expression.Operation.html" title="enum in org.apache.iceberg.expressions">Expression.Operation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#op()">op</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the operation for an expression node.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="op()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>op</h4>
<pre class="methodSignature"><a href="Expression.Operation.html" title="enum in org.apache.iceberg.expressions">Expression.Operation</a>&nbsp;op()</pre>
<div class="block">Returns the operation for an expression node.</div>
</li>
</ul>
<a id="negate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>negate</h4>
<pre class="methodSignature">default&nbsp;<a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;negate()</pre>
<div class="block">Returns the negation of this expression, equivalent to not(this).</div>
</li>
</ul>
<a id="isEquivalentTo(org.apache.iceberg.expressions.Expression)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isEquivalentTo</h4>
<pre class="methodSignature">default&nbsp;boolean&nbsp;isEquivalentTo&#8203;(<a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;other)</pre>
<div class="block">Returns whether this expression will accept the same values as another.
<p>If this returns true, the expressions are guaranteed to return the same evaluation for the
same input. However, if this returns false the expressions may return the same evaluation for
the same input. That is, expressions may be equivalent even if this returns false.
<p>For best results, rewrite not and bind expressions before calling this method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - another expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the expressions are equivalent</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>