blob: d339655162962bf265cb722163873a0343e8f10b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ExpressionVisitors</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="ExpressionVisitors";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="Class ExpressionVisitors" class="title">Class ExpressionVisitors</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.expressions.ExpressionVisitors</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">ExpressionVisitors</span>
extends java.lang.Object</pre>
<div class="block">Utils for traversing <a href="Expression.html" title="interface in org.apache.iceberg.expressions"><code>expressions</code></a>.</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">Class</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="ExpressionVisitors.BoundExpressionVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.BoundExpressionVisitor</a>&lt;<a href="ExpressionVisitors.BoundExpressionVisitor.html" title="type parameter in ExpressionVisitors.BoundExpressionVisitor">R</a>&gt;</span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ExpressionVisitors.BoundVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.BoundVisitor</a>&lt;<a href="ExpressionVisitors.BoundVisitor.html" title="type parameter in ExpressionVisitors.BoundVisitor">R</a>&gt;</span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ExpressionVisitors.CustomOrderExpressionVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.CustomOrderExpressionVisitor</a>&lt;<a href="ExpressionVisitors.CustomOrderExpressionVisitor.html" title="type parameter in ExpressionVisitors.CustomOrderExpressionVisitor">R</a>&gt;</span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ExpressionVisitors.ExpressionVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.ExpressionVisitor</a>&lt;<a href="ExpressionVisitors.ExpressionVisitor.html" title="type parameter in ExpressionVisitors.ExpressionVisitor">R</a>&gt;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static &lt;R&gt;&nbsp;R</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#visit(org.apache.iceberg.expressions.Expression,org.apache.iceberg.expressions.ExpressionVisitors.CustomOrderExpressionVisitor)">visit</a></span>&#8203;(<a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;expr,
<a href="ExpressionVisitors.CustomOrderExpressionVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.CustomOrderExpressionVisitor</a>&lt;R&gt;&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Traverses the given <a href="Expression.html" title="interface in org.apache.iceberg.expressions"><code>expression</code></a> with a <a href="ExpressionVisitors.CustomOrderExpressionVisitor.html" title="class in org.apache.iceberg.expressions"><code>visitor</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;R&gt;&nbsp;R</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#visit(org.apache.iceberg.expressions.Expression,org.apache.iceberg.expressions.ExpressionVisitors.ExpressionVisitor)">visit</a></span>&#8203;(<a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;expr,
<a href="ExpressionVisitors.ExpressionVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.ExpressionVisitor</a>&lt;R&gt;&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Traverses the given <a href="Expression.html" title="interface in org.apache.iceberg.expressions"><code>expression</code></a> with a <a href="ExpressionVisitors.ExpressionVisitor.html" title="class in org.apache.iceberg.expressions"><code>visitor</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#visitEvaluator(org.apache.iceberg.expressions.Expression,org.apache.iceberg.expressions.ExpressionVisitors.ExpressionVisitor)">visitEvaluator</a></span>&#8203;(<a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;expr,
<a href="ExpressionVisitors.ExpressionVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.ExpressionVisitor</a>&lt;java.lang.Boolean&gt;&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Traverses the given <a href="Expression.html" title="interface in org.apache.iceberg.expressions"><code>expression</code></a> with a <a href="ExpressionVisitors.ExpressionVisitor.html" title="class in org.apache.iceberg.expressions"><code>visitor</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</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="visit(org.apache.iceberg.expressions.Expression,org.apache.iceberg.expressions.ExpressionVisitors.ExpressionVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visit</h4>
<pre class="methodSignature">public static&nbsp;&lt;R&gt;&nbsp;R&nbsp;visit&#8203;(<a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;expr,
<a href="ExpressionVisitors.ExpressionVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.ExpressionVisitor</a>&lt;R&gt;&nbsp;visitor)</pre>
<div class="block">Traverses the given <a href="Expression.html" title="interface in org.apache.iceberg.expressions"><code>expression</code></a> with a <a href="ExpressionVisitors.ExpressionVisitor.html" title="class in org.apache.iceberg.expressions"><code>visitor</code></a>.
<p>The visitor will be called to handle each node in the expression tree in postfix order.
Result values produced by child nodes are passed when parent nodes are handled.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>R</code> - the return type produced by the expression visitor</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expr</code> - an expression to traverse</dd>
<dd><code>visitor</code> - a visitor that will be called to handle each node in the expression tree</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value returned by the visitor for the root expression node</dd>
</dl>
</li>
</ul>
<a id="visitEvaluator(org.apache.iceberg.expressions.Expression,org.apache.iceberg.expressions.ExpressionVisitors.ExpressionVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>visitEvaluator</h4>
<pre class="methodSignature">public static&nbsp;java.lang.Boolean&nbsp;visitEvaluator&#8203;(<a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;expr,
<a href="ExpressionVisitors.ExpressionVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.ExpressionVisitor</a>&lt;java.lang.Boolean&gt;&nbsp;visitor)</pre>
<div class="block">Traverses the given <a href="Expression.html" title="interface in org.apache.iceberg.expressions"><code>expression</code></a> with a <a href="ExpressionVisitors.ExpressionVisitor.html" title="class in org.apache.iceberg.expressions"><code>visitor</code></a>.
<p>The visitor will be called to handle only nodes required for determining result in the
expression tree in postfix order. Result values produced by child nodes are passed when parent
nodes are handled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expr</code> - an expression to traverse</dd>
<dd><code>visitor</code> - a visitor that will be called to handle each node in the expression tree</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value returned by the visitor for the root expression node</dd>
</dl>
</li>
</ul>
<a id="visit(org.apache.iceberg.expressions.Expression,org.apache.iceberg.expressions.ExpressionVisitors.CustomOrderExpressionVisitor)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>visit</h4>
<pre class="methodSignature">public static&nbsp;&lt;R&gt;&nbsp;R&nbsp;visit&#8203;(<a href="Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;expr,
<a href="ExpressionVisitors.CustomOrderExpressionVisitor.html" title="class in org.apache.iceberg.expressions">ExpressionVisitors.CustomOrderExpressionVisitor</a>&lt;R&gt;&nbsp;visitor)</pre>
<div class="block">Traverses the given <a href="Expression.html" title="interface in org.apache.iceberg.expressions"><code>expression</code></a> with a <a href="ExpressionVisitors.CustomOrderExpressionVisitor.html" title="class in org.apache.iceberg.expressions"><code>visitor</code></a>.
<p>This passes a <code>Supplier</code> to each non-leaf <a href="ExpressionVisitors.CustomOrderExpressionVisitor.html" title="class in org.apache.iceberg.expressions"><code>visitor</code></a>
method. The supplier returns the result of traversing child expressions. Getting the result of
the supplier allows traversing the expression in the desired order.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>R</code> - the return type produced by the expression visitor</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>expr</code> - an expression to traverse</dd>
<dd><code>visitor</code> - a visitor that will be called to handle each node in the expression tree</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the value returned by the visitor for the root expression node</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>