| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractSchema (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.schema.impl, class: AbstractSchema"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.schema.impl</a></div> |
| <h1 title="Class AbstractSchema" class="title">Class AbstractSchema</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.schema.impl.AbstractSchema</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><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/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/innodb/InnodbSchema.html" title="class in org.apache.calcite.adapter.innodb">InnodbSchema</a></code>, <code><a href="../../adapter/jdbc/JdbcCatalogSchema.html" title="class in org.apache.calcite.adapter.jdbc">JdbcCatalogSchema</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> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AbstractSchema</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></span></div> |
| <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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="AbstractSchema.Factory.html" class="type-name-link" title="class in org.apache.calcite.schema.impl">AbstractSchema.Factory</a></code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.schema.Schema">Nested classes/interfaces inherited from interface org.apache.calcite.schema.<a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></h2> |
| <code><a href="../Schema.TableType.html" title="enum in org.apache.calcite.schema">Schema.TableType</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">AbstractSchema</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)" class="member-name-link">getExpression</a><wbr>(@Nullable <a href="../SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a> parentSchema, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the expression by which this schema can be referenced in generated |
| code.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected com.google.common.collect.Multimap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFunctionMultimap()" class="member-name-link">getFunctionMultimap</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a multi-map of functions in this schema by name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFunctionNames()" class="member-name-link">getFunctionNames</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the names of the functions in this schema.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFunctions(java.lang.String)" class="member-name-link">getFunctions</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final @Nullable <a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSubSchema(java.lang.String)" class="member-name-link">getSubSchema</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a sub-schema with a given name, or null.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSubSchemaMap()" class="member-name-link">getSubSchemaMap</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a map of sub-schemas in this schema by name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSubSchemaNames()" class="member-name-link">getSubSchemaNames</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the names of this schema's child schemas.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final @Nullable <a href="../Table.html" title="interface in org.apache.calcite.schema">Table</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTable(java.lang.String)" class="member-name-link">getTable</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a table with a given name, or null if not found.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Table.html" title="interface in org.apache.calcite.schema">Table</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTableMap()" class="member-name-link">getTableMap</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a map of tables in this schema by name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTableNames()" class="member-name-link">getTableNames</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the names of the tables in this schema.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getType(java.lang.String)" class="member-name-link">getType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a type with a given name, or null if not found.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTypeMap()" class="member-name-link">getTypeMap</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a map of types in this schema by name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTypeNames()" class="member-name-link">getTypeNames</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the names of the types in this schema.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMutable()" class="member-name-link">isMutable</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#snapshot(org.apache.calcite.schema.SchemaVersion)" class="member-name-link">snapshot</a><wbr>(<a href="../SchemaVersion.html" title="interface in org.apache.calcite.schema">SchemaVersion</a> version)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the snapshot of this schema as of the specified time.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>AbstractSchema</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AbstractSchema</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="isMutable()"> |
| <h3>isMutable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isMutable</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#isMutable()">isMutable</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Whether the user is allowed to create new tables, functions |
| and sub-schemas in this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="snapshot(org.apache.calcite.schema.SchemaVersion)"> |
| <h3>snapshot</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></span> <span class="element-name">snapshot</span><wbr><span class="parameters">(<a href="../SchemaVersion.html" title="interface in org.apache.calcite.schema">SchemaVersion</a> version)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#snapshot(org.apache.calcite.schema.SchemaVersion)">snapshot</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>version</code> - The current schema version</dd> |
| <dt>Returns:</dt> |
| <dd>the schema snapshot.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)"> |
| <h3>getExpression</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></span> <span class="element-name">getExpression</span><wbr><span class="parameters">(@Nullable <a href="../SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a> parentSchema, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)">getExpression</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>parentSchema</code> - Parent schema</dd> |
| <dd><code>name</code> - Name of this schema</dd> |
| <dt>Returns:</dt> |
| <dd>Expression by which this schema can be referenced in generated code</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableMap()"> |
| <h3>getTableMap</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Table.html" title="interface in org.apache.calcite.schema">Table</a>></span> <span class="element-name">getTableMap</span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>Map of tables in this schema by name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableNames()"> |
| <h3>getTableNames</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getTableNames</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#getTableNames()">getTableNames</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Names of the tables in this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTable(java.lang.String)"> |
| <h3>getTable</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">@Nullable <a href="../Table.html" title="interface in org.apache.calcite.schema">Table</a></span> <span class="element-name">getTable</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#getTable(java.lang.String)">getTable</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Table name</dd> |
| <dt>Returns:</dt> |
| <dd>Table, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTypeMap()"> |
| <h3>getTypeMap</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a>></span> <span class="element-name">getTypeMap</span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>Map of types in this schema by name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getType(java.lang.String)"> |
| <h3>getType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></span> <span class="element-name">getType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#getType(java.lang.String)">getType</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Table name</dd> |
| <dt>Returns:</dt> |
| <dd>Table, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTypeNames()"> |
| <h3>getTypeNames</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getTypeNames</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#getTypeNames()">getTypeNames</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Names of the tables in this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFunctionMultimap()"> |
| <h3>getFunctionMultimap</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">com.google.common.collect.Multimap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>></span> <span class="element-name">getFunctionMultimap</span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>Multi-map of functions in this schema by name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFunctions(java.lang.String)"> |
| <h3>getFunctions</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>></span> <span class="element-name">getFunctions</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#getFunctions(java.lang.String)">getFunctions</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Name of function</dd> |
| <dt>Returns:</dt> |
| <dd>List of functions with given name, or empty list</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFunctionNames()"> |
| <h3>getFunctionNames</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getFunctionNames</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#getFunctionNames()">getFunctionNames</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Names of the functions in this schema</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubSchemaMap()"> |
| <h3>getSubSchemaMap</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a>></span> <span class="element-name">getSubSchemaMap</span>()</div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>Map of sub-schemas in this schema by name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubSchemaNames()"> |
| <h3>getSubSchemaNames</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getSubSchemaNames</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#getSubSchemaNames()">getSubSchemaNames</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Names of this schema's child schemas</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubSchema(java.lang.String)"> |
| <h3>getSubSchema</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">@Nullable <a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></span> <span class="element-name">getSubSchema</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../Schema.html#getSubSchema(java.lang.String)">getSubSchema</a></code> in interface <code><a href="../Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Sub-schema name</dd> |
| <dt>Returns:</dt> |
| <dd>Sub-schema with a given name, or null</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
