blob: 78012473459d50e59cfb0146902206db3a5d06f4 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Spark3SortStrategy</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.5.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="Spark3SortStrategy";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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>Nested&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="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.spark.actions</a></div>
<h2 title="Class Spark3SortStrategy" class="title">Class Spark3SortStrategy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../actions/BinPackStrategy.html" title="class in org.apache.iceberg.actions">org.apache.iceberg.actions.BinPackStrategy</a></li>
<li>
<ul class="inheritance">
<li><a href="../../actions/SortStrategy.html" title="class in org.apache.iceberg.actions">org.apache.iceberg.actions.SortStrategy</a></li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.spark.actions.Spark3SortStrategy</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code><a href="../../actions/RewriteStrategy.html" title="interface in org.apache.iceberg.actions">RewriteStrategy</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">Spark3SortStrategy</span>
extends <a href="../../actions/SortStrategy.html" title="class in org.apache.iceberg.actions">SortStrategy</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.iceberg.spark.actions.Spark3SortStrategy">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<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.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#COMPRESSION_FACTOR">COMPRESSION_FACTOR</a></span></code></th>
<td class="colLast">
<div class="block">The number of shuffle partitions and consequently the number of output files
created by the Spark Sort is based on the size of the input data files used
in this rewrite operation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.iceberg.actions.SortStrategy">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.iceberg.actions.<a href="../../actions/SortStrategy.html" title="class in org.apache.iceberg.actions">SortStrategy</a></h3>
<code><a href="../../actions/SortStrategy.html#REWRITE_ALL">REWRITE_ALL</a>, <a href="../../actions/SortStrategy.html#REWRITE_ALL_DEFAULT">REWRITE_ALL_DEFAULT</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.iceberg.actions.BinPackStrategy">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.iceberg.actions.<a href="../../actions/BinPackStrategy.html" title="class in org.apache.iceberg.actions">BinPackStrategy</a></h3>
<code><a href="../../actions/BinPackStrategy.html#DELETE_FILE_THRESHOLD">DELETE_FILE_THRESHOLD</a>, <a href="../../actions/BinPackStrategy.html#DELETE_FILE_THRESHOLD_DEFAULT">DELETE_FILE_THRESHOLD_DEFAULT</a>, <a href="../../actions/BinPackStrategy.html#MAX_FILE_SIZE_BYTES">MAX_FILE_SIZE_BYTES</a>, <a href="../../actions/BinPackStrategy.html#MAX_FILE_SIZE_DEFAULT_RATIO">MAX_FILE_SIZE_DEFAULT_RATIO</a>, <a href="../../actions/BinPackStrategy.html#MIN_FILE_SIZE_BYTES">MIN_FILE_SIZE_BYTES</a>, <a href="../../actions/BinPackStrategy.html#MIN_FILE_SIZE_DEFAULT_RATIO">MIN_FILE_SIZE_DEFAULT_RATIO</a>, <a href="../../actions/BinPackStrategy.html#MIN_INPUT_FILES">MIN_INPUT_FILES</a>, <a href="../../actions/BinPackStrategy.html#MIN_INPUT_FILES_DEFAULT">MIN_INPUT_FILES_DEFAULT</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.iceberg.Table,org.apache.spark.sql.SparkSession)">Spark3SortStrategy</a></span>&#8203;(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table,
org.apache.spark.sql.SparkSession&nbsp;spark)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</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="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><a href="../../actions/RewriteStrategy.html" title="interface in org.apache.iceberg.actions">RewriteStrategy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#options(java.util.Map)">options</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;options)</code></th>
<td class="colLast">
<div class="block">Sets options to be used with this strategy</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rewriteFiles(java.util.List)">rewriteFiles</a></span>&#8203;(java.util.List&lt;<a href="../../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>&gt;&nbsp;filesToRewrite)</code></th>
<td class="colLast">
<div class="block">Method which will rewrite files based on this particular RewriteStrategy's algorithm.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected org.apache.spark.sql.catalyst.plans.logical.LogicalPlan</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sortPlan(org.apache.spark.sql.connector.distributions.Distribution,org.apache.spark.sql.connector.expressions.SortOrder%5B%5D,org.apache.spark.sql.catalyst.plans.logical.LogicalPlan,org.apache.spark.sql.internal.SQLConf)">sortPlan</a></span>&#8203;(org.apache.spark.sql.connector.distributions.Distribution&nbsp;distribution,
org.apache.spark.sql.connector.expressions.SortOrder[]&nbsp;ordering,
org.apache.spark.sql.catalyst.plans.logical.LogicalPlan&nbsp;plan,
org.apache.spark.sql.internal.SQLConf&nbsp;conf)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected org.apache.spark.sql.SparkSession</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#spark()">spark</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../Table.html" title="interface in org.apache.iceberg">Table</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#table()">table</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the table being modified by this rewrite strategy</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validOptions()">validOptions</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a set of options which this rewrite strategy can use.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.actions.SortStrategy">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.iceberg.actions.<a href="../../actions/SortStrategy.html" title="class in org.apache.iceberg.actions">SortStrategy</a></h3>
<code><a href="../../actions/SortStrategy.html#name()">name</a>, <a href="../../actions/SortStrategy.html#planFileGroups(java.lang.Iterable)">planFileGroups</a>, <a href="../../actions/SortStrategy.html#selectFilesToRewrite(java.lang.Iterable)">selectFilesToRewrite</a>, <a href="../../actions/SortStrategy.html#sortOrder()">sortOrder</a>, <a href="../../actions/SortStrategy.html#sortOrder(org.apache.iceberg.SortOrder)">sortOrder</a>, <a href="../../actions/SortStrategy.html#validateOptions()">validateOptions</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.actions.BinPackStrategy">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.iceberg.actions.<a href="../../actions/BinPackStrategy.html" title="class in org.apache.iceberg.actions">BinPackStrategy</a></h3>
<code><a href="../../actions/BinPackStrategy.html#inputFileSize(java.util.List)">inputFileSize</a>, <a href="../../actions/BinPackStrategy.html#maxGroupSize()">maxGroupSize</a>, <a href="../../actions/BinPackStrategy.html#numOutputFiles(long)">numOutputFiles</a>, <a href="../../actions/BinPackStrategy.html#splitSize(long)">splitSize</a>, <a href="../../actions/BinPackStrategy.html#targetFileSize()">targetFileSize</a>, <a href="../../actions/BinPackStrategy.html#writeMaxFileSize()">writeMaxFileSize</a></code></li>
</ul>
<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 role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="COMPRESSION_FACTOR">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>COMPRESSION_FACTOR</h4>
<pre>public static final&nbsp;java.lang.String COMPRESSION_FACTOR</pre>
<div class="block">The number of shuffle partitions and consequently the number of output files
created by the Spark Sort is based on the size of the input data files used
in this rewrite operation. Due to compression, the disk file sizes may not
accurately represent the size of files in the output. This parameter lets
the user adjust the file size used for estimating actual output data size. A
factor greater than 1.0 would generate more files than we would expect based
on the on-disk file size. A value less than 1.0 would create fewer files than
we would expect due to the on-disk size.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.iceberg.spark.actions.Spark3SortStrategy.COMPRESSION_FACTOR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.iceberg.Table,org.apache.spark.sql.SparkSession)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Spark3SortStrategy</h4>
<pre>public&nbsp;Spark3SortStrategy&#8203;(<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table,
org.apache.spark.sql.SparkSession&nbsp;spark)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="table()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>table</h4>
<pre class="methodSignature">public&nbsp;<a href="../../Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../actions/RewriteStrategy.html#table()">RewriteStrategy</a></code></span></div>
<div class="block">Returns the table being modified by this rewrite strategy</div>
</li>
</ul>
<a id="validOptions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validOptions</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;validOptions()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../actions/RewriteStrategy.html#validOptions()">RewriteStrategy</a></code></span></div>
<div class="block">Returns a set of options which this rewrite strategy can use. This is an allowed-list and any options not
specified here will be rejected at runtime.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../actions/RewriteStrategy.html#validOptions()">validOptions</a></code>&nbsp;in interface&nbsp;<code><a href="../../actions/RewriteStrategy.html" title="interface in org.apache.iceberg.actions">RewriteStrategy</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../actions/SortStrategy.html#validOptions()">validOptions</a></code>&nbsp;in class&nbsp;<code><a href="../../actions/SortStrategy.html" title="class in org.apache.iceberg.actions">SortStrategy</a></code></dd>
</dl>
</li>
</ul>
<a id="options(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>options</h4>
<pre class="methodSignature">public&nbsp;<a href="../../actions/RewriteStrategy.html" title="interface in org.apache.iceberg.actions">RewriteStrategy</a>&nbsp;options&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;options)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../actions/RewriteStrategy.html#options(java.util.Map)">RewriteStrategy</a></code></span></div>
<div class="block">Sets options to be used with this strategy</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../actions/RewriteStrategy.html#options(java.util.Map)">options</a></code>&nbsp;in interface&nbsp;<code><a href="../../actions/RewriteStrategy.html" title="interface in org.apache.iceberg.actions">RewriteStrategy</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../actions/SortStrategy.html#options(java.util.Map)">options</a></code>&nbsp;in class&nbsp;<code><a href="../../actions/SortStrategy.html" title="class in org.apache.iceberg.actions">SortStrategy</a></code></dd>
</dl>
</li>
</ul>
<a id="rewriteFiles(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rewriteFiles</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;<a href="../../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>&gt;&nbsp;rewriteFiles&#8203;(java.util.List&lt;<a href="../../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>&gt;&nbsp;filesToRewrite)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../actions/RewriteStrategy.html#rewriteFiles(java.util.List)">RewriteStrategy</a></code></span></div>
<div class="block">Method which will rewrite files based on this particular RewriteStrategy's algorithm.
This will most likely be Action framework specific (Spark/Presto/Flink ....).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filesToRewrite</code> - a group of files to be rewritten together</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a set of newly written files</dd>
</dl>
</li>
</ul>
<a id="spark()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spark</h4>
<pre class="methodSignature">protected&nbsp;org.apache.spark.sql.SparkSession&nbsp;spark()</pre>
</li>
</ul>
<a id="sortPlan(org.apache.spark.sql.connector.distributions.Distribution,org.apache.spark.sql.connector.expressions.SortOrder[],org.apache.spark.sql.catalyst.plans.logical.LogicalPlan,org.apache.spark.sql.internal.SQLConf)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sortPlan</h4>
<pre class="methodSignature">protected&nbsp;org.apache.spark.sql.catalyst.plans.logical.LogicalPlan&nbsp;sortPlan&#8203;(org.apache.spark.sql.connector.distributions.Distribution&nbsp;distribution,
org.apache.spark.sql.connector.expressions.SortOrder[]&nbsp;ordering,
org.apache.spark.sql.catalyst.plans.logical.LogicalPlan&nbsp;plan,
org.apache.spark.sql.internal.SQLConf&nbsp;conf)</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="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>Nested&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="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>