http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/api/FilterParser.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/FilterParser.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/FilterParser.html new file mode 100644 index 0000000..fe703c6 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/FilterParser.html @@ -0,0 +1,354 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>FilterParser</title> +<meta name="date" content="2016-04-20"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="FilterParser"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/BadRecordException.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.BasicFilter.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/FilterParser.html" target="_top">Frames</a></li> +<li><a href="FilterParser.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.api</div> +<h2 title="Class FilterParser" class="title">Class FilterParser</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.api.FilterParser</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FilterParser</span> +extends java.lang.Object</pre> +<div class="block">The parser code which goes over a filter string and pushes operands onto a stack. + Once an operation is read, the evaluate function is called for the <a href="../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api"><code>FilterParser.FilterBuilder</code></a> + interface with two pop-ed operands. + <br> + A string of filters looks like this: + <code>a2c5o1a1c"abc"o2o7</code> + which means <code>column#2 < 5 AND column#1 > "abc"</code> + <br> + It is a RPN serialized representation of a filters tree in GPDB where + <ul> + <li> a means an attribute (column)</li> + <li>c means a constant (either string or numeric)</li> + <li>o means operator</li> + </ul> + + Assuming all operators are binary, RPN representation allows it to be read left to right easily. + <br> + FilterParser only knows about columns and constants. The rest is up to the <a href="../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api"><code>FilterParser.FilterBuilder</code></a> implementer. + FilterParser makes sure column objects are always on the left of the expression (when relevant).</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.BasicFilter.html" title="class in org.apache.hawq.pxf.api">FilterParser.BasicFilter</a></span></code> +<div class="block">Basic filter provided for cases where the target storage system does not provide it own filter + For example: Hbase storage provides its own filter but for a Writable based record in a + SequenceFile there is no filter provided and so we need to have a default</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.ColumnIndex.html" title="class in org.apache.hawq.pxf.api">FilterParser.ColumnIndex</a></span></code> +<div class="block">Represents a column index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.Constant.html" title="class in org.apache.hawq.pxf.api">FilterParser.Constant</a></span></code> +<div class="block">Represents a constant object (String, Long, ...).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a></span></code> +<div class="block">Interface a user of FilterParser should implement.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.Operation.html" title="enum in org.apache.hawq.pxf.api">FilterParser.Operation</a></span></code> +<div class="block">Supported operations by the parser.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.html#FilterParser-org.apache.hawq.pxf.api.FilterParser.FilterBuilder-">FilterParser</a></span>(<a href="../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a> eval)</code> +<div class="block">Constructs a FilterParser.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.html#parse-java.lang.String-">parse</a></span>(java.lang.String filter)</code> +<div class="block">Parses the string filter.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FilterParser-org.apache.hawq.pxf.api.FilterParser.FilterBuilder-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FilterParser</h4> +<pre>public FilterParser(<a href="../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a> eval)</pre> +<div class="block">Constructs a FilterParser.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>eval</code> - the filter builder</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="parse-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>parse</h4> +<pre>public java.lang.Object parse(java.lang.String filter) + throws java.lang.Exception</pre> +<div class="block">Parses the string filter.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filter</code> - the filter to parse</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the parsed filter</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if the filter string had wrong syntax</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/BadRecordException.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.BasicFilter.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/FilterParser.html" target="_top">Frames</a></li> +<li><a href="FilterParser.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/api/Fragment.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/Fragment.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/Fragment.html new file mode 100644 index 0000000..a0b4083 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/Fragment.html @@ -0,0 +1,416 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>Fragment</title> +<meta name="date" content="2016-04-20"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Fragment"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.Operation.html" title="enum in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/Fragment.html" target="_top">Frames</a></li> +<li><a href="Fragment.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.api</div> +<h2 title="Class Fragment" class="title">Class Fragment</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.api.Fragment</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Fragment</span> +extends java.lang.Object</pre> +<div class="block">Fragment holds a data fragment' information. + <a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragments--"><code>Fragmenter.getFragments()</code></a> returns a list of fragments.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#Fragment-java.lang.String-java.lang.String:A-byte:A-">Fragment</a></span>(java.lang.String sourceName, + java.lang.String[] hosts, + byte[] metadata)</code> +<div class="block">Constructs a Fragment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#Fragment-java.lang.String-java.lang.String:A-byte:A-byte:A-">Fragment</a></span>(java.lang.String sourceName, + java.lang.String[] hosts, + byte[] metadata, + byte[] userData)</code> +<div class="block">Constructs a Fragment.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#getIndex--">getIndex</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#getMetadata--">getMetadata</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#getReplicas--">getReplicas</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#getSourceName--">getSourceName</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#getUserData--">getUserData</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#setIndex-int-">setIndex</a></span>(int index)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#setMetadata-byte:A-">setMetadata</a></span>(byte[] metadata)</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#setReplicas-java.lang.String:A-">setReplicas</a></span>(java.lang.String[] replicas)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html#setUserData-byte:A-">setUserData</a></span>(byte[] userData)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Fragment-java.lang.String-java.lang.String:A-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Fragment</h4> +<pre>public Fragment(java.lang.String sourceName, + java.lang.String[] hosts, + byte[] metadata)</pre> +<div class="block">Constructs a Fragment.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sourceName</code> - the resource uri (File path+name, table name, etc.)</dd> +<dd><code>hosts</code> - the replicas</dd> +<dd><code>metadata</code> - the meta data (Starting point + length, region location, etc.).</dd> +</dl> +</li> +</ul> +<a name="Fragment-java.lang.String-java.lang.String:A-byte:A-byte:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Fragment</h4> +<pre>public Fragment(java.lang.String sourceName, + java.lang.String[] hosts, + byte[] metadata, + byte[] userData)</pre> +<div class="block">Constructs a Fragment.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sourceName</code> - the resource uri (File path+name, table name, etc.)</dd> +<dd><code>hosts</code> - the replicas</dd> +<dd><code>metadata</code> - the meta data (Starting point + length, region location, etc.).</dd> +<dd><code>userData</code> - third party data added to a fragment.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSourceName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSourceName</h4> +<pre>public java.lang.String getSourceName()</pre> +</li> +</ul> +<a name="getIndex--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndex</h4> +<pre>public int getIndex()</pre> +</li> +</ul> +<a name="setIndex-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndex</h4> +<pre>public void setIndex(int index)</pre> +</li> +</ul> +<a name="getReplicas--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicas</h4> +<pre>public java.lang.String[] getReplicas()</pre> +</li> +</ul> +<a name="setReplicas-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReplicas</h4> +<pre>public void setReplicas(java.lang.String[] replicas)</pre> +</li> +</ul> +<a name="getMetadata--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMetadata</h4> +<pre>public byte[] getMetadata()</pre> +</li> +</ul> +<a name="setMetadata-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMetadata</h4> +<pre>public void setMetadata(byte[] metadata)</pre> +</li> +</ul> +<a name="getUserData--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserData</h4> +<pre>public byte[] getUserData()</pre> +</li> +</ul> +<a name="setUserData-byte:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setUserData</h4> +<pre>public void setUserData(byte[] userData)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.Operation.html" title="enum in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/Fragment.html" target="_top">Frames</a></li> +<li><a href="Fragment.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/api/Fragmenter.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/Fragmenter.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/Fragmenter.html new file mode 100644 index 0000000..7444647 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/Fragmenter.html @@ -0,0 +1,380 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>Fragmenter</title> +<meta name="date" content="2016-04-20"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Fragmenter"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/Fragmenter.html" target="_top">Frames</a></li> +<li><a href="Fragmenter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.api</div> +<h2 title="Class Fragmenter" class="title">Class Fragmenter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">org.apache.hawq.pxf.api.utilities.Plugin</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.api.Fragmenter</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hbase">HBaseDataFragmenter</a>, <a href="../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hdfs">HdfsDataFragmenter</a>, <a href="../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hive">HiveDataFragmenter</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">Fragmenter</span> +extends <a href="../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a></pre> +<div class="block">Abstract class that defines the splitting of a data resource into fragments + that can be processed in parallel.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html#fragments">fragments</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.hawq.pxf.api.utilities.Plugin"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.hawq.pxf.api.utilities.<a href="../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a></h3> +<code><a href="../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html#inputData">inputData</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html#Fragmenter-org.apache.hawq.pxf.api.utilities.InputData-">Fragmenter</a></span>(<a href="../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> metaData)</code> +<div class="block">Constructs a Fragmenter.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>abstract java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragments--">getFragments</a></span>()</code> +<div class="block">Gets the fragments of a given path (source name and location of each + fragment).</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api">FragmentsStats</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragmentsStats--">getFragmentsStats</a></span>()</code> +<div class="block">Default implementation of statistics for fragments.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hawq.pxf.api.utilities.Plugin"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hawq.pxf.api.utilities.<a href="../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a></h3> +<code><a href="../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html#isThreadSafe--">isThreadSafe</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="fragments"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fragments</h4> +<pre>protected java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>> fragments</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Fragmenter-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Fragmenter</h4> +<pre>public Fragmenter(<a href="../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> metaData)</pre> +<div class="block">Constructs a Fragmenter.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>metaData</code> - the input data</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getFragments--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFragments</h4> +<pre>public abstract java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>> getFragments() + throws java.lang.Exception</pre> +<div class="block">Gets the fragments of a given path (source name and location of each + fragment). Used to get fragments of data that could be read in parallel + from the different segments.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>list of data fragments</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if fragment list could not be retrieved</dd> +</dl> +</li> +</ul> +<a name="getFragmentsStats--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getFragmentsStats</h4> +<pre>public <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api">FragmentsStats</a> getFragmentsStats() + throws java.lang.Exception</pre> +<div class="block">Default implementation of statistics for fragments. The default is: + <ul> + <li>number of fragments - as gathered by <a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragments--"><code>getFragments()</code></a></li> + <li>first fragment size - 64MB</li> + <li>total size - number of fragments times first fragment size</li> + </ul> + Each fragmenter implementation can override this method to better match + its fragments stats.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>default statistics</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if statistics cannot be gathered</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/Fragmenter.html" target="_top">Frames</a></li> +<li><a href="Fragmenter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html new file mode 100644 index 0000000..2574c39 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html @@ -0,0 +1,343 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>FragmentsStats.SizeAndUnit</title> +<meta name="date" content="2016-04-20"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="FragmentsStats.SizeAndUnit"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html" target="_top">Frames</a></li> +<li><a href="FragmentsStats.SizeAndUnit.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.api</div> +<h2 title="Class FragmentsStats.SizeAndUnit" class="title">Class FragmentsStats.SizeAndUnit</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.api.FragmentsStats.SizeAndUnit</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api">FragmentsStats</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FragmentsStats.SizeAndUnit</span> +extends java.lang.Object</pre> +<div class="block">Container for size and unit</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html#SizeAndUnit--">SizeAndUnit</a></span>()</code> +<div class="block">Default constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html#SizeAndUnit-long-org.apache.hawq.pxf.api.FragmentsStats.SizeUnit-">SizeAndUnit</a></span>(long size, + <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a> unit)</code> +<div class="block">Constructor.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html#getSize--">getSize</a></span>()</code> +<div class="block">Returns size.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html#getUnit--">getUnit</a></span>()</code> +<div class="block">Returns unit (Byte/KB/MB/etc.).</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SizeAndUnit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SizeAndUnit</h4> +<pre>public SizeAndUnit()</pre> +<div class="block">Default constructor.</div> +</li> +</ul> +<a name="SizeAndUnit-long-org.apache.hawq.pxf.api.FragmentsStats.SizeUnit-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SizeAndUnit</h4> +<pre>public SizeAndUnit(long size, + <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a> unit)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>size</code> - size</dd> +<dd><code>unit</code> - unit</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSize</h4> +<pre>public long getSize()</pre> +<div class="block">Returns size.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>size</dd> +</dl> +</li> +</ul> +<a name="getUnit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUnit</h4> +<pre>public <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a> getUnit()</pre> +<div class="block">Returns unit (Byte/KB/MB/etc.).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>unit</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html" target="_top">Frames</a></li> +<li><a href="FragmentsStats.SizeAndUnit.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html new file mode 100644 index 0000000..8943743 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html @@ -0,0 +1,395 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>FragmentsStats.SizeUnit</title> +<meta name="date" content="2016-04-20"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="FragmentsStats.SizeUnit"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":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"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" target="_top">Frames</a></li> +<li><a href="FragmentsStats.SizeUnit.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.api</div> +<h2 title="Enum FragmentsStats.SizeUnit" class="title">Enum FragmentsStats.SizeUnit</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.api.FragmentsStats.SizeUnit</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api">FragmentsStats</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="typeNameLabel">FragmentsStats.SizeUnit</span> +extends java.lang.Enum<<a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a>></pre> +<div class="block">Enum to represent unit (Bytes/KB/MB/GB/TB)</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html#B">B</a></span></code> +<div class="block">Byte</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html#GB">GB</a></span></code> +<div class="block">GB</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html#KB">KB</a></span></code> +<div class="block">KB</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html#MB">MB</a></span></code> +<div class="block">MB</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html#TB">TB</a></span></code> +<div class="block">TB</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="B"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>B</h4> +<pre>public static final <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a> B</pre> +<div class="block">Byte</div> +</li> +</ul> +<a name="KB"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KB</h4> +<pre>public static final <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a> KB</pre> +<div class="block">KB</div> +</li> +</ul> +<a name="MB"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MB</h4> +<pre>public static final <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a> MB</pre> +<div class="block">MB</div> +</li> +</ul> +<a name="GB"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>GB</h4> +<pre>public static final <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a> GB</pre> +<div class="block">GB</div> +</li> +</ul> +<a name="TB"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TB</h4> +<pre>public static final <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a> TB</pre> +<div class="block">TB</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (FragmentsStats.SizeUnit c : FragmentsStats.SizeUnit.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.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"> +<li><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeAndUnit.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" target="_top">Frames</a></li> +<li><a href="FragmentsStats.SizeUnit.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All 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> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
