Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / schema / Wrapper.html
blob: a9ce5bd6a0fe88c04a136e45db357c22e40400c8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Wrapper (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, interface: Wrapper">
<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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.schema</a></div>
<h1 title="Interface Wrapper" class="title">Interface Wrapper</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a></code>, <code><a href="../prepare/Prepare.CatalogReader.html" title="interface in org.apache.calcite.prepare">Prepare.CatalogReader</a></code>, <code><a href="../prepare/Prepare.PreparingTable.html" title="interface in org.apache.calcite.prepare">Prepare.PreparingTable</a></code>, <code><a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a></code>, <code><a href="../sql/validate/SqlValidatorCatalogReader.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorCatalogReader</a></code>, <code><a href="../sql/validate/SqlValidatorTable.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorTable</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../test/AbstractModifiableTable.html" title="class in org.apache.calcite.test">AbstractModifiableTable</a></code>, <code><a href="../test/AbstractModifiableView.html" title="class in org.apache.calcite.test">AbstractModifiableView</a></code>, <code><a href="../adapter/java/AbstractQueryableTable.html" title="class in org.apache.calcite.adapter.java">AbstractQueryableTable</a></code>, <code><a href="impl/AbstractTable.html" title="class in org.apache.calcite.schema.impl">AbstractTable</a></code>, <code><a href="../prepare/CalciteCatalogReader.html" title="class in org.apache.calcite.prepare">CalciteCatalogReader</a></code>, <code><a href="../adapter/cassandra/CassandraTable.html" title="class in org.apache.calcite.adapter.cassandra">CassandraTable</a></code>, <code><a href="../adapter/csv/CsvFilterableTable.html" title="class in org.apache.calcite.adapter.csv">CsvFilterableTable</a></code>, <code><a href="../adapter/csv/CsvScannableTable.html" title="class in org.apache.calcite.adapter.csv">CsvScannableTable</a></code>, <code><a href="../adapter/csv/CsvStreamScannableTable.html" title="class in org.apache.calcite.adapter.csv">CsvStreamScannableTable</a></code>, <code><a href="../adapter/csv/CsvTable.html" title="class in org.apache.calcite.adapter.csv">CsvTable</a></code>, <code><a href="../adapter/file/CsvTable.html" title="class in org.apache.calcite.adapter.file">CsvTable</a></code>, <code><a href="../adapter/csv/CsvTranslatableTable.html" title="class in org.apache.calcite.adapter.csv">CsvTranslatableTable</a></code>, <code><a href="../adapter/file/CsvTranslatableTable.html" title="class in org.apache.calcite.adapter.file">CsvTranslatableTable</a></code>, <code><a href="../sql/validate/DelegatingSqlValidatorCatalogReader.html" title="class in org.apache.calcite.sql.validate">DelegatingSqlValidatorCatalogReader</a></code>, <code><a href="../sql/validate/DelegatingSqlValidatorTable.html" title="class in org.apache.calcite.sql.validate">DelegatingSqlValidatorTable</a></code>, <code><a href="../adapter/druid/DruidTable.html" title="class in org.apache.calcite.adapter.druid">DruidTable</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchTable.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchTable</a></code>, <code><a href="../adapter/geode/simple/GeodeSimpleScannableTable.html" title="class in org.apache.calcite.adapter.geode.simple">GeodeSimpleScannableTable</a></code>, <code><a href="../adapter/geode/rel/GeodeTable.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeTable</a></code>, <code><a href="../adapter/innodb/InnodbTable.html" title="class in org.apache.calcite.adapter.innodb">InnodbTable</a></code>, <code><a href="../adapter/jdbc/JdbcTable.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTable</a></code>, <code><a href="../adapter/file/JsonScannableTable.html" title="class in org.apache.calcite.adapter.file">JsonScannableTable</a></code>, <code><a href="../adapter/file/JsonTable.html" title="class in org.apache.calcite.adapter.file">JsonTable</a></code>, <code><a href="impl/ListTransientTable.html" title="class in org.apache.calcite.schema.impl">ListTransientTable</a></code>, <code><a href="impl/MaterializedViewTable.html" title="class in org.apache.calcite.schema.impl">MaterializedViewTable</a></code>, <code><a href="../example/maze/MazeTable.html" title="class in org.apache.calcite.example.maze">MazeTable</a></code>, <code><a href="../test/catalog/MockCatalogReader.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader</a></code>, <code><a href="../test/catalog/MockCatalogReader.MockDynamicTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockDynamicTable</a></code>, <code><a href="../test/catalog/MockCatalogReader.MockModifiableViewRelOptTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockModifiableViewRelOptTable</a></code>, <code><a href="../test/catalog/MockCatalogReader.MockModifiableViewRelOptTable.MockModifiableViewTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockModifiableViewRelOptTable.MockModifiableViewTable</a></code>, <code><a href="../test/catalog/MockCatalogReader.MockRelViewTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockRelViewTable</a></code>, <code><a href="../test/catalog/MockCatalogReader.MockTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockTable</a></code>, <code><a href="../test/catalog/MockCatalogReader.MockViewTable.html" title="class in org.apache.calcite.test.catalog">MockCatalogReader.MockViewTable</a></code>, <code><a href="../test/catalog/MockCatalogReaderDynamic.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderDynamic</a></code>, <code><a href="../test/catalog/MockCatalogReaderExtended.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderExtended</a></code>, <code><a href="../test/catalog/MockCatalogReaderSimple.html" title="class in org.apache.calcite.test.catalog">MockCatalogReaderSimple</a></code>, <code><a href="../test/MockSqlOperatorTable.MyAggFunc.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyAggFunc</a></code>, <code><a href="../test/MockSqlOperatorTable.MyAvgAggFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyAvgAggFunction</a></code>, <code><a href="impl/ModifiableViewTable.html" title="class in org.apache.calcite.schema.impl">ModifiableViewTable</a></code>, <code><a href="../adapter/mongodb/MongoTable.html" title="class in org.apache.calcite.adapter.mongodb">MongoTable</a></code>, <code><a href="../adapter/pig/PigTable.html" title="class in org.apache.calcite.adapter.pig">PigTable</a></code>, <code><a href="../piglet/PigTable.html" title="class in org.apache.calcite.piglet">PigTable</a></code>, <code><a href="../prepare/Prepare.AbstractPreparingTable.html" title="class in org.apache.calcite.prepare">Prepare.AbstractPreparingTable</a></code>, <code><a href="../adapter/redis/RedisTable.html" title="class in org.apache.calcite.adapter.redis">RedisTable</a></code>, <code><a href="../plan/RelOptAbstractTable.html" title="class in org.apache.calcite.plan">RelOptAbstractTable</a></code>, <code><a href="../prepare/RelOptTableImpl.html" title="class in org.apache.calcite.prepare">RelOptTableImpl</a></code>, <code><a href="../util/Smalls.MazeTable.html" title="class in org.apache.calcite.util">Smalls.MazeTable</a></code>, <code><a href="../util/Smalls.SimpleTable.html" title="class in org.apache.calcite.util">Smalls.SimpleTable</a></code>, <code><a href="../sql/fun/SqlAbstractGroupFunction.html" title="class in org.apache.calcite.sql.fun">SqlAbstractGroupFunction</a></code>, <code><a href="../sql/SqlAggFunction.html" title="class in org.apache.calcite.sql">SqlAggFunction</a></code>, <code><a href="../sql/fun/SqlAnyValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlAnyValueAggFunction</a></code>, <code><a href="../sql/fun/SqlAvgAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlAvgAggFunction</a></code>, <code><a href="../sql/fun/SqlBasicAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlBasicAggFunction</a></code>, <code><a href="../sql/fun/SqlBitOpAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlBitOpAggFunction</a></code>, <code><a href="../sql/fun/SqlCountAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlCountAggFunction</a></code>, <code><a href="../sql/fun/SqlCovarAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlCovarAggFunction</a></code>, <code><a href="../sql/fun/SqlFirstLastValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlFirstLastValueAggFunction</a></code>, <code><a href="../sql/fun/SqlHistogramAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlHistogramAggFunction</a></code>, <code><a href="../sql/fun/SqlJsonArrayAggAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonArrayAggAggFunction</a></code>, <code><a href="../sql/fun/SqlJsonObjectAggAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonObjectAggAggFunction</a></code>, <code><a href="../sql/fun/SqlLeadLagAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlLeadLagAggFunction</a></code>, <code><a href="../sql/fun/SqlMinMaxAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlMinMaxAggFunction</a></code>, <code><a href="../sql/fun/SqlNthValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlNthValueAggFunction</a></code>, <code><a href="../sql/fun/SqlNtileAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlNtileAggFunction</a></code>, <code><a href="../sql/SqlRankFunction.html" title="class in org.apache.calcite.sql">SqlRankFunction</a></code>, <code><a href="../sql/fun/SqlRegrCountAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlRegrCountAggFunction</a></code>, <code><a href="../sql/fun/SqlSingleValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSingleValueAggFunction</a></code>, <code><a href="../sql/fun/SqlSumAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSumAggFunction</a></code>, <code><a href="../sql/fun/SqlSumEmptyIsZeroAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSumEmptyIsZeroAggFunction</a></code>, <code><a href="../sql/validate/SqlUserDefinedAggFunction.html" title="class in org.apache.calcite.sql.validate">SqlUserDefinedAggFunction</a></code>, <code><a href="impl/StarTable.html" title="class in org.apache.calcite.schema.impl">StarTable</a></code>, <code><a href="impl/ViewTable.html" title="class in org.apache.calcite.schema.impl">ViewTable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Wrapper</span></div>
<div class="block">Mix-in interface that allows you to find sub-objects.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default &lt;C&gt;&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;C&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#maybeUnwrap(java.lang.Class)" class="member-name-link">maybeUnwrap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;C&gt;&nbsp;aClass)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Finds an instance of an interface implemented by this object,
or returns <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html#empty()" title="class or interface in java.util" class="external-link"><code>Optional.empty()</code></a> if this object does not support
that interface.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>&lt;C&gt;&nbsp;@Nullable C</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#unwrap(java.lang.Class)" class="member-name-link">unwrap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;C&gt;&nbsp;aClass)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Finds an instance of an interface implemented by this object,
or returns null if this object does not support that interface.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default &lt;C&gt;&nbsp;C</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#unwrapOrThrow(java.lang.Class)" class="member-name-link">unwrapOrThrow</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;C&gt;&nbsp;aClass)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Finds an instance of an interface implemented by this object,
or throws NullPointerException if this object does not support
that interface.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="unwrap(java.lang.Class)">
<h3>unwrap</h3>
<div class="member-signature"><span class="type-parameters">&lt;C&gt;</span>&nbsp;<span class="return-type">@Nullable C</span>&nbsp;<span class="element-name">unwrap</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;C&gt;&nbsp;aClass)</span></div>
<div class="block">Finds an instance of an interface implemented by this object,
or returns null if this object does not support that interface.</div>
</section>
</li>
<li>
<section class="detail" id="unwrapOrThrow(java.lang.Class)">
<h3>unwrapOrThrow</h3>
<div class="member-signature"><span class="annotations">@API(since="1.27",
status=INTERNAL)
</span><span class="modifiers">default</span>&nbsp;<span class="type-parameters">&lt;C&gt;</span>&nbsp;<span class="return-type">C</span>&nbsp;<span class="element-name">unwrapOrThrow</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;C&gt;&nbsp;aClass)</span></div>
<div class="block">Finds an instance of an interface implemented by this object,
or throws NullPointerException if this object does not support
that interface.</div>
</section>
</li>
<li>
<section class="detail" id="maybeUnwrap(java.lang.Class)">
<h3>maybeUnwrap</h3>
<div class="member-signature"><span class="annotations">@API(since="1.27",
status=INTERNAL)
</span><span class="modifiers">default</span>&nbsp;<span class="type-parameters">&lt;C&gt;</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;C&gt;</span>&nbsp;<span class="element-name">maybeUnwrap</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;C&gt;&nbsp;aClass)</span></div>
<div class="block">Finds an instance of an interface implemented by this object,
or returns <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html#empty()" title="class or interface in java.util" class="external-link"><code>Optional.empty()</code></a> if this object does not support
that interface.</div>
</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>