http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsAtomicDataAccessor.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsAtomicDataAccessor.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsAtomicDataAccessor.html new file mode 100644 index 0000000..74303c8 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsAtomicDataAccessor.html @@ -0,0 +1,432 @@ +<!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>HdfsAtomicDataAccessor</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="HdfsAtomicDataAccessor"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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/ChunkWritable.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/HdfsDataFragmenter.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/HdfsAtomicDataAccessor.html" target="_top">Frames</a></li> +<li><a href="HdfsAtomicDataAccessor.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 HdfsAtomicDataAccessor" class="title">Class HdfsAtomicDataAccessor</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.HdfsAtomicDataAccessor</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> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/QuotedLineBreakAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">QuotedLineBreakAccessor</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">HdfsAtomicDataAccessor</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/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></pre> +<div class="block">Base class for enforcing the complete access of a file in one accessor. + Since we are not accessing the file using the splittable API, but instead are + using the "simple" stream API, it means that we cannot fetch different parts + (splits) of the file in different segments. Instead each file access brings + the complete file. And, if several segments would access the same file, then + each one will return the whole file and we will observe in the query result, + each record appearing number_of_segments times. To avoid this we will only + have one segment (segment 0) working for this case - enforced with + isWorkingSegment() method. Naturally this is the less recommended working + mode since we are not making use of segment parallelism. HDFS accessors for + a specific file type should inherit from this class only if the file they are + reading does not support splitting: a protocol-buffer file, regular file, ...</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.io.InputStream</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsAtomicDataAccessor.html#inp">inp</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/plugins/hdfs/HdfsAtomicDataAccessor.html#HdfsAtomicDataAccessor-org.apache.hawq.pxf.api.utilities.InputData-">HdfsAtomicDataAccessor</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 HdfsAtomicDataAccessor object.</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/HdfsAtomicDataAccessor.html#closeForRead--">closeForRead</a></span>()</code> +<div class="block">Closes the access stream when finished reading the file</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsAtomicDataAccessor.html#isThreadSafe--">isThreadSafe</a></span>()</code> +<div class="block">Checks if the plugin is thread safe or not, based on inputData.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsAtomicDataAccessor.html#openForRead--">openForRead</a></span>()</code> +<div class="block">Opens the file using the non-splittable API for HADOOP HDFS file access + This means that instead of using a FileInputFormat for access, we use a + Java stream.</div> +</td> +</tr> +<tr id="i3" 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/HdfsAtomicDataAccessor.html#readNextObject--">readNextObject</a></span>()</code> +<div class="block">Fetches one record from the file.</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="inp"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>inp</h4> +<pre>protected java.io.InputStream inp</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HdfsAtomicDataAccessor-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HdfsAtomicDataAccessor</h4> +<pre>public HdfsAtomicDataAccessor(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input)</pre> +<div class="block">Constructs a HdfsAtomicDataAccessor object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>input</code> - all input parameters coming from the client</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="openForRead--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openForRead</h4> +<pre>public boolean openForRead() + throws java.lang.Exception</pre> +<div class="block">Opens the file using the non-splittable API for HADOOP HDFS file access + This means that instead of using a FileInputFormat for access, we use a + Java stream.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html#openForRead--">openForRead</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="returnLabel">Returns:</span></dt> +<dd>true for successful file open, false otherwise</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if opening the resource failed</dd> +</dl> +</li> +</ul> +<a name="readNextObject--"> +<!-- --> +</a> +<ul class="blockList"> +<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">Fetches one record from the file.</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="returnLabel">Returns:</span></dt> +<dd>a <a href="../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api"><code>OneRow</code></a> record as a Java object. Returns null if none.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +<a name="closeForRead--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>closeForRead</h4> +<pre>public void closeForRead() + throws java.lang.Exception</pre> +<div class="block">Closes the access stream when finished reading the file</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html#closeForRead--">closeForRead</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="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if closing the resource failed</dd> +</dl> +</li> +</ul> +<a name="isThreadSafe--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isThreadSafe</h4> +<pre>public boolean isThreadSafe()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html#isThreadSafe--">Plugin</a></code></span></div> +<div class="block">Checks if the plugin is thread safe or not, based on inputData.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html#isThreadSafe--">isThreadSafe</a></code> in class <code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if plugin is thread safe</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/ChunkWritable.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/HdfsDataFragmenter.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/HdfsAtomicDataAccessor.html" target="_top">Frames</a></li> +<li><a href="HdfsAtomicDataAccessor.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/HdfsDataFragmenter.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsDataFragmenter.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsDataFragmenter.html new file mode 100644 index 0000000..2cae28d --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsDataFragmenter.html @@ -0,0 +1,368 @@ +<!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>HdfsDataFragmenter</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="HdfsDataFragmenter"; + } + } + 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/HdfsAtomicDataAccessor.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/HdfsSplittableDataAccessor.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/HdfsDataFragmenter.html" target="_top">Frames</a></li> +<li><a href="HdfsDataFragmenter.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.Fragmenter">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 HdfsDataFragmenter" class="title">Class HdfsDataFragmenter</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/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">org.apache.hawq.pxf.api.Fragmenter</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.plugins.hdfs.HdfsDataFragmenter</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">HdfsDataFragmenter</span> +extends <a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></pre> +<div class="block">Fragmenter class for HDFS data resources. + + Given an HDFS data source (a file, directory, or wild card pattern) divide + the data into fragments and return a list of them along with a list of + host:port locations for each.</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.Fragmenter"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.hawq.pxf.api.<a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></h3> +<code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html#fragments">fragments</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/HdfsDataFragmenter.html#HdfsDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-">HdfsDataFragmenter</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> md)</code> +<div class="block">Constructs an HdfsDataFragmenter object.</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/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/plugins/hdfs/HdfsDataFragmenter.html#getFragments--">getFragments</a></span>()</code> +<div class="block">Gets the fragments for a data source URI that can appear as a file name, + a directory name or a wildcard.</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/plugins/hdfs/HdfsDataFragmenter.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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HdfsDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HdfsDataFragmenter</h4> +<pre>public HdfsDataFragmenter(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> md)</pre> +<div class="block">Constructs an HdfsDataFragmenter object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>md</code> - all input parameters coming from the client</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 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 for a data source URI that can appear as a file name, + a directory name or a wildcard. Returns the data fragments in JSON + format.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragments--">getFragments</a></code> in class <code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></code></dd> +<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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragmentsStats--">Fragmenter</a></code></span></div> +<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>Fragmenter.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="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragmentsStats--">getFragmentsStats</a></code> in class <code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></code></dd> +<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/plugins/hdfs/HdfsAtomicDataAccessor.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/HdfsSplittableDataAccessor.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/HdfsDataFragmenter.html" target="_top">Frames</a></li> +<li><a href="HdfsDataFragmenter.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.Fragmenter">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/HdfsSplittableDataAccessor.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html new file mode 100644 index 0000000..7aeb0d1 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html @@ -0,0 +1,562 @@ +<!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>HdfsSplittableDataAccessor</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="HdfsSplittableDataAccessor"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":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/plugins/hdfs/HdfsDataFragmenter.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/LineBreakAccessor.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/HdfsSplittableDataAccessor.html" target="_top">Frames</a></li> +<li><a href="HdfsSplittableDataAccessor.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 HdfsSplittableDataAccessor" class="title">Class HdfsSplittableDataAccessor</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.HdfsSplittableDataAccessor</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> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/AvroFileAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">AvroFileAccessor</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveAccessor.html" title="class in org.apache.hawq.pxf.plugins.hive">HiveAccessor</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/LineBreakAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">LineBreakAccessor</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/SequenceFileAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">SequenceFileAccessor</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">HdfsSplittableDataAccessor</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/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></pre> +<div class="block">Accessor for accessing a splittable HDFS data sources. HDFS will divide the + file into splits based on an internal decision (by default, the block size is + also the split size). + + Accessors that require such base functionality should extend this class.</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 org.apache.hadoop.conf.Configuration</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#conf">conf</a></span></code> </td> +</tr> +<tr class="rowColor"> +<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/HdfsSplittableDataAccessor.html#data">data</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected org.apache.hadoop.mapred.InputFormat<?,?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#inputFormat">inputFormat</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected java.util.ListIterator<org.apache.hadoop.mapred.InputSplit></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#iter">iter</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected org.apache.hadoop.mapred.JobConf</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#jobConf">jobConf</a></span></code> </td> +</tr> +<tr class="rowColor"> +<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/HdfsSplittableDataAccessor.html#key">key</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected org.apache.hadoop.mapred.RecordReader<java.lang.Object,java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#reader">reader</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/plugins/hdfs/HdfsSplittableDataAccessor.html#HdfsSplittableDataAccessor-org.apache.hawq.pxf.api.utilities.InputData-org.apache.hadoop.mapred.InputFormat-">HdfsSplittableDataAccessor</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input, + org.apache.hadoop.mapred.InputFormat<?,?> inFormat)</code> +<div class="block">Constructs an HdfsSplittableDataAccessor</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#closeForRead--">closeForRead</a></span>()</code> +<div class="block">When user finished reading the file, it closes the RecordReader</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#getNextSplit--">getNextSplit</a></span>()</code> +<div class="block">Sets the current split and initializes a RecordReader who feeds from the + split</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>protected abstract java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.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="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#isThreadSafe--">isThreadSafe</a></span>()</code> +<div class="block">Checks if the plugin is thread safe or not, based on inputData.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#openForRead--">openForRead</a></span>()</code> +<div class="block">Fetches the requested fragment (file split) for the current client + request, and sets a record reader for the job.</div> +</td> +</tr> +<tr id="i5" 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/HdfsSplittableDataAccessor.html#readNextObject--">readNextObject</a></span>()</code> +<div class="block">Fetches one record from the file.</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="conf"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>conf</h4> +<pre>protected org.apache.hadoop.conf.Configuration conf</pre> +</li> +</ul> +<a name="reader"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reader</h4> +<pre>protected org.apache.hadoop.mapred.RecordReader<java.lang.Object,java.lang.Object> reader</pre> +</li> +</ul> +<a name="inputFormat"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>inputFormat</h4> +<pre>protected org.apache.hadoop.mapred.InputFormat<?,?> inputFormat</pre> +</li> +</ul> +<a name="iter"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iter</h4> +<pre>protected java.util.ListIterator<org.apache.hadoop.mapred.InputSplit> iter</pre> +</li> +</ul> +<a name="jobConf"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>jobConf</h4> +<pre>protected org.apache.hadoop.mapred.JobConf jobConf</pre> +</li> +</ul> +<a name="key"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>key</h4> +<pre>protected java.lang.Object key</pre> +</li> +</ul> +<a name="data"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>data</h4> +<pre>protected java.lang.Object data</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HdfsSplittableDataAccessor-org.apache.hawq.pxf.api.utilities.InputData-org.apache.hadoop.mapred.InputFormat-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HdfsSplittableDataAccessor</h4> +<pre>public HdfsSplittableDataAccessor(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input, + org.apache.hadoop.mapred.InputFormat<?,?> inFormat)</pre> +<div class="block">Constructs an HdfsSplittableDataAccessor</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>input</code> - all input parameters coming from the client request</dd> +<dd><code>inFormat</code> - the HDFS <code>InputFormat</code> the caller wants to use</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="openForRead--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openForRead</h4> +<pre>public boolean openForRead() + throws java.lang.Exception</pre> +<div class="block">Fetches the requested fragment (file split) for the current client + request, and sets a record reader for the job.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html#openForRead--">openForRead</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="returnLabel">Returns:</span></dt> +<dd>true if succeeded, false if no more splits to be read</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if opening the resource failed</dd> +</dl> +</li> +</ul> +<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 abstract java.lang.Object getReader(org.apache.hadoop.mapred.JobConf jobConf, + org.apache.hadoop.mapred.InputSplit split) + throws java.io.IOException</pre> +<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="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="getNextSplit--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextSplit</h4> +<pre>protected boolean getNextSplit() + throws java.io.IOException</pre> +<div class="block">Sets the current split and initializes a RecordReader who feeds from the + split</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if there is a split to read</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if record reader could not be created</dd> +</dl> +</li> +</ul> +<a name="readNextObject--"> +<!-- --> +</a> +<ul class="blockList"> +<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">Fetches one record from the file. The record is returned as a Java + object.</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="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> +<a name="closeForRead--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>closeForRead</h4> +<pre>public void closeForRead() + throws java.lang.Exception</pre> +<div class="block">When user finished reading the file, it closes the RecordReader</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html#closeForRead--">closeForRead</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="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if closing the resource failed</dd> +</dl> +</li> +</ul> +<a name="isThreadSafe--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isThreadSafe</h4> +<pre>public boolean isThreadSafe()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html#isThreadSafe--">Plugin</a></code></span></div> +<div class="block">Checks if the plugin is thread safe or not, based on inputData.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html#isThreadSafe--">isThreadSafe</a></code> in class <code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if plugin is thread safe</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/HdfsDataFragmenter.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/LineBreakAccessor.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/HdfsSplittableDataAccessor.html" target="_top">Frames</a></li> +<li><a href="HdfsSplittableDataAccessor.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/LineBreakAccessor.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/LineBreakAccessor.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/LineBreakAccessor.html new file mode 100644 index 0000000..af1cff7 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/LineBreakAccessor.html @@ -0,0 +1,418 @@ +<!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>LineBreakAccessor</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="LineBreakAccessor"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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/HdfsSplittableDataAccessor.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/QuotedLineBreakAccessor.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/LineBreakAccessor.html" target="_top">Frames</a></li> +<li><a href="LineBreakAccessor.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 LineBreakAccessor" class="title">Class LineBreakAccessor</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.LineBreakAccessor</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>, <a href="../../../../../../org/apache/hawq/pxf/api/WriteAccessor.html" title="interface in org.apache.hawq.pxf.api">WriteAccessor</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">LineBreakAccessor</span> +extends <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs">HdfsSplittableDataAccessor</a> +implements <a href="../../../../../../org/apache/hawq/pxf/api/WriteAccessor.html" title="interface in org.apache.hawq.pxf.api">WriteAccessor</a></pre> +<div class="block">A PXF Accessor for reading delimited plain text 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#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/LineBreakAccessor.html#LineBreakAccessor-org.apache.hawq.pxf.api.utilities.InputData-">LineBreakAccessor</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 LineReaderAccessor.</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/LineBreakAccessor.html#closeForWrite--">closeForWrite</a></span>()</code> +<div class="block">Closes the output stream after done writing.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<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/LineBreakAccessor.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="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/LineBreakAccessor.html#openForWrite--">openForWrite</a></span>()</code> +<div class="block">Opens file for write.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/LineBreakAccessor.html#writeNextObject-org.apache.hawq.pxf.api.OneRow-">writeNextObject</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a> onerow)</code> +<div class="block">Writes row into stream.</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>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#readNextObject--">readNextObject</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="LineBreakAccessor-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LineBreakAccessor</h4> +<pre>public LineBreakAccessor(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input)</pre> +<div class="block">Constructs a LineReaderAccessor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>input</code> - all input parameters coming from the client request</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="openForWrite--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openForWrite</h4> +<pre>public boolean openForWrite() + throws java.lang.Exception</pre> +<div class="block">Opens file for write.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/WriteAccessor.html#openForWrite--">openForWrite</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/WriteAccessor.html" title="interface in org.apache.hawq.pxf.api">WriteAccessor</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the resource is successfully opened</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if opening the resource failed</dd> +</dl> +</li> +</ul> +<a name="writeNextObject-org.apache.hawq.pxf.api.OneRow-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeNextObject</h4> +<pre>public boolean writeNextObject(<a href="../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a> onerow) + throws java.lang.Exception</pre> +<div class="block">Writes row into stream.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/WriteAccessor.html#writeNextObject-org.apache.hawq.pxf.api.OneRow-">writeNextObject</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/WriteAccessor.html" title="interface in org.apache.hawq.pxf.api">WriteAccessor</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>onerow</code> - the object to be written</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the write succeeded</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - writing to the resource failed</dd> +</dl> +</li> +</ul> +<a name="closeForWrite--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>closeForWrite</h4> +<pre>public void closeForWrite() + throws java.lang.Exception</pre> +<div class="block">Closes the output stream after done writing.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/WriteAccessor.html#closeForWrite--">closeForWrite</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/WriteAccessor.html" title="interface in org.apache.hawq.pxf.api">WriteAccessor</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if closing the resource 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/HdfsSplittableDataAccessor.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/QuotedLineBreakAccessor.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/LineBreakAccessor.html" target="_top">Frames</a></li> +<li><a href="LineBreakAccessor.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>
