http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/AvroFileAccessor.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/AvroFileAccessor.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/AvroFileAccessor.html new file mode 100644 index 0000000..0f8ecf8 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/AvroFileAccessor.html @@ -0,0 +1,381 @@ +<!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>AvroFileAccessor</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="AvroFileAccessor"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":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>Prev Class</li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/AvroResolver.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/AvroFileAccessor.html" target="_top">Frames</a></li> +<li><a href="AvroFileAccessor.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="#fields.inherited.from.class.org.apache.hawq.pxf.plugins.hdfs.HdfsSplittableDataAccessor">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>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.plugins.hdfs</div> +<h2 title="Class AvroFileAccessor" class="title">Class AvroFileAccessor</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><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">org.apache.hawq.pxf.plugins.hdfs.HdfsSplittableDataAccessor</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.plugins.hdfs.AvroFileAccessor</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">AvroFileAccessor</span> +extends <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">HdfsSplittableDataAccessor</a></pre> +<div class="block">A PXF Accessor for reading Avro File records</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.hawq.pxf.plugins.hdfs.HdfsSplittableDataAccessor"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.hawq.pxf.plugins.hdfs.<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">HdfsSplittableDataAccessor</a></h3> +<code><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#conf">conf</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#data">data</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#inputFormat">inputFormat</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#iter">iter</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#jobConf">jobConf</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#key">key</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#reader">reader</a></code></li> +</ul> +<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/plugins/hdfs/AvroFileAccessor.html#AvroFileAccessor-org.apache.hawq.pxf.api.utilities.InputData-">AvroFileAccessor</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input)</code> +<div class="block">Constructs a AvroFileAccessor that creates the job configuration and + accesses the avro file to fetch the avro schema</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>protected java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/AvroFileAccessor.html#getReader-org.apache.hadoop.mapred.JobConf-org.apache.hadoop.mapred.InputSplit-">getReader</a></span>(org.apache.hadoop.mapred.JobConf jobConf, + org.apache.hadoop.mapred.InputSplit split)</code> +<div class="block">Specialized accessors will override this method and implement their own + recordReader.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/AvroFileAccessor.html#readNextObject--">readNextObject</a></span>()</code> +<div class="block">readNextObject + The AVRO accessor is currently the only specialized accessor that + overrides this method.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hawq.pxf.plugins.hdfs.HdfsSplittableDataAccessor"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hawq.pxf.plugins.hdfs.<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">HdfsSplittableDataAccessor</a></h3> +<code><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#closeForRead--">closeForRead</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#getNextSplit--">getNextSplit</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#isThreadSafe--">isThreadSafe</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#openForRead--">openForRead</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AvroFileAccessor-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AvroFileAccessor</h4> +<pre>public AvroFileAccessor(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input) + throws java.lang.Exception</pre> +<div class="block">Constructs a AvroFileAccessor that creates the job configuration and + accesses the avro file to fetch the avro schema</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>input</code> - all input parameters coming from the client</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if getting the avro schema fails</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="getReader-org.apache.hadoop.mapred.JobConf-org.apache.hadoop.mapred.InputSplit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReader</h4> +<pre>protected java.lang.Object getReader(org.apache.hadoop.mapred.JobConf jobConf, + org.apache.hadoop.mapred.InputSplit split) + throws java.io.IOException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#getReader-org.apache.hadoop.mapred.JobConf-org.apache.hadoop.mapred.InputSplit-">HdfsSplittableDataAccessor</a></code></span></div> +<div class="block">Specialized accessors will override this method and implement their own + recordReader. For example, a plain delimited text accessor may want to + return a LineRecordReader.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#getReader-org.apache.hadoop.mapred.JobConf-org.apache.hadoop.mapred.InputSplit-">getReader</a></code> in class <code><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">HdfsSplittableDataAccessor</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jobConf</code> - the hadoop jobconf to use for the selected InputFormat</dd> +<dd><code>split</code> - the input split to be read by the accessor</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a recordreader to be used for reading the data records of the + split</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if recordreader could not be created</dd> +</dl> +</li> +</ul> +<a name="readNextObject--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readNextObject</h4> +<pre>public <a href="../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a> readNextObject() + throws java.io.IOException</pre> +<div class="block">readNextObject + The AVRO accessor is currently the only specialized accessor that + overrides this method. This happens, because the special + AvroRecordReader.next() semantics (use of the AvroWrapper), so it + cannot use the RecordReader's default implementation in + SplittableFileAccessor</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html#readNextObject--">readNextObject</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#readNextObject--">readNextObject</a></code> in class <code><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">HdfsSplittableDataAccessor</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the object which was read</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</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>Prev Class</li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/AvroResolver.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/AvroFileAccessor.html" target="_top">Frames</a></li> +<li><a href="AvroFileAccessor.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="#fields.inherited.from.class.org.apache.hawq.pxf.plugins.hdfs.HdfsSplittableDataAccessor">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>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/plugins/hdfs/AvroResolver.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/AvroResolver.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/AvroResolver.html new file mode 100644 index 0000000..94c19a7 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/AvroResolver.html @@ -0,0 +1,333 @@ +<!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>AvroResolver</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="AvroResolver"; + } + } + 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/plugins/hdfs/AvroFileAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/AvroResolver.html" target="_top">Frames</a></li> +<li><a href="AvroResolver.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="#fields.inherited.from.class.org.apache.hawq.pxf.api.utilities.Plugin">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>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.plugins.hdfs</div> +<h2 title="Class AvroResolver" class="title">Class AvroResolver</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.plugins.hdfs.AvroResolver</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/api/ReadResolver.html" title="interface in org.apache.hawq.pxf.api">ReadResolver</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">AvroResolver</span> +extends <a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a> +implements <a href="../../../../../../org/apache/hawq/pxf/api/ReadResolver.html" title="interface in org.apache.hawq.pxf.api">ReadResolver</a></pre> +<div class="block">Class AvroResolver handles deserialization of records that were serialized + using the AVRO serialization framework.</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> +<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/plugins/hdfs/AvroResolver.html#AvroResolver-org.apache.hawq.pxf.api.utilities.InputData-">AvroResolver</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input)</code> +<div class="block">Constructs an AvroResolver.</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.util.List<<a href="../../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api">OneField</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/AvroResolver.html#getFields-org.apache.hawq.pxf.api.OneRow-">getFields</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a> row)</code> +<div class="block">Returns a list of the fields of one record.</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AvroResolver-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AvroResolver</h4> +<pre>public AvroResolver(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input) + throws java.io.IOException</pre> +<div class="block">Constructs an AvroResolver. Initializes Avro data structure: the Avro + record - fields information and the Avro record reader. All Avro data is + build from the Avro schema, which is based on the *.avsc file that was + passed by the user</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>input</code> - all input parameters coming from the client</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if Avro schema could not be retrieved or parsed</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="getFields-org.apache.hawq.pxf.api.OneRow-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getFields</h4> +<pre>public java.util.List<<a href="../../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api">OneField</a>> getFields(<a href="../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a> row) + throws java.lang.Exception</pre> +<div class="block">Returns a list of the fields of one record. Each record field is + represented by a OneField item. OneField item contains two fields: an + integer representing the field type and a Java Object representing the + field value.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadResolver.html#getFields-org.apache.hawq.pxf.api.OneRow-">getFields</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/ReadResolver.html" title="interface in org.apache.hawq.pxf.api">ReadResolver</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - the row to get the fields from</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api"><code>OneField</code></a> list of one row.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if decomposing the row into fields failed</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/plugins/hdfs/AvroFileAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/AvroResolver.html" target="_top">Frames</a></li> +<li><a href="AvroResolver.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="#fields.inherited.from.class.org.apache.hawq.pxf.api.utilities.Plugin">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>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/plugins/hdfs/ChunkReader.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html new file mode 100644 index 0000000..dfa941d --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html @@ -0,0 +1,397 @@ +<!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>ChunkReader</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="ChunkReader"; + } + } + 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/plugins/hdfs/AvroResolver.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html" target="_top">Frames</a></li> +<li><a href="ChunkReader.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.plugins.hdfs</div> +<h2 title="Class ChunkReader" class="title">Class ChunkReader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.plugins.hdfs.ChunkReader</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Closeable, java.lang.AutoCloseable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ChunkReader</span> +extends java.lang.Object +implements java.io.Closeable</pre> +<div class="block">A class that provides a line reader from an input stream. Lines are + terminated by '\n' (LF) EOF also terminates an otherwise unterminated line.</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>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html#DEFAULT_BUFFER_SIZE">DEFAULT_BUFFER_SIZE</a></span></code> </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/plugins/hdfs/ChunkReader.html#ChunkReader-java.io.InputStream-">ChunkReader</a></span>(java.io.InputStream in)</code> +<div class="block">Constructs a ChunkReader instance</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html#close--">close</a></span>()</code> +<div class="block">Closes the underlying stream.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html#readChunk-org.apache.hadoop.io.Writable-int-">readChunk</a></span>(org.apache.hadoop.io.Writable str, + int maxBytesToConsume)</code> +<div class="block">Reads data in chunks of DEFAULT_CHUNK_SIZE, until we reach + maxBytesToConsume.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html#readLine-org.apache.hadoop.io.Writable-int-">readLine</a></span>(org.apache.hadoop.io.Writable str, + int maxBytesToConsume)</code> +<div class="block">Reads a line terminated by LF.</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DEFAULT_BUFFER_SIZE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_BUFFER_SIZE</h4> +<pre>public static final int DEFAULT_BUFFER_SIZE</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../constant-values.html#org.apache.hawq.pxf.plugins.hdfs.ChunkReader.DEFAULT_BUFFER_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ChunkReader-java.io.InputStream-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ChunkReader</h4> +<pre>public ChunkReader(java.io.InputStream in)</pre> +<div class="block">Constructs a ChunkReader instance</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>in</code> - input stream</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="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<div class="block">Closes the underlying stream.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="readChunk-org.apache.hadoop.io.Writable-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readChunk</h4> +<pre>public int readChunk(org.apache.hadoop.io.Writable str, + int maxBytesToConsume) + throws java.io.IOException</pre> +<div class="block">Reads data in chunks of DEFAULT_CHUNK_SIZE, until we reach + maxBytesToConsume.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>str</code> - - output parameter, will contain the read chunk byte array</dd> +<dd><code>maxBytesToConsume</code> - - requested chunk size</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>actual chunk size</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if the first byte cannot be read for any reason + other than the end of the file, if the input stream has been closed, + or if some other I/O error occurs.</dd> +</dl> +</li> +</ul> +<a name="readLine-org.apache.hadoop.io.Writable-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readLine</h4> +<pre>public int readLine(org.apache.hadoop.io.Writable str, + int maxBytesToConsume) + throws java.io.IOException</pre> +<div class="block">Reads a line terminated by LF.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>str</code> - - output parameter, will contain the read record</dd> +<dd><code>maxBytesToConsume</code> - - the line mustn't exceed this value</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>length of the line read</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if the first byte cannot be read for any reason + other than the end of the file, if the input stream has been closed, + or if some other I/O error occurs.</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/plugins/hdfs/AvroResolver.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/ChunkReader.html" target="_top">Frames</a></li> +<li><a href="ChunkReader.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/plugins/hdfs/ChunkRecordReader.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html new file mode 100644 index 0000000..0b0502b --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html @@ -0,0 +1,462 @@ +<!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>ChunkRecordReader</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="ChunkRecordReader"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/plugins/hdfs/ChunkReader.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html" target="_top">Frames</a></li> +<li><a href="ChunkRecordReader.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.plugins.hdfs</div> +<h2 title="Class ChunkRecordReader" class="title">Class ChunkRecordReader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.plugins.hdfs.ChunkRecordReader</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.LongWritable,<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ChunkRecordReader</span> +extends java.lang.Object +implements org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.LongWritable,<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a>></pre> +<div class="block">ChunkRecordReader is designed for fast reading of a file split. The idea is + to bring chunks of data instead of single records. The chunks contain many + records and the chunk end is not aligned on a record boundary. The size of + the chunk is a class hardcoded parameter - CHUNK_SIZE. This behaviour sets + this reader apart from the other readers which will fetch one record and stop + when reaching a record delimiter.</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/plugins/hdfs/ChunkRecordReader.html#ChunkRecordReader-org.apache.hadoop.conf.Configuration-org.apache.hadoop.mapred.FileSplit-">ChunkRecordReader</a></span>(org.apache.hadoop.conf.Configuration job, + org.apache.hadoop.mapred.FileSplit split)</code> +<div class="block">Constructs a ChunkRecordReader instance.</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html#close--">close</a></span>()</code> +<div class="block">Closes the input stream.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.io.LongWritable</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html#createKey--">createKey</a></span>()</code> +<div class="block">Used by the client of this class to create the 'key' output parameter for + next() method.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html#createValue--">createValue</a></span>()</code> +<div class="block">Used by the client of this class to create the 'value' output parameter + for next() method.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html#getPos--">getPos</a></span>()</code> +<div class="block">Returns the position of the unread tail of the file</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html#getProgress--">getProgress</a></span>()</code> +<div class="block">Gets the progress within the split.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.hdfs.DFSInputStream.ReadStatistics</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html#getReadStatistics--">getReadStatistics</a></span>()</code> +<div class="block">Returns statistics of the input stream's read operation: total bytes + read, bytes read locally, bytes read in short-circuit (directly from file + descriptor).</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html#next-org.apache.hadoop.io.LongWritable-org.apache.hawq.pxf.plugins.hdfs.ChunkWritable-">next</a></span>(org.apache.hadoop.io.LongWritable key, + <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a> value)</code> +<div class="block">Fetches the next data chunk from the file split.</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="ChunkRecordReader-org.apache.hadoop.conf.Configuration-org.apache.hadoop.mapred.FileSplit-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ChunkRecordReader</h4> +<pre>public ChunkRecordReader(org.apache.hadoop.conf.Configuration job, + org.apache.hadoop.mapred.FileSplit split) + throws java.io.IOException</pre> +<div class="block">Constructs a ChunkRecordReader instance.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>job</code> - the job configuration</dd> +<dd><code>split</code> - contains the file name, begin byte of the split and the + bytes length</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if an I/O error occurs when accessing the file or + creating input stream to read from it</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="getReadStatistics--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadStatistics</h4> +<pre>public org.apache.hadoop.hdfs.DFSInputStream.ReadStatistics getReadStatistics()</pre> +<div class="block">Returns statistics of the input stream's read operation: total bytes + read, bytes read locally, bytes read in short-circuit (directly from file + descriptor).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an instance of ReadStatistics class</dd> +</dl> +</li> +</ul> +<a name="createKey--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createKey</h4> +<pre>public org.apache.hadoop.io.LongWritable createKey()</pre> +<div class="block">Used by the client of this class to create the 'key' output parameter for + next() method.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>createKey</code> in interface <code>org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.LongWritable,<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an instance of LongWritable</dd> +</dl> +</li> +</ul> +<a name="createValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createValue</h4> +<pre>public <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a> createValue()</pre> +<div class="block">Used by the client of this class to create the 'value' output parameter + for next() method.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>createValue</code> in interface <code>org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.LongWritable,<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an instance of ChunkWritable</dd> +</dl> +</li> +</ul> +<a name="next-org.apache.hadoop.io.LongWritable-org.apache.hawq.pxf.plugins.hdfs.ChunkWritable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre>public boolean next(org.apache.hadoop.io.LongWritable key, + <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a> value) + throws java.io.IOException</pre> +<div class="block">Fetches the next data chunk from the file split. The size of the chunk is + a class hardcoded parameter - CHUNK_SIZE. This behaviour sets this reader + apart from the other readers which will fetch one record and stop when + reaching a record delimiter.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>next</code> in interface <code>org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.LongWritable,<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a>></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - - output parameter. When method returns will contain the key - + the number of the start byte of the chunk</dd> +<dd><code>value</code> - - output parameter. When method returns will contain the + value - the chunk, a byte array inside the ChunkWritable + instance</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>false - when end of split was reached</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if an I/O error occurred while reading the next chunk + or line</dd> +</dl> +</li> +</ul> +<a name="getProgress--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProgress</h4> +<pre>public float getProgress() + throws java.io.IOException</pre> +<div class="block">Gets the progress within the split.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>getProgress</code> in interface <code>org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.LongWritable,<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="getPos--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPos</h4> +<pre>public long getPos() + throws java.io.IOException</pre> +<div class="block">Returns the position of the unread tail of the file</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>getPos</code> in interface <code>org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.LongWritable,<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a>></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>pos - start byte of the unread tail of the file</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<div class="block">Closes the input stream.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>close</code> in interface <code>org.apache.hadoop.mapred.RecordReader<org.apache.hadoop.io.LongWritable,<a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs">ChunkWritable</a>></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</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/plugins/hdfs/ChunkReader.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/ChunkRecordReader.html" target="_top">Frames</a></li> +<li><a href="ChunkRecordReader.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/plugins/hdfs/ChunkWritable.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html new file mode 100644 index 0000000..da72fdf --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html @@ -0,0 +1,349 @@ +<!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>ChunkWritable</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="ChunkWritable"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":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/plugins/hdfs/ChunkRecordReader.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsAtomicDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" target="_top">Frames</a></li> +<li><a href="ChunkWritable.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.plugins.hdfs</div> +<h2 title="Class ChunkWritable" class="title">Class ChunkWritable</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.plugins.hdfs.ChunkWritable</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.hadoop.io.Writable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ChunkWritable</span> +extends java.lang.Object +implements org.apache.hadoop.io.Writable</pre> +<div class="block">Just an output buffer for the ChunkRecordReader. It must extend Writable + otherwise it will not fit into the next() interface method</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>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html#box">box</a></span></code> </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/plugins/hdfs/ChunkWritable.html#ChunkWritable--">ChunkWritable</a></span>()</code> </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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html#readFields-java.io.DataInput-">readFields</a></span>(java.io.DataInput in)</code> +<div class="block">Deserializes the fields of this object from <code>in</code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html#write-java.io.DataOutput-">write</a></span>(java.io.DataOutput out)</code> +<div class="block">Serializes the fields of this object to <code>out</code>.</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="box"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>box</h4> +<pre>public byte[] box</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ChunkWritable--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ChunkWritable</h4> +<pre>public ChunkWritable()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="write-java.io.DataOutput-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(java.io.DataOutput out)</pre> +<div class="block">Serializes the fields of this object to <code>out</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>write</code> in interface <code>org.apache.hadoop.io.Writable</code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - <code>DataOutput</code> to serialize this object into.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - this function is not supported</dd> +</dl> +</li> +</ul> +<a name="readFields-java.io.DataInput-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readFields</h4> +<pre>public void readFields(java.io.DataInput in)</pre> +<div class="block">Deserializes the fields of this object from <code>in</code>. + <p>For efficiency, implementations should attempt to re-use storage in the + existing object where possible.</p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>readFields</code> in interface <code>org.apache.hadoop.io.Writable</code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>in</code> - <code>DataInput</code> to deserialize this object from.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.UnsupportedOperationException</code> - this function is not supported</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/plugins/hdfs/ChunkRecordReader.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsAtomicDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/ChunkWritable.html" target="_top">Frames</a></li> +<li><a href="ChunkWritable.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>
