| <!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 (1.8.0_201) on Mon Nov 16 15:41:48 PST 2020 --> |
| <title>Transform</title> |
| <meta name="date" content="2020-11-16"> |
| <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="Transform"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":18,"i4":6,"i5":6,"i6":18}; |
| 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"; |
| </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/transforms/PartitionSpecVisitor.html" title="interface in org.apache.iceberg.transforms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/transforms/Transforms.html" title="class in org.apache.iceberg.transforms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/transforms/Transform.html" target="_top">Frames</a></li> |
| <li><a href="Transform.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.transforms</div> |
| <h2 title="Interface Transform" class="title">Interface Transform<S,T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - Java class of source values</dd> |
| <dd><code>T</code> - Java class of transformed values</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/iceberg/transforms/UnknownTransform.html" title="class in org.apache.iceberg.transforms">UnknownTransform</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Transform<S,T></span> |
| extends java.io.Serializable</pre> |
| <div class="block">A transform function used for partitioning. |
| <p> |
| Implementations of this interface can be used to transform values, check or types, and project |
| <a href="../../../../org/apache/iceberg/expressions/BoundPredicate.html" title="class in org.apache.iceberg.expressions"><code>predicates</code></a> to predicates on partition values.</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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><a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/transforms/Transform.html#apply-S-">apply</a></span>(<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">S</a> value)</code> |
| <div class="block">Transforms a value to its corresponding partition value.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/transforms/Transform.html#canTransform-org.apache.iceberg.types.Type-">canTransform</a></span>(<a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a> type)</code> |
| <div class="block">Checks whether this function can be applied to the given <a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/transforms/Transform.html#getResultType-org.apache.iceberg.types.Type-">getResultType</a></span>(<a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a> sourceType)</code> |
| <div class="block">Returns the <a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a> produced by this transform given a source type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/transforms/Transform.html#isIdentity--">isIdentity</a></span>()</code> |
| <div class="block">Return whether this transform is the identity transform.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/expressions/UnboundPredicate.html" title="class in org.apache.iceberg.expressions">UnboundPredicate</a><<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/transforms/Transform.html#project-java.lang.String-org.apache.iceberg.expressions.BoundPredicate-">project</a></span>(java.lang.String name, |
| <a href="../../../../org/apache/iceberg/expressions/BoundPredicate.html" title="class in org.apache.iceberg.expressions">BoundPredicate</a><<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">S</a>> predicate)</code> |
| <div class="block">Transforms a <a href="../../../../org/apache/iceberg/expressions/BoundPredicate.html" title="class in org.apache.iceberg.expressions"><code>predicate</code></a> to an inclusive predicate on the partition |
| values produced by <a href="../../../../org/apache/iceberg/transforms/Transform.html#apply-S-"><code>apply(Object)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/iceberg/expressions/UnboundPredicate.html" title="class in org.apache.iceberg.expressions">UnboundPredicate</a><<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/transforms/Transform.html#projectStrict-java.lang.String-org.apache.iceberg.expressions.BoundPredicate-">projectStrict</a></span>(java.lang.String name, |
| <a href="../../../../org/apache/iceberg/expressions/BoundPredicate.html" title="class in org.apache.iceberg.expressions">BoundPredicate</a><<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">S</a>> predicate)</code> |
| <div class="block">Transforms a <a href="../../../../org/apache/iceberg/expressions/BoundPredicate.html" title="class in org.apache.iceberg.expressions"><code>predicate</code></a> to a strict predicate on the partition values |
| produced by <a href="../../../../org/apache/iceberg/transforms/Transform.html#apply-S-"><code>apply(Object)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>default java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/transforms/Transform.html#toHumanString-T-">toHumanString</a></span>(<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">T</a> value)</code> |
| <div class="block">Returns a human-readable String representation of a transformed value.</div> |
| </td> |
| </tr> |
| </table> |
| </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="apply-java.lang.Object-"> |
| <!-- --> |
| </a><a name="apply-S-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre><a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">T</a> apply(<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">S</a> value)</pre> |
| <div class="block">Transforms a value to its corresponding partition value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - a source value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a transformed partition value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canTransform-org.apache.iceberg.types.Type-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canTransform</h4> |
| <pre>boolean canTransform(<a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a> type)</pre> |
| <div class="block">Checks whether this function can be applied to the given <a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - a type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this transform can be applied to the type, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResultType-org.apache.iceberg.types.Type-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultType</h4> |
| <pre><a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a> getResultType(<a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types">Type</a> sourceType)</pre> |
| <div class="block">Returns the <a href="../../../../org/apache/iceberg/types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a> produced by this transform given a source type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sourceType</code> - a type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result type created by the apply method for the given type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="project-java.lang.String-org.apache.iceberg.expressions.BoundPredicate-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>project</h4> |
| <pre><a href="../../../../org/apache/iceberg/expressions/UnboundPredicate.html" title="class in org.apache.iceberg.expressions">UnboundPredicate</a><<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">T</a>> project(java.lang.String name, |
| <a href="../../../../org/apache/iceberg/expressions/BoundPredicate.html" title="class in org.apache.iceberg.expressions">BoundPredicate</a><<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">S</a>> predicate)</pre> |
| <div class="block">Transforms a <a href="../../../../org/apache/iceberg/expressions/BoundPredicate.html" title="class in org.apache.iceberg.expressions"><code>predicate</code></a> to an inclusive predicate on the partition |
| values produced by <a href="../../../../org/apache/iceberg/transforms/Transform.html#apply-S-"><code>apply(Object)</code></a>. |
| <p> |
| This inclusive transform guarantees that if pred(v) is true, then projected(apply(v)) is true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the field name for partition values</dd> |
| <dd><code>predicate</code> - a predicate for source values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an inclusive predicate on partition values</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="projectStrict-java.lang.String-org.apache.iceberg.expressions.BoundPredicate-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>projectStrict</h4> |
| <pre><a href="../../../../org/apache/iceberg/expressions/UnboundPredicate.html" title="class in org.apache.iceberg.expressions">UnboundPredicate</a><<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">T</a>> projectStrict(java.lang.String name, |
| <a href="../../../../org/apache/iceberg/expressions/BoundPredicate.html" title="class in org.apache.iceberg.expressions">BoundPredicate</a><<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">S</a>> predicate)</pre> |
| <div class="block">Transforms a <a href="../../../../org/apache/iceberg/expressions/BoundPredicate.html" title="class in org.apache.iceberg.expressions"><code>predicate</code></a> to a strict predicate on the partition values |
| produced by <a href="../../../../org/apache/iceberg/transforms/Transform.html#apply-S-"><code>apply(Object)</code></a>. |
| <p> |
| This strict transform guarantees that if strict(apply(v)) is true, then pred(v) is also true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the field name for partition values</dd> |
| <dd><code>predicate</code> - a predicate for source values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an inclusive predicate on partition values</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isIdentity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIdentity</h4> |
| <pre>default boolean isIdentity()</pre> |
| <div class="block">Return whether this transform is the identity transform.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this is an identity transform, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toHumanString-java.lang.Object-"> |
| <!-- --> |
| </a><a name="toHumanString-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toHumanString</h4> |
| <pre>default java.lang.String toHumanString(<a href="../../../../org/apache/iceberg/transforms/Transform.html" title="type parameter in Transform">T</a> value)</pre> |
| <div class="block">Returns a human-readable String representation of a transformed value. |
| <p> |
| null values will return "null"</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - a transformed value</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a human-readable String representation of the value</dd> |
| </dl> |
| </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/transforms/PartitionSpecVisitor.html" title="interface in org.apache.iceberg.transforms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/iceberg/transforms/Transforms.html" title="class in org.apache.iceberg.transforms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/iceberg/transforms/Transform.html" target="_top">Frames</a></li> |
| <li><a href="Transform.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> |
