blob: fe6f1d7958e2d39d64dd2f4af6e2065e207c7cd9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="zh">
<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","所有方法"],2:["t2","实例方法"],4:["t3","抽象方法"],32:["t6","已过时的方法"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../index-all.html">索引</a></li>
<li><a href="../../../../help-doc.html">帮助</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="org.apache.calcite.sql2rel中的接口"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/sql2rel/NullInitializerExpressionFactory.html" title="org.apache.calcite.sql2rel中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/sql2rel/InitializerExpressionFactory.html" target="_top">框架</a></li>
<li><a href="InitializerExpressionFactory.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">所有类</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>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</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="接口 InitializerExpressionFactory" class="title">接口 InitializerExpressionFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>所有已知实现类:</dt>
<dd><a href="../../../../org/apache/calcite/sql2rel/NullInitializerExpressionFactory.html" title="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>方法概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">抽象方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">已过时的方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">方法和说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/calcite/schema/ColumnStrategy.html" title="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="org.apache.calcite.plan中的接口">RelOptTable</a>&nbsp;table,
int&nbsp;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="org.apache.calcite.plan中的接口">RelOptTable</a>&nbsp;table,
int&nbsp;iColumn)</code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;
<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="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="org.apache.calcite.rel.type中的接口">RelDataType</a>&nbsp;type,
<a href="../../../../org/apache/calcite/sql/SqlFunction.html" title="org.apache.calcite.sql中的类">SqlFunction</a>&nbsp;constructor,
int&nbsp;iAttribute,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="java.util中的类或接口">List</a>&lt;<a href="../../../../org/apache/calcite/rex/RexNode.html" title="org.apache.calcite.rex中的类">RexNode</a>&gt;&nbsp;constructorArgs,
<a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="org.apache.calcite.sql2rel中的接口">InitializerContext</a>&nbsp;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="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="org.apache.calcite.plan中的接口">RelOptTable</a>&nbsp;table,
int&nbsp;iColumn,
<a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="org.apache.calcite.sql2rel中的接口">InitializerContext</a>&nbsp;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="java.util.function中的类或接口">BiFunction</a>&lt;<a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="org.apache.calcite.sql2rel中的接口">InitializerContext</a>,<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>,<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&gt;</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>方法详细资料</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="java.lang中的类或接口">@Deprecated</a>
boolean&nbsp;isGeneratedAlways(<a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="org.apache.calcite.plan中的接口">RelOptTable</a>&nbsp;table,
int&nbsp;iColumn)</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;<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">另请参阅:</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="org.apache.calcite.schema中的枚举">ColumnStrategy</a>&nbsp;generationStrategy(<a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="org.apache.calcite.plan中的接口">RelOptTable</a>&nbsp;table,
int&nbsp;iColumn)</pre>
<div class="block">Returns how a column is populated.</div>
<dl>
<dt><span class="paramLabel">参数:</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">返回:</span></dt>
<dd>generation strategy, never null</dd>
<dt><span class="seeLabel">另请参阅:</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="org.apache.calcite.rex中的类">RexNode</a>&nbsp;newColumnDefaultValue(<a href="../../../../org/apache/calcite/plan/RelOptTable.html" title="org.apache.calcite.plan中的接口">RelOptTable</a>&nbsp;table,
int&nbsp;iColumn,
<a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="org.apache.calcite.sql2rel中的接口">InitializerContext</a>&nbsp;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="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">参数:</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">返回:</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="java.util.function中的类或接口">BiFunction</a>&lt;<a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="org.apache.calcite.sql2rel中的接口">InitializerContext</a>,<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>,<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&gt;&nbsp;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">返回:</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">另请参阅:</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="org.apache.calcite.rex中的类">RexNode</a>&nbsp;newAttributeInitializer(<a href="../../../../org/apache/calcite/rel/type/RelDataType.html" title="org.apache.calcite.rel.type中的接口">RelDataType</a>&nbsp;type,
<a href="../../../../org/apache/calcite/sql/SqlFunction.html" title="org.apache.calcite.sql中的类">SqlFunction</a>&nbsp;constructor,
int&nbsp;iAttribute,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="java.util中的类或接口">List</a>&lt;<a href="../../../../org/apache/calcite/rex/RexNode.html" title="org.apache.calcite.rex中的类">RexNode</a>&gt;&nbsp;constructorArgs,
<a href="../../../../org/apache/calcite/sql2rel/InitializerContext.html" title="org.apache.calcite.sql2rel中的接口">InitializerContext</a>&nbsp;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">参数:</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">返回:</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="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../index-all.html">索引</a></li>
<li><a href="../../../../help-doc.html">帮助</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="org.apache.calcite.sql2rel中的接口"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/sql2rel/NullInitializerExpressionFactory.html" title="org.apache.calcite.sql2rel中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/sql2rel/InitializerExpressionFactory.html" target="_top">框架</a></li>
<li><a href="InitializerExpressionFactory.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">所有类</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>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>