blob: 310fcb8d6ab9c3f9c91edc684c1835f53eda8444 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>MockCatalogReaderExtended (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.test.catalog, class: MockCatalogReaderExtended">
<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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<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>
<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>&nbsp;<a href="package-summary.html">org.apache.calcite.test.catalog</a></div>
<h1 title="Class MockCatalogReaderExtended" class="title">Class MockCatalogReaderExtended</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"><a href="../../prepare/CalciteCatalogReader.html" title="class in org.apache.calcite.prepare">org.apache.calcite.prepare.CalciteCatalogReader</a>
<div class="inheritance"><a href="MockCatalogReader.html" title="class in org.apache.calcite.test.catalog">org.apache.calcite.test.catalog.MockCatalogReader</a>
<div class="inheritance"><a href="MockCatalogReaderSimple.html" title="class in org.apache.calcite.test.catalog">org.apache.calcite.test.catalog.MockCatalogReaderSimple</a>
<div class="inheritance">org.apache.calcite.test.catalog.MockCatalogReaderExtended</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../plan/RelOptSchema.html" title="interface in org.apache.calcite.plan">RelOptSchema</a></code>, <code><a href="../../prepare/Prepare.CatalogReader.html" title="interface in org.apache.calcite.prepare">Prepare.CatalogReader</a></code>, <code><a href="../../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></code>, <code><a href="../../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a></code>, <code><a href="../../sql/validate/SqlValidatorCatalogReader.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorCatalogReader</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MockCatalogReaderExtended</span>
<span class="extends-implements">extends <a href="MockCatalogReaderSimple.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderSimple</a></span></div>
<div class="block">Adds some extra tables to the mock catalog. These increase the time and
complexity of initializing the catalog (because they contain views whose
SQL needs to be parsed) and so are not used for all tests.</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="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.calcite.test.catalog.MockCatalogReader">Nested classes/interfaces inherited from class&nbsp;org.apache.calcite.test.catalog.<a href="MockCatalogReader.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader</a></h2>
<code><a href="MockCatalogReader.ColumnResolver.html" title="interface in org.apache.calcite.test.catalog">MockCatalogReader.ColumnResolver</a>, <a href="MockCatalogReader.MockDynamicTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockDynamicTable</a>, <a href="MockCatalogReader.MockModifiableViewRelOptTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockModifiableViewRelOptTable</a>, <a href="MockCatalogReader.MockRelViewTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockRelViewTable</a>, <a href="MockCatalogReader.MockSchema.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockSchema</a>, <a href="MockCatalogReader.MockTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockTable</a>, <a href="MockCatalogReader.MockViewTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockViewTable</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.calcite.prepare.CalciteCatalogReader">Fields inherited from class&nbsp;org.apache.calcite.prepare.<a href="../../prepare/CalciteCatalogReader.html" title="class in org.apache.calcite.prepare">CalciteCatalogReader</a></h3>
<code><a href="../../prepare/CalciteCatalogReader.html#config">config</a>, <a href="../../prepare/CalciteCatalogReader.html#nameMatcher">nameMatcher</a>, <a href="../../prepare/CalciteCatalogReader.html#rootSchema">rootSchema</a>, <a href="../../prepare/CalciteCatalogReader.html#typeFactory">typeFactory</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.calcite.prepare.Prepare.CatalogReader">Fields inherited from interface&nbsp;org.apache.calcite.prepare.<a href="../../prepare/Prepare.CatalogReader.html" title="interface in org.apache.calcite.prepare">Prepare.CatalogReader</a></h3>
<code><a href="../../prepare/Prepare.CatalogReader.html#THREAD_LOCAL">THREAD_LOCAL</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 three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.rel.type.RelDataTypeFactory,boolean)" class="member-name-link">MockCatalogReaderExtended</a><wbr>(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
boolean&nbsp;caseSensitive)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a MockCatalogReader.</div>
</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab1 method-summary-table-tab4"><code>static @NonNull <a href="MockCatalogReaderExtended.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderExtended</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(org.apache.calcite.rel.type.RelDataTypeFactory,boolean)" class="member-name-link">create</a><wbr>(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
boolean&nbsp;caseSensitive)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Creates and initializes a MockCatalogReaderExtended.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MockCatalogReaderExtended.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderExtended</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#init()" class="member-name-link">init</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Initializes this catalog reader.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.test.catalog.MockCatalogReaderSimple">Methods inherited from class&nbsp;org.apache.calcite.test.catalog.<a href="MockCatalogReaderSimple.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderSimple</a></h3>
<code><a href="MockCatalogReaderSimple.html#getNamedType(org.apache.calcite.sql.SqlIdentifier)">getNamedType</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.test.catalog.MockCatalogReader">Methods inherited from class&nbsp;org.apache.calcite.test.catalog.<a href="MockCatalogReader.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader</a></h3>
<code><a href="MockCatalogReader.html#isCaseSensitive()">isCaseSensitive</a>, <a href="MockCatalogReader.html#nameMatcher()">nameMatcher</a>, <a href="MockCatalogReader.html#registerSchema(org.apache.calcite.test.catalog.MockCatalogReader.MockSchema)">registerSchema</a>, <a href="MockCatalogReader.html#registerTable(org.apache.calcite.test.catalog.MockCatalogReader.MockTable)">registerTable</a>, <a href="MockCatalogReader.html#registerTablesWithRollUp(org.apache.calcite.test.catalog.MockCatalogReader.MockSchema,org.apache.calcite.test.catalog.Fixture)">registerTablesWithRollUp</a>, <a href="MockCatalogReader.html#registerType(java.util.List,org.apache.calcite.rel.type.RelProtoDataType)">registerType</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.prepare.CalciteCatalogReader">Methods inherited from class&nbsp;org.apache.calcite.prepare.<a href="../../prepare/CalciteCatalogReader.html" title="class in org.apache.calcite.prepare">CalciteCatalogReader</a></h3>
<code><a href="../../prepare/CalciteCatalogReader.html#createTypeFromProjection(org.apache.calcite.rel.type.RelDataType,java.util.List)">createTypeFromProjection</a>, <a href="../../prepare/CalciteCatalogReader.html#field(org.apache.calcite.rel.type.RelDataType,java.lang.String)">field</a>, <a href="../../prepare/CalciteCatalogReader.html#getAllSchemaObjectNames(java.util.List)">getAllSchemaObjectNames</a>, <a href="../../prepare/CalciteCatalogReader.html#getConfig()">getConfig</a>, <a href="../../prepare/CalciteCatalogReader.html#getOperatorList()">getOperatorList</a>, <a href="../../prepare/CalciteCatalogReader.html#getRootSchema()">getRootSchema</a>, <a href="../../prepare/CalciteCatalogReader.html#getSchemaPaths()">getSchemaPaths</a>, <a href="../../prepare/CalciteCatalogReader.html#getTable(java.util.List)">getTable</a>, <a href="../../prepare/CalciteCatalogReader.html#getTableForMember(java.util.List)">getTableForMember</a>, <a href="../../prepare/CalciteCatalogReader.html#getTypeFactory()">getTypeFactory</a>, <a href="../../prepare/CalciteCatalogReader.html#lookupOperatorOverloads(org.apache.calcite.sql.SqlIdentifier,org.apache.calcite.sql.SqlFunctionCategory,org.apache.calcite.sql.SqlSyntax,java.util.List,org.apache.calcite.sql.validate.SqlNameMatcher)">lookupOperatorOverloads</a>, <a href="../../prepare/CalciteCatalogReader.html#matches(java.lang.String,java.lang.String)">matches</a>, <a href="../../prepare/CalciteCatalogReader.html#operatorTable(java.lang.String...)">operatorTable</a>, <a href="../../prepare/CalciteCatalogReader.html#registerRules(org.apache.calcite.plan.RelOptPlanner)">registerRules</a>, <a href="../../prepare/CalciteCatalogReader.html#unwrap(java.lang.Class)">unwrap</a>, <a href="../../prepare/CalciteCatalogReader.html#withSchemaPath(java.util.List)">withSchemaPath</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.schema.Wrapper">Methods inherited from interface&nbsp;org.apache.calcite.schema.<a href="../../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></h3>
<code><a href="../../schema/Wrapper.html#maybeUnwrap(java.lang.Class)">maybeUnwrap</a>, <a href="../../schema/Wrapper.html#unwrapOrThrow(java.lang.Class)">unwrapOrThrow</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="&lt;init&gt;(org.apache.calcite.rel.type.RelDataTypeFactory,boolean)">
<h3>MockCatalogReaderExtended</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">MockCatalogReaderExtended</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
boolean&nbsp;caseSensitive)</span></div>
<div class="block">Creates a MockCatalogReader.
<p>Caller must then call <a href="#init()"><code>init()</code></a> to populate with data;
constructor is protected to encourage you to call <a href="#create(org.apache.calcite.rel.type.RelDataTypeFactory,boolean)"><code>create(org.apache.calcite.rel.type.RelDataTypeFactory, boolean)</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>typeFactory</code> - Type factory</dd>
<dd><code>caseSensitive</code> - case sensitivity</dd>
</dl>
</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="create(org.apache.calcite.rel.type.RelDataTypeFactory,boolean)">
<h3>create</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">@NonNull <a href="MockCatalogReaderExtended.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderExtended</a></span>&nbsp;<span class="element-name">create</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
boolean&nbsp;caseSensitive)</span></div>
<div class="block">Creates and initializes a MockCatalogReaderExtended.</div>
</section>
</li>
<li>
<section class="detail" id="init()">
<h3>init</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MockCatalogReaderExtended.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderExtended</a></span>&nbsp;<span class="element-name">init</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="MockCatalogReader.html#init()">MockCatalogReader</a></code></span></div>
<div class="block">Initializes this catalog reader.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="MockCatalogReaderSimple.html#init()">init</a></code>&nbsp;in class&nbsp;<code><a href="MockCatalogReaderSimple.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderSimple</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>