| <!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>InitializerExpressionFactory (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="InitializerExpressionFactory (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":38,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/sql2rel/InitializerContext.html" title="interface in org.apache.calcite.sql2rel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/sql2rel/NullInitializerExpressionFactory.html" title="class in org.apache.calcite.sql2rel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/sql2rel/InitializerExpressionFactory.html" target="_top">Frames</a></li> |
| <li><a href="InitializerExpressionFactory.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.calcite.sql2rel</div> |
| <h2 title="Interface InitializerExpressionFactory" class="title">Interface InitializerExpressionFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/calcite/sql2rel/NullInitializerExpressionFactory.html" title="class in org.apache.calcite.sql2rel">NullInitializerExpressionFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">InitializerExpressionFactory</span></pre> |
| <div class="block">InitializerExpressionFactory supplies default values for INSERT, UPDATE, and NEW.</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="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><a href="../../../../org/apache/calcite/schema/ColumnStrategy.html" title="enum in org.apache.calcite.schema">ColumnStrategy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/InitializerExpressionFactory.html#generationStrategy-org.apache.calcite.plan.RelOptTable-int-">generationStrategy</a></span>(<a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn)</code> |
| <div class="block">Returns how a column is populated.</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/calcite/sql2rel/InitializerExpressionFactory.html#isGeneratedAlways-org.apache.calcite.plan.RelOptTable-int-">isGeneratedAlways</a></span>(<a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <code>c.generationStrategy(t, i) == VIRTUAL |
| || c.generationStrategy(t, i) == STORED</code></span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/InitializerExpressionFactory.html#newAttributeInitializer-org.apache.calcite.rel.type.RelDataType-org.apache.calcite.sql.SqlFunction-int-java.util.List-org.apache.calcite.sql2rel.InitializerContext-">newAttributeInitializer</a></span>(<a href="../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type, |
| <a href="../../../../org/apache/calcite/sql/SqlFunction.html" title="class in org.apache.calcite.sql">SqlFunction</a> constructor, |
| int iAttribute, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/calcite/rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> constructorArgs, |
| <a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a> context)</code> |
| <div class="block">Creates an expression which evaluates to the initializer expression for a |
| particular attribute of a structured type.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/InitializerExpressionFactory.html#newColumnDefaultValue-org.apache.calcite.plan.RelOptTable-int-org.apache.calcite.sql2rel.InitializerContext-">newColumnDefaultValue</a></span>(<a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn, |
| <a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a> context)</code> |
| <div class="block">Creates an expression which evaluates to the default value for a |
| particular column.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiFunction.html?is-external=true" title="class or interface in java.util.function">BiFunction</a><<a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a>,<a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql2rel/InitializerExpressionFactory.html#postExpressionConversionHook--">postExpressionConversionHook</a></span>()</code> |
| <div class="block">Creates a hook function to customize the relational expression right after the column |
| expressions are converted.</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="isGeneratedAlways-org.apache.calcite.plan.RelOptTable-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isGeneratedAlways</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> |
| boolean isGeneratedAlways(<a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <code>c.generationStrategy(t, i) == VIRTUAL |
| || c.generationStrategy(t, i) == STORED</code></span></div> |
| <div class="block">Whether a column is always generated. If a column is always generated, |
| then non-generated values cannot be inserted into the column.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/calcite/sql2rel/InitializerExpressionFactory.html#generationStrategy-org.apache.calcite.plan.RelOptTable-int-"><code>generationStrategy(RelOptTable, int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="generationStrategy-org.apache.calcite.plan.RelOptTable-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generationStrategy</h4> |
| <pre><a href="../../../../org/apache/calcite/schema/ColumnStrategy.html" title="enum in org.apache.calcite.schema">ColumnStrategy</a> generationStrategy(<a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn)</pre> |
| <div class="block">Returns how a column is populated.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>table</code> - the table containing the column</dd> |
| <dd><code>iColumn</code> - the 0-based offset of the column in the table</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>generation strategy, never null</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/calcite/plan/RelOptTable.html#getColumnStrategies--"><code>RelOptTable.getColumnStrategies()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newColumnDefaultValue-org.apache.calcite.plan.RelOptTable-int-org.apache.calcite.sql2rel.InitializerContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newColumnDefaultValue</h4> |
| <pre><a href="../../../../org/apache/calcite/rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> newColumnDefaultValue(<a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| int iColumn, |
| <a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a> context)</pre> |
| <div class="block">Creates an expression which evaluates to the default value for a |
| particular column. |
| |
| <p>If the default value comes from a un-validated <a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a>, |
| make sure to invoke <a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html#validateExpression-org.apache.calcite.rel.type.RelDataType-org.apache.calcite.sql.SqlNode-"><code>InitializerContext.validateExpression(org.apache.calcite.rel.type.RelDataType, org.apache.calcite.sql.SqlNode)</code></a> first before you actually |
| do the conversion with method <a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html#convertExpression-org.apache.calcite.sql.SqlNode-"><code>InitializerContext.convertExpression(org.apache.calcite.sql.SqlNode)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>table</code> - the table containing the column</dd> |
| <dd><code>iColumn</code> - the 0-based offset of the column in the table</dd> |
| <dd><code>context</code> - Context for creating the expression</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>default value expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="postExpressionConversionHook--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>postExpressionConversionHook</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiFunction.html?is-external=true" title="class or interface in java.util.function">BiFunction</a><<a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a>,<a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> postExpressionConversionHook()</pre> |
| <div class="block">Creates a hook function to customize the relational expression right after the column |
| expressions are converted. Usually the relational expression is a projection |
| above a table scan.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a hook function to transform the relational expression |
| right after the column expression conversion to a customized one</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/calcite/sql2rel/InitializerExpressionFactory.html#newColumnDefaultValue-org.apache.calcite.plan.RelOptTable-int-org.apache.calcite.sql2rel.InitializerContext-"><code>newColumnDefaultValue(RelOptTable, int, InitializerContext)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newAttributeInitializer-org.apache.calcite.rel.type.RelDataType-org.apache.calcite.sql.SqlFunction-int-java.util.List-org.apache.calcite.sql2rel.InitializerContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newAttributeInitializer</h4> |
| <pre><a href="../../../../org/apache/calcite/rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> newAttributeInitializer(<a href="../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type, |
| <a href="../../../../org/apache/calcite/sql/SqlFunction.html" title="class in org.apache.calcite.sql">SqlFunction</a> constructor, |
| int iAttribute, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/calcite/rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> constructorArgs, |
| <a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a> context)</pre> |
| <div class="block">Creates an expression which evaluates to the initializer expression for a |
| particular attribute of a structured type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the structured type</dd> |
| <dd><code>constructor</code> - the constructor invoked to initialize the type</dd> |
| <dd><code>iAttribute</code> - the 0-based offset of the attribute in the type</dd> |
| <dd><code>constructorArgs</code> - arguments passed to the constructor invocation</dd> |
| <dd><code>context</code> - Context for creating the expression</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>default value expression</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 class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="interface in org.apache.calcite.sql2rel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/sql2rel/NullInitializerExpressionFactory.html" title="class in org.apache.calcite.sql2rel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/sql2rel/InitializerExpressionFactory.html" target="_top">Frames</a></li> |
| <li><a href="InitializerExpressionFactory.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |
