| <!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 --> |
| <title>ExpressionUtil</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="ExpressionUtil"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":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"; |
| </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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/iceberg/expressions/Expressions.html" title="class in org.apache.iceberg.expressions"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/expressions/ExpressionVisitors.html" title="class in org.apache.iceberg.expressions"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/expressions/ExpressionUtil.html" target="_top">Frames</a></li> |
| <li><a href="ExpressionUtil.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.iceberg.expressions</div> |
| <h2 title="Class ExpressionUtil" class="title">Class ExpressionUtil</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.expressions.ExpressionUtil</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ExpressionUtil</span> |
| extends java.lang.Object</pre> |
| <div class="block">Expression utility methods.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/expressions/ExpressionUtil.html#describe-org.apache.iceberg.expressions.Term-">describe</a></span>(<a href="../../../../org/apache/iceberg/expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a> term)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/expressions/ExpressionUtil.html#equivalent-org.apache.iceberg.expressions.Expression-org.apache.iceberg.expressions.Expression-org.apache.iceberg.types.Types.StructType-boolean-">equivalent</a></span>(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> left, |
| <a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> right, |
| <a href="../../../../org/apache/iceberg/types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> struct, |
| boolean caseSensitive)</code> |
| <div class="block">Returns whether two unbound expressions will accept the same inputs.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/expressions/ExpressionUtil.html#extractByIdInclusive-org.apache.iceberg.expressions.Expression-org.apache.iceberg.Schema-boolean-int...-">extractByIdInclusive</a></span>(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expression, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| boolean caseSensitive, |
| int... ids)</code> |
| <div class="block">Extracts an expression that references only the given column IDs from the given expression.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/expressions/ExpressionUtil.html#sanitize-org.apache.iceberg.expressions.Expression-">sanitize</a></span>(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr)</code> |
| <div class="block">Produces an unbound <a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions"><code>Expression</code></a> with the same structure, but with data values replaced |
| by descriptions.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/expressions/ExpressionUtil.html#selectsPartitions-org.apache.iceberg.expressions.Expression-org.apache.iceberg.PartitionSpec-boolean-">selectsPartitions</a></span>(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| boolean caseSensitive)</code> |
| <div class="block">Returns whether an expression selects whole partitions for a partition spec.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/expressions/ExpressionUtil.html#selectsPartitions-org.apache.iceberg.expressions.Expression-org.apache.iceberg.Table-boolean-">selectsPartitions</a></span>(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr, |
| <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> table, |
| boolean caseSensitive)</code> |
| <div class="block">Returns whether an expression selects whole partitions for all partition specs in a table.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/expressions/ExpressionUtil.html#toSanitizedString-org.apache.iceberg.expressions.Expression-">toSanitizedString</a></span>(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr)</code> |
| <div class="block">Produces a sanitized expression string with the same structure, but with data values replaced |
| by descriptions.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="sanitize-org.apache.iceberg.expressions.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sanitize</h4> |
| <pre>public static <a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> sanitize(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr)</pre> |
| <div class="block">Produces an unbound <a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions"><code>Expression</code></a> with the same structure, but with data values replaced |
| by descriptions. |
| |
| <p>Numbers are replaced with magnitude and type, string-like values are replaced by hashes, and |
| date/time values are replaced by the type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expr</code> - an Expression to sanitize</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a sanitized Expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toSanitizedString-org.apache.iceberg.expressions.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toSanitizedString</h4> |
| <pre>public static java.lang.String toSanitizedString(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr)</pre> |
| <div class="block">Produces a sanitized expression string with the same structure, but with data values replaced |
| by descriptions. |
| |
| <p>Numbers are replaced with magnitude and type, string-like values are replaced by hashes, and |
| date/time values are replaced by the type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expr</code> - an Expression to sanitize</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a sanitized expression string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="extractByIdInclusive-org.apache.iceberg.expressions.Expression-org.apache.iceberg.Schema-boolean-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extractByIdInclusive</h4> |
| <pre>public static <a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> extractByIdInclusive(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expression, |
| <a href="../../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema, |
| boolean caseSensitive, |
| int... ids)</pre> |
| <div class="block">Extracts an expression that references only the given column IDs from the given expression. |
| |
| <p>The result is inclusive. If a row would match the original filter, it must match the result |
| filter.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expression</code> - a filter Expression</dd> |
| <dd><code>schema</code> - a Schema</dd> |
| <dd><code>caseSensitive</code> - whether binding is case sensitive</dd> |
| <dd><code>ids</code> - field IDs used to match predicates to extract from the expression</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Expression that selects at least the same rows as the original using only the IDs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equivalent-org.apache.iceberg.expressions.Expression-org.apache.iceberg.expressions.Expression-org.apache.iceberg.types.Types.StructType-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equivalent</h4> |
| <pre>public static boolean equivalent(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> left, |
| <a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> right, |
| <a href="../../../../org/apache/iceberg/types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> struct, |
| boolean caseSensitive)</pre> |
| <div class="block">Returns whether two unbound expressions will accept the same inputs. |
| |
| <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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>left</code> - an unbound expression</dd> |
| <dd><code>right</code> - an unbound expression</dd> |
| <dd><code>struct</code> - a struct type for binding</dd> |
| <dd><code>caseSensitive</code> - whether to bind expressions using case-sensitive matching</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the expressions are equivalent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="selectsPartitions-org.apache.iceberg.expressions.Expression-org.apache.iceberg.Table-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectsPartitions</h4> |
| <pre>public static boolean selectsPartitions(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr, |
| <a href="../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a> table, |
| boolean caseSensitive)</pre> |
| <div class="block">Returns whether an expression selects whole partitions for all partition specs in a table. |
| |
| <p>For example, ts < '2021-03-09T10:00:00.000' selects whole partitions in an hourly spec, |
| [hours(ts)], but does not select whole partitions in a daily spec, [days(ts)].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expr</code> - an unbound expression</dd> |
| <dd><code>table</code> - a table</dd> |
| <dd><code>caseSensitive</code> - whether expression binding should be case sensitive</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the expression will select whole partitions in all table specs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="selectsPartitions-org.apache.iceberg.expressions.Expression-org.apache.iceberg.PartitionSpec-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectsPartitions</h4> |
| <pre>public static boolean selectsPartitions(<a href="../../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr, |
| <a href="../../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a> spec, |
| boolean caseSensitive)</pre> |
| <div class="block">Returns whether an expression selects whole partitions for a partition spec. |
| |
| <p>For example, ts < '2021-03-09T10:00:00.000' selects whole partitions in an hourly spec, |
| [hours(ts)], but does not select whole partitions in a daily spec, [days(ts)].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expr</code> - an unbound expression</dd> |
| <dd><code>spec</code> - a partition spec</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the expression will select whole partitions in the given spec</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="describe-org.apache.iceberg.expressions.Term-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>describe</h4> |
| <pre>public static java.lang.String describe(<a href="../../../../org/apache/iceberg/expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a> term)</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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/iceberg/expressions/Expressions.html" title="class in org.apache.iceberg.expressions"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/expressions/ExpressionVisitors.html" title="class in org.apache.iceberg.expressions"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/expressions/ExpressionUtil.html" target="_top">Frames</a></li> |
| <li><a href="ExpressionUtil.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
