blob: e72d24b25edc5455c7219a1495505cf0f76b93d3 [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>SaffronProperties (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="SaffronProperties (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":38,"i5":38};
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/util/RelToSqlConverterUtil.html" title="org.apache.calcite.util中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/util/SaffronProperties.Helper.html" title="org.apache.calcite.util中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/util/SaffronProperties.html" target="_top">框架</a></li>
<li><a href="SaffronProperties.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><a href="#nested.class.summary">嵌套</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">字段</a>&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li><a href="#field.detail">字段</a>&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.util</div>
<h2 title="接口 SaffronProperties" class="title">接口 SaffronProperties</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;
<div class="block"><span class="deprecationComment">As of release 1.19,
replaced by <a href="../../../../org/apache/calcite/config/CalciteSystemProperty.html" title="org.apache.calcite.config中的类"><code>CalciteSystemProperty</code></a></span></div>
</div>
<br>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="java.lang中的类或接口">@Deprecated</a>
public interface <span class="typeNameLabel">SaffronProperties</span></pre>
<div class="block">Provides an environment for debugging information, et cetera, used by
saffron.
<p>It is a singleton, accessed via the <a href="../../../../org/apache/calcite/util/SaffronProperties.html#INSTANCE"><code>INSTANCE</code></a> object. It is
populated from System properties if saffron is invoked via a <code>
main()</code> method, from a <code>javax.servlet.ServletContext</code> if
saffron is invoked from a servlet, and so forth. If there is a file called
<code>"saffron.properties"</code> in the current directory, it is read too.
<p>Every property used in saffron code must have a method in this interface.
The method must return a sub-class of
<code>Resources.Prop</code>. The javadoc
comment must describe the name of the property (for example,
"net.sf.saffron.connection.PoolSize") and the default value, if any. <em>
Developers, please make sure that this remains so!</em></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>嵌套类概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="嵌套类概要表, 列表嵌套类和解释">
<caption><span>嵌套类</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">接口和说明</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/SaffronProperties.Helper.html" title="org.apache.calcite.util中的类">SaffronProperties.Helper</a></span></code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">Helper class.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>字段概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="字段概要表, 列表字段和解释">
<caption><span>字段</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">字段和说明</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/util/SaffronProperties.html" title="org.apache.calcite.util中的接口">SaffronProperties</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/SaffronProperties.html#INSTANCE">INSTANCE</a></span></code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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>org.apache.calcite.runtime.Resources.BooleanProp</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/SaffronProperties.html#allowInfiniteCostConverters--">allowInfiniteCostConverters</a></span>()</code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The boolean property "saffron.opt.allowInfiniteCostConverters" determines
whether the optimizer will consider adding converters of infinite cost in
order to convert a relational expression from one calling convention to
another.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.calcite.runtime.Resources.StringProp</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/SaffronProperties.html#defaultCharset--">defaultCharset</a></span>()</code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.default.charset" is the name of the default
character set.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.apache.calcite.runtime.Resources.StringProp</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/SaffronProperties.html#defaultCollation--">defaultCollation</a></span>()</code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.default.collation.name" is the name of the
default collation.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.calcite.runtime.Resources.StringProp</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/SaffronProperties.html#defaultCollationStrength--">defaultCollationStrength</a></span>()</code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.default.collation.strength" is the strength
of the default collation.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>org.apache.calcite.runtime.Resources.StringProp</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/SaffronProperties.html#defaultNationalCharset--">defaultNationalCharset</a></span>()</code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.default.nationalcharset" is the name of the
default national character set which is used with the N'string' construct
which may or may not be different from the <a href="../../../../org/apache/calcite/util/SaffronProperties.html#defaultCharset--"><code>defaultCharset()</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.apache.calcite.runtime.Resources.IntProp</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/SaffronProperties.html#metadataHandlerCacheMaximumSize--">metadataHandlerCacheMaximumSize</a></span>()</code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.metadata.handler.cache.maximum.size" is the
maximum size of the cache of metadata handlers.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>字段详细资料</h3>
<a name="INSTANCE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>INSTANCE</h4>
<pre>static final&nbsp;<a href="../../../../org/apache/calcite/util/SaffronProperties.html" title="org.apache.calcite.util中的接口">SaffronProperties</a> INSTANCE</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>方法详细资料</h3>
<a name="allowInfiniteCostConverters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowInfiniteCostConverters</h4>
<pre>org.apache.calcite.runtime.Resources.BooleanProp&nbsp;allowInfiniteCostConverters()</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The boolean property "saffron.opt.allowInfiniteCostConverters" determines
whether the optimizer will consider adding converters of infinite cost in
order to convert a relational expression from one calling convention to
another. The default value is <code>true</code>.</div>
</li>
</ul>
<a name="defaultCharset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultCharset</h4>
<pre>org.apache.calcite.runtime.Resources.StringProp&nbsp;defaultCharset()</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.default.charset" is the name of the default
character set. The default is "ISO-8859-1". It is used in
<a href="../../../../org/apache/calcite/sql/validate/SqlValidator.html" title="org.apache.calcite.sql.validate中的接口"><code>SqlValidator</code></a>.</div>
</li>
</ul>
<a name="defaultNationalCharset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultNationalCharset</h4>
<pre>org.apache.calcite.runtime.Resources.StringProp&nbsp;defaultNationalCharset()</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.default.nationalcharset" is the name of the
default national character set which is used with the N'string' construct
which may or may not be different from the <a href="../../../../org/apache/calcite/util/SaffronProperties.html#defaultCharset--"><code>defaultCharset()</code></a>. The
default is "ISO-8859-1". It is used in
<a href="../../../../org/apache/calcite/sql/SqlLiteral.html#SqlLiteral-java.lang.Object-org.apache.calcite.sql.type.SqlTypeName-org.apache.calcite.sql.parser.SqlParserPos-"><code>SqlLiteral.SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)</code></a></div>
</li>
</ul>
<a name="defaultCollation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultCollation</h4>
<pre>org.apache.calcite.runtime.Resources.StringProp&nbsp;defaultCollation()</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.default.collation.name" is the name of the
default collation. The default is "ISO-8859-1$en_US". Used in
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="org.apache.calcite.sql中的类"><code>SqlCollation</code></a> and
<a href="../../../../org/apache/calcite/sql/SqlLiteral.html#SqlLiteral-java.lang.Object-org.apache.calcite.sql.type.SqlTypeName-org.apache.calcite.sql.parser.SqlParserPos-"><code>SqlLiteral.SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)</code></a></div>
</li>
</ul>
<a name="defaultCollationStrength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultCollationStrength</h4>
<pre>org.apache.calcite.runtime.Resources.StringProp&nbsp;defaultCollationStrength()</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.default.collation.strength" is the strength
of the default collation. The default is "primary". Used in
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="org.apache.calcite.sql中的类"><code>SqlCollation</code></a> and
<a href="../../../../org/apache/calcite/sql/SqlLiteral.html#SqlLiteral-java.lang.Object-org.apache.calcite.sql.type.SqlTypeName-org.apache.calcite.sql.parser.SqlParserPos-"><code>SqlLiteral.SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)</code></a></div>
</li>
</ul>
<a name="metadataHandlerCacheMaximumSize--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>metadataHandlerCacheMaximumSize</h4>
<pre>org.apache.calcite.runtime.Resources.IntProp&nbsp;metadataHandlerCacheMaximumSize()</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
<div class="block">The string property "saffron.metadata.handler.cache.maximum.size" is the
maximum size of the cache of metadata handlers. A typical value is
the number of queries being concurrently prepared multiplied by the number
of types of metadata.
<p>If the value is less than 0, there is no limit. The default is 1,000.</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="跳过导航链接">跳过导航链接</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/util/RelToSqlConverterUtil.html" title="org.apache.calcite.util中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/util/SaffronProperties.Helper.html" title="org.apache.calcite.util中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/util/SaffronProperties.html" target="_top">框架</a></li>
<li><a href="SaffronProperties.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><a href="#nested.class.summary">嵌套</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">字段</a>&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li><a href="#field.detail">字段</a>&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>