| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Hook (Apache Calcite calcite API)</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="Hook (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":42,"i1":42,"i2":10,"i3":42,"i4":10,"i5":41,"i6":9,"i7":10,"i8":9,"i9":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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 class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/runtime/GeoFunctions.Geom.html" title="interface in org.apache.calcite.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/runtime/Hook.html" target="_top">Frames</a></li> |
| <li><a href="Hook.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </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.calcite.runtime</div> |
| <h2 title="Enum Hook" class="title">Enum Hook</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.runtime.Hook</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public enum <span class="typeNameLabel">Hook</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>></pre> |
| <div class="block">Collection of hooks that can be set by observers and are executed at various |
| parts of the query preparation process. |
| |
| <p>For testing and debugging rather than for end-users.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span></code> |
| <div class="block">Removes a Hook after use.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Enum Constant and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#CONVERTED">CONVERTED</a></span></code> |
| <div class="block">Called with the output of sql-to-rel-converter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#CREATE_MATERIALIZATION">CREATE_MATERIALIZATION</a></span></code> |
| <div class="block">Called when materialization is created.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#CURRENT_TIME">CURRENT_TIME</a></span></code> |
| <div class="block">Called to get the current time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#ENABLE_BINDABLE">ENABLE_BINDABLE</a></span></code> |
| <div class="block">Returns a boolean value, whether the return convention should be |
| <a href="../../../../org/apache/calcite/interpreter/BindableConvention.html" title="enum in org.apache.calcite.interpreter"><code>BindableConvention</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#EXPRESSION_REDUCER">EXPRESSION_REDUCER</a></span></code> |
| <div class="block">Called when a constant expression is being reduced.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#JAVA_PLAN">JAVA_PLAN</a></span></code> |
| <div class="block">Called with the generated Java plan, just before it is compiled by |
| Janino.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#PARSE_TREE">PARSE_TREE</a></span></code> |
| <div class="block">Called with the SQL string and parse tree, in an array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#PLAN_BEFORE_IMPLEMENTATION">PLAN_BEFORE_IMPLEMENTATION</a></span></code> |
| <div class="block">Called when a plan is about to be implemented (e.g.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#PLANNER">PLANNER</a></span></code> |
| <div class="block">Called with the created planner.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#PROGRAM">PROGRAM</a></span></code> |
| <div class="block">Called to create a Program to optimize the statement.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#QUERY_PLAN">QUERY_PLAN</a></span></code> |
| <div class="block">Called with a query that has been generated to send to a back-end system.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#REL_BUILDER_SIMPLIFY">REL_BUILDER_SIMPLIFY</a></span></code> |
| <div class="block">Returns a boolean value, whether RelBuilder should simplify expressions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#STANDARD_STREAMS">STANDARD_STREAMS</a></span></code> |
| <div class="block">Called to get stdin, stdout, stderr.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#STRING_TO_QUERY">STRING_TO_QUERY</a></span></code> |
| <div class="block">Converts a SQL string to a |
| <a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc"><code>CalcitePrepare.Query</code></a> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#SUB">SUB</a></span></code> |
| <div class="block">Called by the planner after substituting a materialization.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#TRIMMED">TRIMMED</a></span></code> |
| <div class="block">Called after de-correlation and field trimming, but before |
| optimization.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><T> <a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#add-java.util.function.Consumer-">add</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><T> handler)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">this installs a global hook (cross-thread), so it might have greater impact |
| than expected. Use with caution. Prefer thread-local hooks.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><T,R> <a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#add-java.util.function.Function-">add</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><T,R> handler)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/calcite/runtime/Hook.html#add-java.util.function.Consumer-"><code>add(Consumer)</code></a>.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><T> <a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#addThread-java.util.function.Consumer-">addThread</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><T> handler)</code> |
| <div class="block">Adds a handler for this thread.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><T,R> <a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#addThread-com.google.common.base.Function-">addThread</a></span>(com.google.common.base.Function<T,R> handler)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/calcite/runtime/Hook.html#addThread-java.util.function.Consumer-"><code>addThread(Consumer)</code></a>.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><V> V</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#get-V-">get</a></span>(V defaultValue)</code> |
| <div class="block">Returns the value of a property hook.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <V> com.google.common.base.Function<<a href="../../../../org/apache/calcite/util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#property-V-">property</a></span>(V v)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/calcite/runtime/Hook.html#propertyJ-V-"><code>propertyJ(V)</code></a>.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <V> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><<a href="../../../../org/apache/calcite/util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#propertyJ-V-">propertyJ</a></span>(V v)</code> |
| <div class="block">Returns a function that, when a hook is called, will "return" a given |
| value.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#run-java.lang.Object-">run</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> arg)</code> |
| <div class="block">Runs all handlers registered for this Hook, with the given argument.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/runtime/Hook.html#values--">values</a></span>()</code> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a name="CURRENT_TIME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CURRENT_TIME</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> CURRENT_TIME</pre> |
| <div class="block">Called to get the current time. Use this to return a predictable time |
| in tests.</div> |
| </li> |
| </ul> |
| <a name="STANDARD_STREAMS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STANDARD_STREAMS</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> STANDARD_STREAMS</pre> |
| <div class="block">Called to get stdin, stdout, stderr. |
| Use this to re-assign streams in tests.</div> |
| </li> |
| </ul> |
| <a name="REL_BUILDER_SIMPLIFY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>REL_BUILDER_SIMPLIFY</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> REL_BUILDER_SIMPLIFY</pre> |
| <div class="block">Returns a boolean value, whether RelBuilder should simplify expressions. |
| Default true.</div> |
| </li> |
| </ul> |
| <a name="ENABLE_BINDABLE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ENABLE_BINDABLE</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> ENABLE_BINDABLE</pre> |
| <div class="block">Returns a boolean value, whether the return convention should be |
| <a href="../../../../org/apache/calcite/interpreter/BindableConvention.html" title="enum in org.apache.calcite.interpreter"><code>BindableConvention</code></a>. |
| Default false.</div> |
| </li> |
| </ul> |
| <a name="PARSE_TREE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PARSE_TREE</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> PARSE_TREE</pre> |
| <div class="block">Called with the SQL string and parse tree, in an array.</div> |
| </li> |
| </ul> |
| <a name="STRING_TO_QUERY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>STRING_TO_QUERY</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> STRING_TO_QUERY</pre> |
| <div class="block">Converts a SQL string to a |
| <a href="../../../../org/apache/calcite/jdbc/CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc"><code>CalcitePrepare.Query</code></a> object. This hook is |
| an opportunity to execute a <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> query |
| plan in the JDBC driver rather than the usual SQL string.</div> |
| </li> |
| </ul> |
| <a name="JAVA_PLAN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JAVA_PLAN</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> JAVA_PLAN</pre> |
| <div class="block">Called with the generated Java plan, just before it is compiled by |
| Janino.</div> |
| </li> |
| </ul> |
| <a name="CONVERTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONVERTED</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> CONVERTED</pre> |
| <div class="block">Called with the output of sql-to-rel-converter.</div> |
| </li> |
| </ul> |
| <a name="PLANNER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PLANNER</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> PLANNER</pre> |
| <div class="block">Called with the created planner.</div> |
| </li> |
| </ul> |
| <a name="TRIMMED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TRIMMED</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> TRIMMED</pre> |
| <div class="block">Called after de-correlation and field trimming, but before |
| optimization.</div> |
| </li> |
| </ul> |
| <a name="SUB"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SUB</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> SUB</pre> |
| <div class="block">Called by the planner after substituting a materialization.</div> |
| </li> |
| </ul> |
| <a name="EXPRESSION_REDUCER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EXPRESSION_REDUCER</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> EXPRESSION_REDUCER</pre> |
| <div class="block">Called when a constant expression is being reduced.</div> |
| </li> |
| </ul> |
| <a name="PROGRAM"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PROGRAM</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> PROGRAM</pre> |
| <div class="block">Called to create a Program to optimize the statement.</div> |
| </li> |
| </ul> |
| <a name="CREATE_MATERIALIZATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CREATE_MATERIALIZATION</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> CREATE_MATERIALIZATION</pre> |
| <div class="block">Called when materialization is created.</div> |
| </li> |
| </ul> |
| <a name="QUERY_PLAN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUERY_PLAN</h4> |
| <pre>public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> QUERY_PLAN</pre> |
| <div class="block">Called with a query that has been generated to send to a back-end system. |
| The query might be a SQL string (for the JDBC adapter), a list of Mongo |
| pipeline expressions (for the MongoDB adapter), et cetera.</div> |
| </li> |
| </ul> |
| <a name="PLAN_BEFORE_IMPLEMENTATION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PLAN_BEFORE_IMPLEMENTATION</h4> |
| <pre>@API(since="1.22", |
| status=EXPERIMENTAL) |
| public static final <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> PLAN_BEFORE_IMPLEMENTATION</pre> |
| <div class="block">Called when a plan is about to be implemented (e.g. implemented via Enumerable, Bindable, |
| and so on). |
| The hook supplies <a href="../../../../org/apache/calcite/rel/RelRoot.html" title="class in org.apache.calcite.rel"><code>RelRoot</code></a> as an argument.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="values--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>public static <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>[] values()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (Hook c : Hook.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueOf-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre>public static <a href="../../../../org/apache/calcite/runtime/Hook.html" title="enum in org.apache.calcite.runtime">Hook</a> valueOf(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="add-java.util.function.Consumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>@API(status=MAINTAINED) |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <T> <a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a> add(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><T> handler)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">this installs a global hook (cross-thread), so it might have greater impact |
| than expected. Use with caution. Prefer thread-local hooks.</span></div> |
| <div class="block">Adds a handler for this Hook. |
| |
| <p>Returns a <a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime"><code>Hook.Closeable</code></a> so that you can use the following |
| try-finally pattern to prevent leaks:</p> |
| |
| <blockquote><pre> |
| final Hook.Closeable closeable = Hook.FOO.add(HANDLER); |
| try { |
| ... |
| } finally { |
| closeable.close(); |
| }</pre> |
| </blockquote></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/calcite/runtime/Hook.html#addThread-java.util.function.Consumer-"><code>addThread(Consumer)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="add-java.util.function.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <T,R> <a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a> add(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><T,R> handler)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/calcite/runtime/Hook.html#add-java.util.function.Consumer-"><code>add(Consumer)</code></a>.</span></div> |
| </li> |
| </ul> |
| <a name="addThread-java.util.function.Consumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addThread</h4> |
| <pre>public <T> <a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a> addThread(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><T> handler)</pre> |
| <div class="block">Adds a handler for this thread.</div> |
| </li> |
| </ul> |
| <a name="addThread-com.google.common.base.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addThread</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <T,R> <a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a> addThread(com.google.common.base.Function<T,R> handler)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/calcite/runtime/Hook.html#addThread-java.util.function.Consumer-"><code>addThread(Consumer)</code></a>.</span></div> |
| </li> |
| </ul> |
| <a name="property-java.lang.Object-"> |
| <!-- --> |
| </a><a name="property-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>property</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public static <V> com.google.common.base.Function<<a href="../../../../org/apache/calcite/util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>> property(V v)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/calcite/runtime/Hook.html#propertyJ-V-"><code>propertyJ(V)</code></a>.</span></div> |
| </li> |
| </ul> |
| <a name="propertyJ-java.lang.Object-"> |
| <!-- --> |
| </a><a name="propertyJ-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>propertyJ</h4> |
| <pre>public static <V> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><<a href="../../../../org/apache/calcite/util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>> propertyJ(V v)</pre> |
| <div class="block">Returns a function that, when a hook is called, will "return" a given |
| value. (Because of the way hooks work, it "returns" the value by writing |
| into a <a href="../../../../org/apache/calcite/util/Holder.html" title="class in org.apache.calcite.util"><code>Holder</code></a>.</div> |
| </li> |
| </ul> |
| <a name="run-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>run</h4> |
| <pre>public void run(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> arg)</pre> |
| <div class="block">Runs all handlers registered for this Hook, with the given argument.</div> |
| </li> |
| </ul> |
| <a name="get-java.lang.Object-"> |
| <!-- --> |
| </a><a name="get-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <V> V get(V defaultValue)</pre> |
| <div class="block">Returns the value of a property hook. |
| (Property hooks take a <a href="../../../../org/apache/calcite/util/Holder.html" title="class in org.apache.calcite.util"><code>Holder</code></a> as an argument.)</div> |
| </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 class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/runtime/GeoFunctions.Geom.html" title="interface in org.apache.calcite.runtime"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/runtime/Hook.Closeable.html" title="interface in org.apache.calcite.runtime"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/runtime/Hook.html" target="_top">Frames</a></li> |
| <li><a href="Hook.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |
