Google Git
Sign in
apache / calcite-site / 86a9751a303872bad8b062b0a727a3375ad9eaa7 / . / apidocs / org / apache / calcite / schema / SchemaPlus.html
blob: d79f89c45e634c3e5e98bd985010e83618198173 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SchemaPlus (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="SchemaPlus (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/SchemaPlus.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>Constr&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>Constr&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</a></div>
<h2 title="Interface SchemaPlus" class="title">Interface SchemaPlus</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../jdbc/CalciteSchema.SchemaPlusImpl.html" title="class in org.apache.calcite.jdbc">CalciteSchema.SchemaPlusImpl</a></code>, <code><a href="../prepare/RelOptTableImpl.MySchemaPlus.html" title="class in org.apache.calcite.prepare">RelOptTableImpl.MySchemaPlus</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">SchemaPlus</span>
extends <a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a></pre>
<div class="block">Extension to the <a href="Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> interface.
<p>Given a user-defined schema that implements the <a href="Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a> interface,
Calcite creates a wrapper that implements the <code>SchemaPlus</code> interface.
This provides extra functionality, such as access to tables that have been
added explicitly.
<p>A user-defined schema does not need to implement this interface, but by
the time a schema is passed to a method in a user-defined schema or
user-defined table, it will have been wrapped in this interface.
<p>SchemaPlus is intended to be used by users but not instantiated by them.
Users should only use the SchemaPlus they are given by the system.
The purpose of SchemaPlus is to expose to user code, in a read only manner,
some of the extra information about schemas that Calcite builds up when a
schema is registered. It appears in several SPI calls as context; for example
<a href="SchemaFactory.html#create(org.apache.calcite.schema.SchemaPlus,java.lang.String,java.util.Map)"><code>SchemaFactory.create(SchemaPlus, String, java.util.Map)</code></a> contains a
parent schema that might be a wrapped instance of a user-defined
<a href="Schema.html" title="interface in org.apache.calcite.schema"><code>Schema</code></a>, or indeed might not.</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>
<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>
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,org.apache.calcite.materialize.Lattice)">add</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="../materialize/Lattice.html" title="class in org.apache.calcite.materialize">Lattice</a>&nbsp;lattice)</code></th>
<td class="colLast">
<div class="block">Adds a lattice to this schema.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,org.apache.calcite.rel.type.RelProtoDataType)">add</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a>&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Adds a type to this schema.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,org.apache.calcite.schema.Function)">add</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="Function.html" title="interface in org.apache.calcite.schema">Function</a>&nbsp;function)</code></th>
<td class="colLast">
<div class="block">Adds a function to this schema.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,org.apache.calcite.schema.Schema)">add</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a>&nbsp;schema)</code></th>
<td class="colLast">
<div class="block">Adds a schema as a sub-schema of this schema, and returns the wrapped
object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,org.apache.calcite.schema.Table)">add</a></span>&#8203;(java.lang.String&nbsp;name,
<a href="Table.html" title="interface in org.apache.calcite.schema">Table</a>&nbsp;table)</code></th>
<td class="colLast">
<div class="block">Adds a table to this schema.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the name of this schema.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParentSchema()">getParentSchema</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the parent schema, or null if this schema has no parent.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</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="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCacheEnabled()">isCacheEnabled</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" 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="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheEnabled(boolean)">setCacheEnabled</a></span>&#8203;(boolean&nbsp;cache)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPath(com.google.common.collect.ImmutableList)">setPath</a></span>&#8203;(com.google.common.collect.ImmutableList&lt;com.google.common.collect.ImmutableList&lt;java.lang.String&gt;&gt;&nbsp;path)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unwrap(java.lang.Class)">unwrap</a></span>&#8203;(java.lang.Class&lt;T&gt;&nbsp;clazz)</code></th>
<td class="colLast">
<div class="block">Returns an underlying object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.schema.Schema">
<!-- -->
</a>
<h3>Methods 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.html#getExpression(org.apache.calcite.schema.SchemaPlus,java.lang.String)">getExpression</a>, <a href="Schema.html#getFunctionNames()">getFunctionNames</a>, <a href="Schema.html#getFunctions(java.lang.String)">getFunctions</a>, <a href="Schema.html#getSubSchemaNames()">getSubSchemaNames</a>, <a href="Schema.html#getTable(java.lang.String)">getTable</a>, <a href="Schema.html#getTableNames()">getTableNames</a>, <a href="Schema.html#getType(java.lang.String)">getType</a>, <a href="Schema.html#getTypeNames()">getTypeNames</a>, <a href="Schema.html#snapshot(org.apache.calcite.schema.SchemaVersion)">snapshot</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getParentSchema()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentSchema</h4>
<pre class="methodSignature"><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;getParentSchema()</pre>
<div class="block">Returns the parent schema, or null if this schema has no parent.</div>
</li>
</ul>
<a id="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">java.lang.String&nbsp;getName()</pre>
<div class="block">Returns the name of this schema.
<p>The name must not be null, and must be unique within its parent.
The root schema is typically named "".</div>
</li>
</ul>
<a id="getSubSchema(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubSchema</h4>
<pre class="methodSignature"><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</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>
<a id="add(java.lang.String,org.apache.calcite.schema.Schema)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;add&#8203;(java.lang.String&nbsp;name,
<a href="Schema.html" title="interface in org.apache.calcite.schema">Schema</a>&nbsp;schema)</pre>
<div class="block">Adds a schema as a sub-schema of this schema, and returns the wrapped
object.</div>
</li>
</ul>
<a id="add(java.lang.String,org.apache.calcite.schema.Table)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">void&nbsp;add&#8203;(java.lang.String&nbsp;name,
<a href="Table.html" title="interface in org.apache.calcite.schema">Table</a>&nbsp;table)</pre>
<div class="block">Adds a table to this schema.</div>
</li>
</ul>
<a id="add(java.lang.String,org.apache.calcite.schema.Function)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">void&nbsp;add&#8203;(java.lang.String&nbsp;name,
<a href="Function.html" title="interface in org.apache.calcite.schema">Function</a>&nbsp;function)</pre>
<div class="block">Adds a function to this schema.</div>
</li>
</ul>
<a id="add(java.lang.String,org.apache.calcite.rel.type.RelProtoDataType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">void&nbsp;add&#8203;(java.lang.String&nbsp;name,
<a href="../rel/type/RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a>&nbsp;type)</pre>
<div class="block">Adds a type to this schema.</div>
</li>
</ul>
<a id="add(java.lang.String,org.apache.calcite.materialize.Lattice)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">void&nbsp;add&#8203;(java.lang.String&nbsp;name,
<a href="../materialize/Lattice.html" title="class in org.apache.calcite.materialize">Lattice</a>&nbsp;lattice)</pre>
<div class="block">Adds a lattice to this schema.</div>
</li>
</ul>
<a id="isMutable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMutable</h4>
<pre class="methodSignature">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="unwrap(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unwrap</h4>
<pre class="methodSignature">&lt;T&gt;&nbsp;T&nbsp;unwrap&#8203;(java.lang.Class&lt;T&gt;&nbsp;clazz)</pre>
<div class="block">Returns an underlying object.</div>
</li>
</ul>
<a id="setPath(com.google.common.collect.ImmutableList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPath</h4>
<pre class="methodSignature">void&nbsp;setPath&#8203;(com.google.common.collect.ImmutableList&lt;com.google.common.collect.ImmutableList&lt;java.lang.String&gt;&gt;&nbsp;path)</pre>
</li>
</ul>
<a id="setCacheEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCacheEnabled</h4>
<pre class="methodSignature">void&nbsp;setCacheEnabled&#8203;(boolean&nbsp;cache)</pre>
</li>
</ul>
<a id="isCacheEnabled()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isCacheEnabled</h4>
<pre class="methodSignature">boolean&nbsp;isCacheEnabled()</pre>
</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/SchemaPlus.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>Constr&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>Constr&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>