Google Git
Sign in
apache / iceberg / refs/heads/asf-site / . / javadoc / 1.5.0 / org / apache / iceberg / MetricsUtil.html
blob: 5b62eba08efd04df7bf7c41483c413d2bb38e1d7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>MetricsUtil</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.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="../../../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.6.1.min.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MetricsUtil";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.iceberg</a></div>
<h2 title="Class MetricsUtil" class="title">Class MetricsUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.MetricsUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">MetricsUtil</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MetricsUtil.ReadableColMetricsStruct.html" title="class in org.apache.iceberg">MetricsUtil.ReadableColMetricsStruct</a></span></code></th>
<td class="colLast">
<div class="block">A struct of readable metric values for a primitive column</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MetricsUtil.ReadableMetricColDefinition.html" title="class in org.apache.iceberg">MetricsUtil.ReadableMetricColDefinition</a></span></code></th>
<td class="colLast">
<div class="block">Fixed definition of a readable metric column, ie a mapping of a raw metric to a readable metric</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="MetricsUtil.ReadableMetricsStruct.html" title="class in org.apache.iceberg">MetricsUtil.ReadableMetricsStruct</a></span></code></th>
<td class="colLast">
<div class="block">A struct, consisting of all <a href="MetricsUtil.ReadableColMetricsStruct.html" title="class in org.apache.iceberg"><code>MetricsUtil.ReadableColMetricsStruct</code></a> for all primitive columns of the
table</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.List&lt;<a href="MetricsUtil.ReadableMetricColDefinition.html" title="class in org.apache.iceberg">MetricsUtil.ReadableMetricColDefinition</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#READABLE_METRIC_COLS">READABLE_METRIC_COLS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#READABLE_METRICS">READABLE_METRICS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="Metrics.html" title="class in org.apache.iceberg">Metrics</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyWithoutFieldCounts(org.apache.iceberg.Metrics,java.util.Set)">copyWithoutFieldCounts</a></span>&#8203;(<a href="Metrics.html" title="class in org.apache.iceberg">Metrics</a>&nbsp;metrics,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;excludedFieldIds)</code></th>
<td class="colLast">
<div class="block">Copies a metrics object without value, NULL and NaN counts for given fields.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="Metrics.html" title="class in org.apache.iceberg">Metrics</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyWithoutFieldCountsAndBounds(org.apache.iceberg.Metrics,java.util.Set)">copyWithoutFieldCountsAndBounds</a></span>&#8203;(<a href="Metrics.html" title="class in org.apache.iceberg">Metrics</a>&nbsp;metrics,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;excludedFieldIds)</code></th>
<td class="colLast">
<div class="block">Copies a metrics object without counts and bounds for given fields.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.util.Map&lt;java.lang.Integer,&#8203;java.lang.Long&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createNanValueCounts(java.util.stream.Stream,org.apache.iceberg.MetricsConfig,org.apache.iceberg.Schema)">createNanValueCounts</a></span>&#8203;(java.util.stream.Stream&lt;<a href="FieldMetrics.html" title="class in org.apache.iceberg">FieldMetrics</a>&lt;?&gt;&gt;&nbsp;fieldMetrics,
<a href="MetricsConfig.html" title="class in org.apache.iceberg">MetricsConfig</a>&nbsp;metricsConfig,
<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;inputSchema)</code></th>
<td class="colLast">
<div class="block">Construct mapping relationship between column id to NaN value counts from input metrics and
metrics config.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="MetricsModes.MetricsMode.html" title="interface in org.apache.iceberg">MetricsModes.MetricsMode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#metricsMode(org.apache.iceberg.Schema,org.apache.iceberg.MetricsConfig,int)">metricsMode</a></span>&#8203;(<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;inputSchema,
<a href="MetricsConfig.html" title="class in org.apache.iceberg">MetricsConfig</a>&nbsp;metricsConfig,
int&nbsp;fieldId)</code></th>
<td class="colLast">
<div class="block">Extract MetricsMode for the given field id from metrics config.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="Schema.html" title="class in org.apache.iceberg">Schema</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readableMetricsSchema(org.apache.iceberg.Schema,org.apache.iceberg.Schema)">readableMetricsSchema</a></span>&#8203;(<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;dataTableSchema,
<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;metadataTableSchema)</code></th>
<td class="colLast">
<div class="block">Calculates a dynamic schema for readable_metrics to add to metadata tables.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="MetricsUtil.ReadableMetricsStruct.html" title="class in org.apache.iceberg">MetricsUtil.ReadableMetricsStruct</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readableMetricsStruct(org.apache.iceberg.Schema,org.apache.iceberg.ContentFile,org.apache.iceberg.types.Types.StructType)">readableMetricsStruct</a></span>&#8203;(<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
<a href="ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a>&lt;?&gt;&nbsp;file,
<a href="types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a>&nbsp;projectedSchema)</code></th>
<td class="colLast">
<div class="block">Return a readable metrics struct row from file metadata</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="READABLE_METRIC_COLS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>READABLE_METRIC_COLS</h4>
<pre>public static final&nbsp;java.util.List&lt;<a href="MetricsUtil.ReadableMetricColDefinition.html" title="class in org.apache.iceberg">MetricsUtil.ReadableMetricColDefinition</a>&gt; READABLE_METRIC_COLS</pre>
</li>
</ul>
<a id="READABLE_METRICS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>READABLE_METRICS</h4>
<pre>public static final&nbsp;java.lang.String READABLE_METRICS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.apache.iceberg.MetricsUtil.READABLE_METRICS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="copyWithoutFieldCounts(org.apache.iceberg.Metrics,java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyWithoutFieldCounts</h4>
<pre class="methodSignature">public static&nbsp;<a href="Metrics.html" title="class in org.apache.iceberg">Metrics</a>&nbsp;copyWithoutFieldCounts&#8203;(<a href="Metrics.html" title="class in org.apache.iceberg">Metrics</a>&nbsp;metrics,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;excludedFieldIds)</pre>
<div class="block">Copies a metrics object without value, NULL and NaN counts for given fields.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>excludedFieldIds</code> - field IDs for which the counts must be dropped</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new metrics object without counts for given fields</dd>
</dl>
</li>
</ul>
<a id="copyWithoutFieldCountsAndBounds(org.apache.iceberg.Metrics,java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyWithoutFieldCountsAndBounds</h4>
<pre class="methodSignature">public static&nbsp;<a href="Metrics.html" title="class in org.apache.iceberg">Metrics</a>&nbsp;copyWithoutFieldCountsAndBounds&#8203;(<a href="Metrics.html" title="class in org.apache.iceberg">Metrics</a>&nbsp;metrics,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;excludedFieldIds)</pre>
<div class="block">Copies a metrics object without counts and bounds for given fields.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>excludedFieldIds</code> - field IDs for which the counts and bounds must be dropped</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new metrics object without lower and upper bounds for given fields</dd>
</dl>
</li>
</ul>
<a id="createNanValueCounts(java.util.stream.Stream,org.apache.iceberg.MetricsConfig,org.apache.iceberg.Schema)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createNanValueCounts</h4>
<pre class="methodSignature">public static&nbsp;java.util.Map&lt;java.lang.Integer,&#8203;java.lang.Long&gt;&nbsp;createNanValueCounts&#8203;(java.util.stream.Stream&lt;<a href="FieldMetrics.html" title="class in org.apache.iceberg">FieldMetrics</a>&lt;?&gt;&gt;&nbsp;fieldMetrics,
<a href="MetricsConfig.html" title="class in org.apache.iceberg">MetricsConfig</a>&nbsp;metricsConfig,
<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;inputSchema)</pre>
<div class="block">Construct mapping relationship between column id to NaN value counts from input metrics and
metrics config.</div>
</li>
</ul>
<a id="metricsMode(org.apache.iceberg.Schema,org.apache.iceberg.MetricsConfig,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>metricsMode</h4>
<pre class="methodSignature">public static&nbsp;<a href="MetricsModes.MetricsMode.html" title="interface in org.apache.iceberg">MetricsModes.MetricsMode</a>&nbsp;metricsMode&#8203;(<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;inputSchema,
<a href="MetricsConfig.html" title="class in org.apache.iceberg">MetricsConfig</a>&nbsp;metricsConfig,
int&nbsp;fieldId)</pre>
<div class="block">Extract MetricsMode for the given field id from metrics config.</div>
</li>
</ul>
<a id="readableMetricsSchema(org.apache.iceberg.Schema,org.apache.iceberg.Schema)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readableMetricsSchema</h4>
<pre class="methodSignature">public static&nbsp;<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;readableMetricsSchema&#8203;(<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;dataTableSchema,
<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;metadataTableSchema)</pre>
<div class="block">Calculates a dynamic schema for readable_metrics to add to metadata tables. The type will be
the struct <a href="MetricsUtil.ReadableColMetricsStruct.html" title="class in org.apache.iceberg"><code>MetricsUtil.ReadableColMetricsStruct</code></a>, composed of <a href="MetricsUtil.ReadableMetricsStruct.html" title="class in org.apache.iceberg"><code>MetricsUtil.ReadableMetricsStruct</code></a> for all
primitive columns in the data table</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataTableSchema</code> - schema of data table</dd>
<dd><code>metadataTableSchema</code> - schema of existing metadata table (to ensure id uniqueness)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>schema of readable_metrics struct</dd>
</dl>
</li>
</ul>
<a id="readableMetricsStruct(org.apache.iceberg.Schema,org.apache.iceberg.ContentFile,org.apache.iceberg.types.Types.StructType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readableMetricsStruct</h4>
<pre class="methodSignature">public static&nbsp;<a href="MetricsUtil.ReadableMetricsStruct.html" title="class in org.apache.iceberg">MetricsUtil.ReadableMetricsStruct</a>&nbsp;readableMetricsStruct&#8203;(<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
<a href="ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a>&lt;?&gt;&nbsp;file,
<a href="types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a>&nbsp;projectedSchema)</pre>
<div class="block">Return a readable metrics struct row from file metadata</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - schema of original data table</dd>
<dd><code>file</code> - content file with metrics</dd>
<dd><code>projectedSchema</code> - user requested projection</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="MetricsUtil.ReadableMetricsStruct.html" title="class in org.apache.iceberg"><code>MetricsUtil.ReadableMetricsStruct</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>
</footer>
</body>
</html>