http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html new file mode 100644 index 0000000..45593a9 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html @@ -0,0 +1,323 @@ +<!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>RecordkeyAdapter</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="RecordkeyAdapter"; + } + } + 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/utilities/PxfInputFormat.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html" target="_top">Frames</a></li> +<li><a href="RecordkeyAdapter.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.utilities</div> +<h2 title="Class RecordkeyAdapter" class="title">Class RecordkeyAdapter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.plugins.hdfs.utilities.RecordkeyAdapter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">RecordkeyAdapter</span> +extends java.lang.Object</pre> +<div class="block">Adapter used for adding a recordkey field to the records output + <code>List<OneField></code>.</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/utilities/RecordkeyAdapter.html#RecordkeyAdapter--">RecordkeyAdapter</a></span>()</code> +<div class="block">Constructs a RecordkeyAdapter.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html#appendRecordkeyField-java.util.List-org.apache.hawq.pxf.api.utilities.InputData-org.apache.hawq.pxf.api.OneRow-">appendRecordkeyField</a></span>(java.util.List<<a href="../../../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api">OneField</a>> recFields, + <a href="../../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input, + <a href="../../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a> onerow)</code> +<div class="block">Adds the recordkey to the end of the passed in recFields list.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.io.Writable</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html#convertKeyValue-java.lang.Object-">convertKeyValue</a></span>(java.lang.Object key)</code> +<div class="block">Converts given key object to its matching Writable.</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="RecordkeyAdapter--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RecordkeyAdapter</h4> +<pre>public RecordkeyAdapter()</pre> +<div class="block">Constructs a RecordkeyAdapter.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="appendRecordkeyField-java.util.List-org.apache.hawq.pxf.api.utilities.InputData-org.apache.hawq.pxf.api.OneRow-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendRecordkeyField</h4> +<pre>public int appendRecordkeyField(java.util.List<<a href="../../../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api">OneField</a>> recFields, + <a href="../../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> input, + <a href="../../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a> onerow) + throws java.lang.NoSuchFieldException</pre> +<div class="block">Adds the recordkey to the end of the passed in recFields list. + <p> + This method also verifies cases in which record keys are not supported by + the underlying source type, and therefore "illegally" requested.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>recFields</code> - existing list of record (non-key) fields and their + values.</dd> +<dd><code>input</code> - all input parameters coming from the client request</dd> +<dd><code>onerow</code> - a row object which is used here in order to find out if the + given type supports recordkeys or not.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>0 if record key not needed, or 1 if record key was appended</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.NoSuchFieldException</code> - when the given record type does not support + recordkeys</dd> +</dl> +</li> +</ul> +<a name="convertKeyValue-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>convertKeyValue</h4> +<pre>public org.apache.hadoop.io.Writable convertKeyValue(java.lang.Object key)</pre> +<div class="block">Converts given key object to its matching Writable. Supported types: + Integer, Byte, Boolean, Double, Float, Long, String. The type is only + checked once based on the key, all consequent calls must be of the same + type.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - object to convert</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Writable object matching given key</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/utilities/PxfInputFormat.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html" target="_top">Frames</a></li> +<li><a href="RecordkeyAdapter.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/utilities/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-frame.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-frame.html new file mode 100644 index 0000000..2fb4627 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-frame.html @@ -0,0 +1,30 @@ +<!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:37 PDT 2016 --> +<title>org.apache.hawq.pxf.plugins.hdfs.utilities</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> +<h1 class="bar"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/package-summary.html" target="classFrame">org.apache.hawq.pxf.plugins.hdfs.utilities</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="HdfsUtilities.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities" target="classFrame">HdfsUtilities</a></li> +<li><a href="PxfInputFormat.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities" target="classFrame">PxfInputFormat</a></li> +<li><a href="RecordkeyAdapter.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities" target="classFrame">RecordkeyAdapter</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="DataSchemaException.MessageFmt.html" title="enum in org.apache.hawq.pxf.plugins.hdfs.utilities" target="classFrame">DataSchemaException.MessageFmt</a></li> +</ul> +<h2 title="Exceptions">Exceptions</h2> +<ul title="Exceptions"> +<li><a href="DataSchemaException.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities" target="classFrame">DataSchemaException</a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-summary.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-summary.html new file mode 100644 index 0000000..2421af8 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-summary.html @@ -0,0 +1,192 @@ +<!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:37 PDT 2016 --> +<title>org.apache.hawq.pxf.plugins.hdfs.utilities</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="org.apache.hawq.pxf.plugins.hdfs.utilities"; + } + } + catch(err) { + } +//--> +</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 class="navBarCell1Rev">Package</li> +<li>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/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../../org/apache/hawq/pxf/plugins/hive/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/utilities/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.hawq.pxf.plugins.hdfs.utilities</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/HdfsUtilities.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities">HdfsUtilities</a></td> +<td class="colLast"> +<div class="block">HdfsUtilities class exposes helper methods for PXF classes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/PxfInputFormat.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities">PxfInputFormat</a></td> +<td class="colLast"> +<div class="block">PxfInputFormat is not intended to read a specific format, hence it implements + a dummy getRecordReader Instead, its purpose is to apply + FileInputFormat.getSplits from one point in PXF and get the splits which are + valid for the actual InputFormats, since all of them we use inherit + FileInputFormat but do not override getSplits.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities">RecordkeyAdapter</a></td> +<td class="colLast"> +<div class="block">Adapter used for adding a recordkey field to the records output + <code>List<OneField></code>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/DataSchemaException.MessageFmt.html" title="enum in org.apache.hawq.pxf.plugins.hdfs.utilities">DataSchemaException.MessageFmt</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> +<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Exception</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/DataSchemaException.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities">DataSchemaException</a></td> +<td class="colLast"> +<div class="block">Thrown when there is a data schema problem detected by any plugin that + requires a schema.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../../org/apache/hawq/pxf/plugins/hive/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/utilities/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<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/utilities/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-tree.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-tree.html new file mode 100644 index 0000000..eeb045f --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hdfs/utilities/package-tree.html @@ -0,0 +1,166 @@ +<!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:37 PDT 2016 --> +<title>org.apache.hawq.pxf.plugins.hdfs.utilities Class Hierarchy</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="org.apache.hawq.pxf.plugins.hdfs.utilities Class Hierarchy"; + } + } + catch(err) { + } +//--> +</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</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../../../../org/apache/hawq/pxf/plugins/hive/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/utilities/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.hawq.pxf.plugins.hdfs.utilities</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.hadoop.mapred.FileInputFormat<K,V> (implements org.apache.hadoop.mapred.InputFormat<K,V>) +<ul> +<li type="circle">org.apache.hawq.pxf.plugins.hdfs.utilities.<a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/PxfInputFormat.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities"><span class="typeNameLink">PxfInputFormat</span></a></li> +</ul> +</li> +<li type="circle">org.apache.hawq.pxf.plugins.hdfs.utilities.<a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/HdfsUtilities.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities"><span class="typeNameLink">HdfsUtilities</span></a></li> +<li type="circle">org.apache.hawq.pxf.plugins.hdfs.utilities.<a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/RecordkeyAdapter.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities"><span class="typeNameLink">RecordkeyAdapter</span></a></li> +<li type="circle">java.lang.Throwable (implements java.io.Serializable) +<ul> +<li type="circle">java.lang.Exception +<ul> +<li type="circle">java.lang.RuntimeException +<ul> +<li type="circle">org.apache.hawq.pxf.plugins.hdfs.utilities.<a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/DataSchemaException.html" title="class in org.apache.hawq.pxf.plugins.hdfs.utilities"><span class="typeNameLink">DataSchemaException</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">org.apache.hawq.pxf.plugins.hdfs.utilities.<a href="../../../../../../../org/apache/hawq/pxf/plugins/hdfs/utilities/DataSchemaException.MessageFmt.html" title="enum in org.apache.hawq.pxf.plugins.hdfs.utilities"><span class="typeNameLink">DataSchemaException.MessageFmt</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../../../../org/apache/hawq/pxf/plugins/hive/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/hawq/pxf/plugins/hdfs/utilities/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<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/hive/HiveAccessor.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hive/HiveAccessor.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hive/HiveAccessor.html new file mode 100644 index 0000000..6a1f475 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hive/HiveAccessor.html @@ -0,0 +1,435 @@ +<!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>HiveAccessor</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="HiveAccessor"; + } + } + 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/hive/HiveColumnarSerdeResolver.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hive/HiveAccessor.html" target="_top">Frames</a></li> +<li><a href="HiveAccessor.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.hive</div> +<h2 title="Class HiveAccessor" class="title">Class HiveAccessor</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.hive.HiveAccessor</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> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveLineBreakAccessor.html" title="class in org.apache.hawq.pxf.plugins.hive">HiveLineBreakAccessor</a>, <a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveRCFileAccessor.html" title="class in org.apache.hawq.pxf.plugins.hive">HiveRCFileAccessor</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">HiveAccessor</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">Accessor for Hive tables. The accessor will open and read a split belonging + to a Hive table. Opening a split means creating the corresponding InputFormat + and RecordReader required to access the split's data. The actual record + reading is done in the base class - + <a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html" title="class in org.apache.hawq.pxf.plugins.hdfs"><code>HdfsSplittableDataAccessor</code></a>. <br> + HiveAccessor will also enforce Hive partition filtering by filtering-out a + split which does not belong to a partition filter. Naturally, the partition + filtering will be done only for Hive tables that are partitioned.</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.lang.Boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveAccessor.html#filterInFragmenter">filterInFragmenter</a></span></code> </td> +</tr> +</table> +<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/hive/HiveAccessor.html#HiveAccessor-org.apache.hawq.pxf.api.utilities.InputData-">HiveAccessor</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 HiveAccessor and creates an InputFormat (derived from + <code>InputFormat</code>) and the Hive partition + fields</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveAccessor.html#HiveAccessor-org.apache.hawq.pxf.api.utilities.InputData-org.apache.hadoop.mapred.InputFormat-">HiveAccessor</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<?,?> inputFormat)</code> +<div class="block">Constructs a HiveAccessor</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/hive/HiveAccessor.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">Creates the RecordReader suitable for this given split.</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/hive/HiveAccessor.html#openForRead--">openForRead</a></span>()</code> +<div class="block">Opens Hive data split for read.</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#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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="filterInFragmenter"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>filterInFragmenter</h4> +<pre>protected java.lang.Boolean filterInFragmenter</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HiveAccessor-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HiveAccessor</h4> +<pre>public HiveAccessor(<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 HiveAccessor and creates an InputFormat (derived from + <code>InputFormat</code>) and the Hive partition + fields</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>input</code> - contains the InputFormat class name and the partition fields</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if failed to create input format</dd> +</dl> +</li> +</ul> +<a name="HiveAccessor-org.apache.hawq.pxf.api.utilities.InputData-org.apache.hadoop.mapred.InputFormat-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HiveAccessor</h4> +<pre>public HiveAccessor(<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<?,?> inputFormat)</pre> +<div class="block">Constructs a HiveAccessor</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>input</code> - contains the InputFormat class name and the partition fields</dd> +<dd><code>inputFormat</code> - Hive InputFormat</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 Hive data split for read. Enables Hive partition filtering. <br></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="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/plugins/hdfs/HdfsSplittableDataAccessor.html#openForRead--">openForRead</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>true if there are no partitions or there is no partition filter + or partition filter is set and the file currently opened by the + accessor belongs to the partition.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if filter could not be built, connection to Hive failed + or resource failed to open</dd> +</dl> +</li> +</ul> +<a name="getReader-org.apache.hadoop.mapred.JobConf-org.apache.hadoop.mapred.InputSplit-"> +<!-- --> +</a> +<ul class="blockListLast"> +<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">Creates the RecordReader suitable for this given split.</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> - configuration data for the Hadoop framework</dd> +<dd><code>split</code> - the split that was allocated for reading to this accessor</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>record reader</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if failed to create record reader</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/hive/HiveColumnarSerdeResolver.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hive/HiveAccessor.html" target="_top">Frames</a></li> +<li><a href="HiveAccessor.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/hive/HiveColumnarSerdeResolver.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hive/HiveColumnarSerdeResolver.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hive/HiveColumnarSerdeResolver.html new file mode 100644 index 0000000..6a910da --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hive/HiveColumnarSerdeResolver.html @@ -0,0 +1,330 @@ +<!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>HiveColumnarSerdeResolver</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="HiveColumnarSerdeResolver"; + } + } + 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/hive/HiveAccessor.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hive/HiveColumnarSerdeResolver.html" target="_top">Frames</a></li> +<li><a href="HiveColumnarSerdeResolver.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.hive</div> +<h2 title="Class HiveColumnarSerdeResolver" class="title">Class HiveColumnarSerdeResolver</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/hive/HiveResolver.html" title="class in org.apache.hawq.pxf.plugins.hive">org.apache.hawq.pxf.plugins.hive.HiveResolver</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.plugins.hive.HiveColumnarSerdeResolver</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/ReadResolver.html" title="interface in org.apache.hawq.pxf.api">ReadResolver</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">HiveColumnarSerdeResolver</span> +extends <a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveResolver.html" title="class in org.apache.hawq.pxf.plugins.hive">HiveResolver</a></pre> +<div class="block">Specialized HiveResolver for a Hive table stored as RC file. + Use together with HiveInputFormatFragmenter/HiveRCFileAccessor.</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/hive/HiveColumnarSerdeResolver.html#HiveColumnarSerdeResolver-org.apache.hawq.pxf.api.utilities.InputData-">HiveColumnarSerdeResolver</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> </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/hive/HiveColumnarSerdeResolver.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> onerow)</code> +<div class="block">getFields returns a singleton list of OneField item.</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="HiveColumnarSerdeResolver-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HiveColumnarSerdeResolver</h4> +<pre>public HiveColumnarSerdeResolver(<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> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code></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> onerow) + throws java.lang.Exception</pre> +<div class="block">getFields returns a singleton list of OneField item. + OneField item contains two fields: an integer representing the VARCHAR 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="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveResolver.html#getFields-org.apache.hawq.pxf.api.OneRow-">getFields</a></code> in class <code><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveResolver.html" title="class in org.apache.hawq.pxf.plugins.hive">HiveResolver</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>onerow</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/hive/HiveAccessor.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hive/HiveColumnarSerdeResolver.html" target="_top">Frames</a></li> +<li><a href="HiveColumnarSerdeResolver.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/hive/HiveDataFragmenter.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html new file mode 100644 index 0000000..434a3ec --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html @@ -0,0 +1,449 @@ +<!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>HiveDataFragmenter</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="HiveDataFragmenter"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/hive/HiveColumnarSerdeResolver.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html" target="_top">Frames</a></li> +<li><a href="HiveDataFragmenter.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.hive</div> +<h2 title="Class HiveDataFragmenter" class="title">Class HiveDataFragmenter</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.hive.HiveDataFragmenter</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveInputFormatFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hive">HiveInputFormatFragmenter</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">HiveDataFragmenter</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 HIVE tables. <br> + Given a Hive table and its partitions divide the data into fragments (here a + data fragment is actually a HDFS file block) and return a list of them. Each + data fragment will contain the following information: + <ol> + <li>sourceName: full HDFS path to the data file that this data fragment is + part of</li> + <li>hosts: a list of the datanode machines that hold a replica of this block</li> + <li>userData: + file_input_format_name_DELIM_serde_name_DELIM_serialization_properties</li> + </ol></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 boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html#filterInFragmenter">filterInFragmenter</a></span></code> </td> +</tr> +</table> +<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/hive/HiveDataFragmenter.html#HiveDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-">HiveDataFragmenter</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inputData)</code> +<div class="block">Constructs a HiveDataFragmenter object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html#HiveDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-java.lang.Class-">HiveDataFragmenter</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inputData, + java.lang.Class<?> clazz)</code> +<div class="block">Constructs a HiveDataFragmenter 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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/hive/HiveDataFragmenter.html#getFragments--">getFragments</a></span>()</code> +<div class="block">Gets the fragments of a given path (source name and location of each + fragment).</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api">FragmentsStats</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html#getFragmentsStats--">getFragmentsStats</a></span>()</code> +<div class="block">Returns statistics for Hive table.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static org.apache.hadoop.mapred.InputFormat<?,?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html#makeInputFormat-java.lang.String-org.apache.hadoop.mapred.JobConf-">makeInputFormat</a></span>(java.lang.String inputFormatName, + org.apache.hadoop.mapred.JobConf jobConf)</code> +<div class="block">Creates the partition InputFormat.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hawq.pxf.api.utilities.Plugin"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hawq.pxf.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a></h3> +<code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html#isThreadSafe--">isThreadSafe</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="filterInFragmenter"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>filterInFragmenter</h4> +<pre>protected boolean filterInFragmenter</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HiveDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HiveDataFragmenter</h4> +<pre>public HiveDataFragmenter(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inputData)</pre> +<div class="block">Constructs a HiveDataFragmenter object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>inputData</code> - all input parameters coming from the client</dd> +</dl> +</li> +</ul> +<a name="HiveDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HiveDataFragmenter</h4> +<pre>public HiveDataFragmenter(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inputData, + java.lang.Class<?> clazz)</pre> +<div class="block">Constructs a HiveDataFragmenter object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>inputData</code> - all input parameters coming from the client</dd> +<dd><code>clazz</code> - Class for JobConf</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"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html#getFragments--">Fragmenter</a></code></span></div> +<div class="block">Gets the fragments of a given path (source name and location of each + fragment). Used to get fragments of data that could be read in parallel + from the different segments.</div> +<dl> +<dt><span class="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="makeInputFormat-java.lang.String-org.apache.hadoop.mapred.JobConf-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>makeInputFormat</h4> +<pre>public static org.apache.hadoop.mapred.InputFormat<?,?> makeInputFormat(java.lang.String inputFormatName, + org.apache.hadoop.mapred.JobConf jobConf) + throws java.lang.Exception</pre> +<div class="block">Creates the partition InputFormat.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>inputFormatName</code> - input format class name</dd> +<dd><code>jobConf</code> - configuration data for the Hadoop framework</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <code>InputFormat</code> derived object</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if failed to create input format</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">Returns statistics for Hive table. Currently it's not implemented.</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/hive/HiveColumnarSerdeResolver.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hive/HiveFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hive"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hive/HiveDataFragmenter.html" target="_top">Frames</a></li> +<li><a href="HiveDataFragmenter.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>
