| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Hook (Apache Calcite calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.runtime, enum: Hook"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":42,"i1":42,"i2":42,"i3":10,"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"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= 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 class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <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> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.runtime</a></div> |
| <h1 title="Enum Hook" class="title">Enum Hook</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Enum</a><<a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>> |
| <div class="inheritance">org.apache.calcite.runtime.Hook</div> |
| </div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>></code>, <code>java.lang.constant.Constable</code></dd> |
| </dl> |
| <hr> |
| <pre>public enum <span class="typeNameLabel">Hook</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a><<a href="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> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="nestedClassSummary"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h2>Nested Class Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <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> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Removes a Hook after use.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="inheritedList"> |
| <h2>Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a></h2> |
| <a id="nested.classes.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.EnumDesc.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum.EnumDesc</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.EnumDesc.html?is-external=true" title="class or interface in java.lang" class="externalLink">E</a> extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.EnumDesc.html?is-external=true" title="class or interface in java.lang" class="externalLink">E</a>>></code></div> |
| </section> |
| </li> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="constantsSummary"><a id="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h2>Enum Constant Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Enum Constant</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#CONVERTED">CONVERTED</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called with the output of sql-to-rel-converter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#CREATE_MATERIALIZATION">CREATE_MATERIALIZATION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called when materialization is created.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#CURRENT_TIME">CURRENT_TIME</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called to get the current time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ENABLE_BINDABLE">ENABLE_BINDABLE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Returns a boolean value, whether the return convention should be |
| <a href="../interpreter/BindableConvention.html" title="enum in org.apache.calcite.interpreter"><code>BindableConvention</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#EXPRESSION_REDUCER">EXPRESSION_REDUCER</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called when a constant expression is being reduced.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#JAVA_PLAN">JAVA_PLAN</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called with the generated Java plan, just before it is compiled by |
| Janino.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PARSE_TREE">PARSE_TREE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called with the SQL string and parse tree, in an array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PLAN_BEFORE_IMPLEMENTATION">PLAN_BEFORE_IMPLEMENTATION</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called when a plan is about to be implemented (e.g.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PLANNER">PLANNER</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called with the created planner.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PROGRAM">PROGRAM</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called to create a Program to optimize the statement.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#QUERY_PLAN">QUERY_PLAN</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called with a query that has been generated to send to a back-end system.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#REL_BUILDER_SIMPLIFY">REL_BUILDER_SIMPLIFY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Returns a boolean value, whether RelBuilder should simplify expressions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#STANDARD_STREAMS">STANDARD_STREAMS</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called to get stdin, stdout, stderr.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#STRING_TO_QUERY">STRING_TO_QUERY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Converts a SQL string to a |
| <a href="../jdbc/CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc"><code>CalcitePrepare.Query</code></a> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SUB">SUB</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called by the planner after substituting a materialization.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#TRIMMED">TRIMMED</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Called after de-correlation and field trimming, but before |
| optimization.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <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> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code><T> <a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.util.function.Consumer)">add</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><T> handler)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">this installs a global hook (cross-thread), so it might have greater impact |
| than expected.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><T,​ |
| R> <a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.util.function.Function)">add</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a><T,​R> handler)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#add(java.util.function.Consumer)"><code>add(Consumer)</code></a>.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><T,​ |
| R> <a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addThread(com.google.common.base.Function)">addThread</a></span>​(com.google.common.base.Function<T,​R> handler)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#addThread(java.util.function.Consumer)"><code>addThread(Consumer)</code></a>.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><T> <a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addThread(java.util.function.Consumer)">addThread</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><T> handler)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a handler for this thread.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code><V> V</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(V)">get</a></span>​(V defaultValue)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the value of a property hook.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>static <V> com.google.common.base.Function<<a href="../util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang" class="externalLink">Void</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#property(V)">property</a></span>​(V v)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#propertyJ(V)"><code>propertyJ(V)</code></a>.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>static <V> <a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><<a href="../util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#propertyJ(V)">propertyJ</a></span>​(V v)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a function that, when a hook is called, will "return" a given |
| value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#run(java.lang.Object)">run</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> arg)</code></th> |
| <td class="colLast"> |
| <div class="block">Runs all handlers registered for this Hook, with the given argument.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>static <a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>static <a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang" class="externalLink">Enum</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang" class="externalLink">compareTo</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#describeConstable()" title="class or interface in java.lang" class="externalLink">describeConstable</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang" class="externalLink">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang" class="externalLink">name</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang" class="externalLink">ordinal</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="externalLink">valueOf</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <li class="blockList"> |
| <section class="constantDetails"><a id="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h2>Enum Constant Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="CURRENT_TIME">CURRENT_TIME</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">CURRENT_TIME</span></div> |
| <div class="block">Called to get the current time. Use this to return a predictable time |
| in tests.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="STANDARD_STREAMS">STANDARD_STREAMS</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">STANDARD_STREAMS</span></div> |
| <div class="block">Called to get stdin, stdout, stderr. |
| Use this to re-assign streams in tests.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="REL_BUILDER_SIMPLIFY">REL_BUILDER_SIMPLIFY</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">REL_BUILDER_SIMPLIFY</span></div> |
| <div class="block">Returns a boolean value, whether RelBuilder should simplify expressions. |
| Default true.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="ENABLE_BINDABLE">ENABLE_BINDABLE</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">ENABLE_BINDABLE</span></div> |
| <div class="block">Returns a boolean value, whether the return convention should be |
| <a href="../interpreter/BindableConvention.html" title="enum in org.apache.calcite.interpreter"><code>BindableConvention</code></a>. |
| Default false.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="PARSE_TREE">PARSE_TREE</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">PARSE_TREE</span></div> |
| <div class="block">Called with the SQL string and parse tree, in an array.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="STRING_TO_QUERY">STRING_TO_QUERY</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">STRING_TO_QUERY</span></div> |
| <div class="block">Converts a SQL string to a |
| <a href="../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="../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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="JAVA_PLAN">JAVA_PLAN</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">JAVA_PLAN</span></div> |
| <div class="block">Called with the generated Java plan, just before it is compiled by |
| Janino.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="CONVERTED">CONVERTED</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">CONVERTED</span></div> |
| <div class="block">Called with the output of sql-to-rel-converter.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="PLANNER">PLANNER</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">PLANNER</span></div> |
| <div class="block">Called with the created planner.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="TRIMMED">TRIMMED</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">TRIMMED</span></div> |
| <div class="block">Called after de-correlation and field trimming, but before |
| optimization.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="SUB">SUB</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">SUB</span></div> |
| <div class="block">Called by the planner after substituting a materialization.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="EXPRESSION_REDUCER">EXPRESSION_REDUCER</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">EXPRESSION_REDUCER</span></div> |
| <div class="block">Called when a constant expression is being reduced.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="PROGRAM">PROGRAM</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">PROGRAM</span></div> |
| <div class="block">Called to create a Program to optimize the statement.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="CREATE_MATERIALIZATION">CREATE_MATERIALIZATION</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">CREATE_MATERIALIZATION</span></div> |
| <div class="block">Called when materialization is created.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="QUERY_PLAN">QUERY_PLAN</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">QUERY_PLAN</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="PLAN_BEFORE_IMPLEMENTATION">PLAN_BEFORE_IMPLEMENTATION</a></h3> |
| <div class="memberSignature"><span class="annotations">@API(since="1.22", |
| status=EXPERIMENTAL) |
| </span><span class="modifiers">public static final</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">PLAN_BEFORE_IMPLEMENTATION</span></div> |
| <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="../rel/RelRoot.html" title="class in org.apache.calcite.rel"><code>RelRoot</code></a> as an argument.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="values()">values</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a>[]</span> <span class="memberName">values</span>()</div> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="valueOf(java.lang.String)">valueOf</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="Hook.html" title="enum in org.apache.calcite.runtime">Hook</a></span> <span class="memberName">valueOf</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</span></div> |
| <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/9/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="add(java.util.function.Consumer)">add</a></h3> |
| <div class="memberSignature"><span class="annotations">@API(status=MAINTAINED) |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="typeParameters"><T></span> <span class="returnType"><a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span> <span class="memberName">add</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><T> handler)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">this installs a global hook (cross-thread), so it might have greater impact |
| than expected. Use with caution. Prefer thread-local hooks.</div> |
| </div> |
| <div class="block">Adds a handler for this Hook. |
| |
| <p>Returns a <a href="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="#addThread(java.util.function.Consumer)"><code>addThread(Consumer)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="add(java.util.function.Function)">add</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="typeParameters"><T,​ |
| R></span> <span class="returnType"><a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span> <span class="memberName">add</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a><T,​R> handler)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#add(java.util.function.Consumer)"><code>add(Consumer)</code></a>.</div> |
| </div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addThread(java.util.function.Consumer)">addThread</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="typeParameters"><T></span> <span class="returnType"><a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span> <span class="memberName">addThread</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><T> handler)</span></div> |
| <div class="block">Adds a handler for this thread.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addThread(com.google.common.base.Function)">addThread</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="typeParameters"><T,​ |
| R></span> <span class="returnType"><a href="Hook.Closeable.html" title="interface in org.apache.calcite.runtime">Hook.Closeable</a></span> <span class="memberName">addThread</span>​(<span class="arguments">com.google.common.base.Function<T,​R> handler)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#addThread(java.util.function.Consumer)"><code>addThread(Consumer)</code></a>.</div> |
| </div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="property(java.lang.Object)"> |
| <!-- --> |
| </a><a id="property(V)">property</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="typeParameters"><V></span> |
| <span class="returnType">com.google.common.base.Function<<a href="../util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang" class="externalLink">Void</a>></span> <span class="memberName">property</span>​(<span class="arguments">V v)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#propertyJ(V)"><code>propertyJ(V)</code></a>.</div> |
| </div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="propertyJ(java.lang.Object)"> |
| <!-- --> |
| </a><a id="propertyJ(V)">propertyJ</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><V></span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><<a href="../util/Holder.html" title="class in org.apache.calcite.util">Holder</a><V>></span> <span class="memberName">propertyJ</span>​(<span class="arguments">V v)</span></div> |
| <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="../util/Holder.html" title="class in org.apache.calcite.util"><code>Holder</code></a>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="run(java.lang.Object)">run</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">run</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> arg)</span></div> |
| <div class="block">Runs all handlers registered for this Hook, with the given argument.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="get(java.lang.Object)"> |
| <!-- --> |
| </a><a id="get(V)">get</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="typeParameters"><V></span> <span class="returnType">V</span> <span class="memberName">get</span>​(<span class="arguments">V defaultValue)</span></div> |
| <div class="block">Returns the value of a property hook. |
| (Property hooks take a <a href="../util/Holder.html" title="class in org.apache.calcite.util"><code>Holder</code></a> as an argument.)</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <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 class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <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> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
