Google Git
Sign in
apache / calcite-site / f3651d86b6f63f8b6bbb735c74220c093b7bf506 / . / apidocs / org / apache / calcite / schema / impl / AbstractSchema.html
blob: df3251b601a4d8bbee2d4ef7feb0463130acc821 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AbstractSchema (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractSchema (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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="class-use/AbstractSchema.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.schema.impl</a></div>
<h2 title="Class AbstractSchema" class="title">Class AbstractSchema</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.schema.impl.AbstractSchema</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../../jdbc/CalciteConnectionImpl.RootSchema.html" title="class in org.apache.calcite.jdbc">CalciteConnectionImpl.RootSchema</a></code>, <code><a href="../../adapter/cassandra/CassandraSchema.html" title="class in org.apache.calcite.adapter.cassandra">CassandraSchema</a></code>, <code><a href="../../adapter/clone/CloneSchema.html" title="class in org.apache.calcite.adapter.clone">CloneSchema</a></code>, <code><a href="../../adapter/csv/CsvSchema.html" title="class in org.apache.calcite.adapter.csv">CsvSchema</a></code>, <code><a href="../../adapter/druid/DruidSchema.html" title="class in org.apache.calcite.adapter.druid">DruidSchema</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchSchema.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSchema</a></code>, <code><a href="../../adapter/file/FileSchema.html" title="class in org.apache.calcite.adapter.file">FileSchema</a></code>, <code><a href="../../adapter/geode/rel/GeodeSchema.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeSchema</a></code>, <code><a href="../../adapter/geode/simple/GeodeSimpleSchema.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleSchema</a></code>, <code><a href="../../adapter/jdbc/JdbcCatalogSchema.html" title="class in org.apache.calcite.adapter.jdbc">JdbcCatalogSchema</a></code>, <code><a href="../../jdbc/MetadataSchema.html" title="class in org.apache.calcite.jdbc">MetadataSchema</a></code>, <code><a href="../../adapter/mongodb/MongoSchema.html" title="class in org.apache.calcite.adapter.mongodb">MongoSchema</a></code>, <code><a href="../../adapter/pig/PigSchema.html" title="class in org.apache.calcite.adapter.pig">PigSchema</a></code>, <code><a href="../../adapter/java/ReflectiveSchema.html" title="class in org.apache.calcite.adapter.java">ReflectiveSchema</a></code>, <code><a href="../../adapter/splunk/SplunkSchema.html" title="class in org.apache.calcite.adapter.splunk">SplunkSchema</a></code>, <code><a href="../../adapter/tpcds/TpcdsSchema.html" title="class in org.apache.calcite.adapter.tpcds">TpcdsSchema</a></code>, <code><a href="../../adapter/tpch/TpchSchema.html" title="class in org.apache.calcite.adapter.tpch">TpchSchema</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">AbstractSchema</span>
extends java.lang.Object
implements <a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></pre>
<div class="block">Abstract implementation of <a href="../Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a>.
<p>Behavior is as follows:</p>
<ul>
<li>The schema has no tables unless you override
<a href="#getTableMap()"><code>getTableMap()</code></a>.</li>
<li>The schema has no functions unless you override
<a href="#getFunctionMultimap()"><code>getFunctionMultimap()</code></a>.</li>
<li>The schema has no sub-schemas unless you override
<a href="#getSubSchemaMap()"><code>getSubSchemaMap()</code></a>.</li>
<li>The schema is mutable unless you override
<a href="#isMutable()"><code>isMutable()</code></a>.</li>
<li>The name and parent schema are as specified in the constructor
arguments.</li>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<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>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractSchema.Factory.html" title="class in org.apache.calcite.schema.impl">AbstractSchema.Factory</a></span></code></th>
<td class="colLast">
<div class="block">Schema factory that creates an
<a href="AbstractSchema.html" title="class in org.apache.calcite.schema.impl"><code>AbstractSchema</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.schema.Schema">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.schema.<a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></h3>
<code><a href="../Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">AbstractSchema</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<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>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)">getExpression</a></span>&#8203;(<a href="../SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;parentSchema,
java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the expression by which this schema can be referenced in generated
code.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected com.google.common.collect.Multimap&lt;java.lang.String,&#8203;<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFunctionMultimap()">getFunctionMultimap</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a multi-map of functions in this schema by name.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFunctionNames()">getFunctionNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the names of the functions in this schema.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFunctions(java.lang.String)">getFunctions</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns a list of functions in this schema with the given name, or
an empty list if there is no such function.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubSchema(java.lang.String)">getSubSchema</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns a sub-schema with a given name, or null.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;<a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubSchemaMap()">getSubSchemaMap</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a map of sub-schemas in this schema by name.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubSchemaNames()">getSubSchemaNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the names of this schema's child schemas.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../Table.html" title="interface in org.apache.calcite.schema">Table</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTable(java.lang.String)">getTable</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns a table with a given name, or null if not found.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;<a href="../Table.html" title="interface in org.apache.calcite.schema">Table</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTableMap()">getTableMap</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a map of tables in this schema by name.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTableNames()">getTableNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the names of the tables in this schema.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType(java.lang.String)">getType</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns a type with a given name, or null if not found.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,&#8203;<a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeMap()">getTypeMap</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a map of types in this schema by name.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeNames()">getTypeNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the names of the types in this schema.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMutable()">isMutable</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the user is allowed to create new tables, functions
and sub-schemas in this schema, in addition to those returned automatically
by methods such as <a href="../Schema.html#getTable(java.lang.String)"><code>Schema.getTable(String)</code></a>.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#snapshot(org.apache.calcite.schema.SchemaVersion)">snapshot</a></span>&#8203;(<a href="../SchemaVersion.html" title="interface in org.apache.calcite.schema">SchemaVersion</a>&nbsp;version)</code></th>
<td class="colLast">
<div class="block">Returns the snapshot of this schema as of the specified time.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractSchema</h4>
<pre>public&nbsp;AbstractSchema()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="isMutable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMutable</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isMutable()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#isMutable()">Schema</a></code></span></div>
<div class="block">Returns whether the user is allowed to create new tables, functions
and sub-schemas in this schema, in addition to those returned automatically
by methods such as <a href="../Schema.html#getTable(java.lang.String)"><code>Schema.getTable(String)</code></a>.
<p>Even if this method returns true, the maps are not modified. Calcite
stores the defined objects in a wrapper object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#isMutable()">isMutable</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the user is allowed to create new tables, functions
and sub-schemas in this schema</dd>
</dl>
</li>
</ul>
<a id="snapshot(org.apache.calcite.schema.SchemaVersion)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snapshot</h4>
<pre class="methodSignature">public&nbsp;<a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a>&nbsp;snapshot&#8203;(<a href="../SchemaVersion.html" title="interface in org.apache.calcite.schema">SchemaVersion</a>&nbsp;version)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#snapshot(org.apache.calcite.schema.SchemaVersion)">Schema</a></code></span></div>
<div class="block">Returns the snapshot of this schema as of the specified time. The
contents of the schema snapshot should not change over time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#snapshot(org.apache.calcite.schema.SchemaVersion)">snapshot</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>version</code> - The current schema version</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the schema snapshot.</dd>
</dl>
</li>
</ul>
<a id="getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpression</h4>
<pre class="methodSignature">public&nbsp;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;getExpression&#8203;(<a href="../SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;parentSchema,
java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)">Schema</a></code></span></div>
<div class="block">Returns the expression by which this schema can be referenced in generated
code.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)">getExpression</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parentSchema</code> - Parent schema</dd>
<dd><code>name</code> - Name of this schema</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Expression by which this schema can be referenced in generated code</dd>
</dl>
</li>
</ul>
<a id="getTableMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableMap</h4>
<pre class="methodSignature">protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;<a href="../Table.html" title="interface in org.apache.calcite.schema">Table</a>&gt;&nbsp;getTableMap()</pre>
<div class="block">Returns a map of tables in this schema by name.
<p>The implementations of <a href="#getTableNames()"><code>getTableNames()</code></a>
and <a href="#getTable(java.lang.String)"><code>getTable(String)</code></a> depend on this map.
The default implementation of this method returns the empty map.
Override this method to change their behavior.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map of tables in this schema by name</dd>
</dl>
</li>
</ul>
<a id="getTableNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTableNames</h4>
<pre class="methodSignature">public final&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getTableNames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#getTableNames()">Schema</a></code></span></div>
<div class="block">Returns the names of the tables in this schema.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#getTableNames()">getTableNames</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Names of the tables in this schema</dd>
</dl>
</li>
</ul>
<a id="getTable(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTable</h4>
<pre class="methodSignature">public final&nbsp;<a href="../Table.html" title="interface in org.apache.calcite.schema">Table</a>&nbsp;getTable&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#getTable(java.lang.String)">Schema</a></code></span></div>
<div class="block">Returns a table with a given name, or null if not found.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#getTable(java.lang.String)">getTable</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Table name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Table, or null</dd>
</dl>
</li>
</ul>
<a id="getTypeMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeMap</h4>
<pre class="methodSignature">protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;<a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a>&gt;&nbsp;getTypeMap()</pre>
<div class="block">Returns a map of types in this schema by name.
<p>The implementations of <a href="#getTypeNames()"><code>getTypeNames()</code></a>
and <a href="#getType(java.lang.String)"><code>getType(String)</code></a> depend on this map.
The default implementation of this method returns the empty map.
Override this method to change their behavior.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map of types in this schema by name</dd>
</dl>
</li>
</ul>
<a id="getType(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a>&nbsp;getType&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#getType(java.lang.String)">Schema</a></code></span></div>
<div class="block">Returns a type with a given name, or null if not found.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#getType(java.lang.String)">getType</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Table name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Table, or null</dd>
</dl>
</li>
</ul>
<a id="getTypeNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeNames</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getTypeNames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#getTypeNames()">Schema</a></code></span></div>
<div class="block">Returns the names of the types in this schema.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#getTypeNames()">getTypeNames</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Names of the tables in this schema</dd>
</dl>
</li>
</ul>
<a id="getFunctionMultimap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunctionMultimap</h4>
<pre class="methodSignature">protected&nbsp;com.google.common.collect.Multimap&lt;java.lang.String,&#8203;<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>&gt;&nbsp;getFunctionMultimap()</pre>
<div class="block">Returns a multi-map of functions in this schema by name.
It is a multi-map because functions are overloaded; there may be more than
one function in a schema with a given name (as long as they have different
parameter lists).
<p>The implementations of <a href="#getFunctionNames()"><code>getFunctionNames()</code></a>
and <a href="../Schema.html#getFunctions(java.lang.String)"><code>Schema.getFunctions(String)</code></a> depend on this map.
The default implementation of this method returns the empty multi-map.
Override this method to change their behavior.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Multi-map of functions in this schema by name</dd>
</dl>
</li>
</ul>
<a id="getFunctions(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunctions</h4>
<pre class="methodSignature">public final&nbsp;java.util.Collection&lt;<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>&gt;&nbsp;getFunctions&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#getFunctions(java.lang.String)">Schema</a></code></span></div>
<div class="block">Returns a list of functions in this schema with the given name, or
an empty list if there is no such function.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#getFunctions(java.lang.String)">getFunctions</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of function</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of functions with given name, or empty list</dd>
</dl>
</li>
</ul>
<a id="getFunctionNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunctionNames</h4>
<pre class="methodSignature">public final&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getFunctionNames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#getFunctionNames()">Schema</a></code></span></div>
<div class="block">Returns the names of the functions in this schema.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#getFunctionNames()">getFunctionNames</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Names of the functions in this schema</dd>
</dl>
</li>
</ul>
<a id="getSubSchemaMap()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubSchemaMap</h4>
<pre class="methodSignature">protected&nbsp;java.util.Map&lt;java.lang.String,&#8203;<a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a>&gt;&nbsp;getSubSchemaMap()</pre>
<div class="block">Returns a map of sub-schemas in this schema by name.
<p>The implementations of <a href="#getSubSchemaNames()"><code>getSubSchemaNames()</code></a>
and <a href="#getSubSchema(java.lang.String)"><code>getSubSchema(String)</code></a> depend on this map.
The default implementation of this method returns the empty map.
Override this method to change their behavior.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map of sub-schemas in this schema by name</dd>
</dl>
</li>
</ul>
<a id="getSubSchemaNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubSchemaNames</h4>
<pre class="methodSignature">public final&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getSubSchemaNames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#getSubSchemaNames()">Schema</a></code></span></div>
<div class="block">Returns the names of this schema's child schemas.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#getSubSchemaNames()">getSubSchemaNames</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Names of this schema's child schemas</dd>
</dl>
</li>
</ul>
<a id="getSubSchema(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSubSchema</h4>
<pre class="methodSignature">public final&nbsp;<a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a>&nbsp;getSubSchema&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../Schema.html#getSubSchema(java.lang.String)">Schema</a></code></span></div>
<div class="block">Returns a sub-schema with a given name, or null.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../Schema.html#getSubSchema(java.lang.String)">getSubSchema</a></code>&nbsp;in interface&nbsp;<code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Sub-schema name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Sub-schema with a given name, or null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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="class-use/AbstractSchema.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>