http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.html new file mode 100644 index 0000000..05997e2 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.html @@ -0,0 +1,365 @@ +<!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>HBaseDataFragmenter</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="HBaseDataFragmenter"; + } + } + 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/hbase/HBaseAccessor.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.html" target="_top">Frames</a></li> +<li><a href="HBaseDataFragmenter.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.hbase</div> +<h2 title="Class HBaseDataFragmenter" class="title">Class HBaseDataFragmenter</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.hbase.HBaseDataFragmenter</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">HBaseDataFragmenter</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 HBase data resources. + + Extends the <a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api"><code>Fragmenter</code></a> abstract class, with the purpose of transforming + an input data path (an HBase table name in this case) into a list of regions + that belong to this table. + + This class also puts HBase lookup table information for the given + table (if exists) in each fragment's user data field.</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/hbase/HBaseDataFragmenter.html#HBaseDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-">HBaseDataFragmenter</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inConf)</code> +<div class="block">Constructor for HBaseDataFragmenter.</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/hbase/HBaseDataFragmenter.html#getFragments--">getFragments</a></span>()</code> +<div class="block">Returns list of fragments containing all of the + HBase's table data.</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/hbase/HBaseDataFragmenter.html#getFragmentsStats--">getFragmentsStats</a></span>()</code> +<div class="block">Returns statistics for HBase table.</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="HBaseDataFragmenter-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HBaseDataFragmenter</h4> +<pre>public HBaseDataFragmenter(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inConf)</pre> +<div class="block">Constructor for HBaseDataFragmenter.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>inConf</code> - input data such as which HBase table to scan</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="getFragmentsStats--"> +<!-- --> +</a> +<ul class="blockList"> +<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 HBase 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> +<a name="getFragments--"> +<!-- --> +</a> +<ul class="blockListLast"> +<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">Returns list of fragments containing all of the + HBase's table data. + Lookup table information with mapping between + field names in HAWQ table and HBase table will be + returned as user data.</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>a list of 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> +</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/hbase/HBaseAccessor.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.html" target="_top">Frames</a></li> +<li><a href="HBaseDataFragmenter.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/hbase/HBaseFilterBuilder.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html new file mode 100644 index 0000000..5a88517 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html @@ -0,0 +1,389 @@ +<!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>HBaseFilterBuilder</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="HBaseFilterBuilder"; + } + } + 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/hbase/HBaseDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseResolver.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" target="_top">Frames</a></li> +<li><a href="HBaseFilterBuilder.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.hbase</div> +<h2 title="Class HBaseFilterBuilder" class="title">Class HBaseFilterBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.plugins.hbase.HBaseFilterBuilder</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/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">HBaseFilterBuilder</span> +extends java.lang.Object +implements <a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a></pre> +<div class="block">This is the implementation of <code>FilterParser.FilterBuilder</code> for HBase. + <p> + The class uses the filter parser code to build a filter object, + either simple (single <code>Filter</code> class) or a compound (<code>FilterList</code>) + for <a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseAccessor.html" title="class in org.apache.hawq.pxf.plugins.hbase"><code>HBaseAccessor</code></a> to use for its scan. + <p> + This is done before the scan starts. It is not a scan time operation. + <p> + HBase row key column is a special case. + If the user defined row key column as TEXT and used <code><,>,<=,>=,=</code> operators + the startkey (<code>>/>=</code>) and the endkey (<code></<=</code>) are stored in addition to + the created filter. + This is an addition on top of regular filters and does not replace + any logic in HBase filter objects.</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/hbase/HBaseFilterBuilder.html#HBaseFilterBuilder-org.apache.hawq.pxf.plugins.hbase.utilities.HBaseTupleDescription-">HBaseFilterBuilder</a></span>(<a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/HBaseTupleDescription.html" title="class in org.apache.hawq.pxf.plugins.hbase.utilities">HBaseTupleDescription</a> tupleDescription)</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.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html#build-org.apache.hawq.pxf.api.FilterParser.Operation-java.lang.Object-java.lang.Object-">build</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.Operation.html" title="enum in org.apache.hawq.pxf.api">FilterParser.Operation</a> opId, + java.lang.Object leftOperand, + java.lang.Object rightOperand)</code> +<div class="block">Builds a filter from the input operands and operation.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html#endKey--">endKey</a></span>()</code> +<div class="block">Returns the endKey for scanning the HBase table.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>org.apache.hadoop.hbase.filter.Filter</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html#getFilterObject-java.lang.String-">getFilterObject</a></span>(java.lang.String filterString)</code> +<div class="block">Translates a filterString into a HBase <code>Filter</code> object.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html#startKey--">startKey</a></span>()</code> +<div class="block">Returns the startKey for scanning the HBase table.</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="HBaseFilterBuilder-org.apache.hawq.pxf.plugins.hbase.utilities.HBaseTupleDescription-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HBaseFilterBuilder</h4> +<pre>public HBaseFilterBuilder(<a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/HBaseTupleDescription.html" title="class in org.apache.hawq.pxf.plugins.hbase.utilities">HBaseTupleDescription</a> tupleDescription)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getFilterObject-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilterObject</h4> +<pre>public org.apache.hadoop.hbase.filter.Filter getFilterObject(java.lang.String filterString) + throws java.lang.Exception</pre> +<div class="block">Translates a filterString into a HBase <code>Filter</code> object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filterString</code> - filter string</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>filter object</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if parsing failed</dd> +</dl> +</li> +</ul> +<a name="startKey--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startKey</h4> +<pre>public byte[] startKey()</pre> +<div class="block">Returns the startKey for scanning the HBase table. + If the user specified a <code>> / >=</code> operation + on a textual row key column, this value will be returned. + Otherwise, the start of table.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>start key for scanning HBase table</dd> +</dl> +</li> +</ul> +<a name="endKey--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>endKey</h4> +<pre>public byte[] endKey()</pre> +<div class="block">Returns the endKey for scanning the HBase table. + If the user specified a <code>< / <=</code> operation + on a textual row key column, this value will be returned. + Otherwise, the end of table.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>end key for scanning HBase table</dd> +</dl> +</li> +</ul> +<a name="build-org.apache.hawq.pxf.api.FilterParser.Operation-java.lang.Object-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>build</h4> +<pre>public java.lang.Object build(<a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.Operation.html" title="enum in org.apache.hawq.pxf.api">FilterParser.Operation</a> opId, + java.lang.Object leftOperand, + java.lang.Object rightOperand) + throws java.lang.Exception</pre> +<div class="block">Builds a filter from the input operands and operation. + Two kinds of operations are handled: + <ol> + <li>Simple operation between <code>FilterParser.Constant</code> and <code>FilterParser.ColumnIndex</code>. + Supported operations are <code><, >, <=, <=, >=, =, !=</code>. </li> + <li>Compound operations between <code>Filter</code> objects. + The only supported operation is <code>AND</code>. </li> + </ol> + <p> + This function is called by <a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.html" title="class in org.apache.hawq.pxf.api"><code>FilterParser</code></a>, + each time the parser comes across an operator.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html#build-org.apache.hawq.pxf.api.FilterParser.Operation-java.lang.Object-java.lang.Object-">build</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>opId</code> - the parse operation to perform</dd> +<dd><code>leftOperand</code> - the left operand</dd> +<dd><code>rightOperand</code> - the right operand</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the built filter</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if building the filter 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/hbase/HBaseDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseResolver.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" target="_top">Frames</a></li> +<li><a href="HBaseFilterBuilder.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/hbase/HBaseResolver.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseResolver.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseResolver.html new file mode 100644 index 0000000..63ab666 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseResolver.html @@ -0,0 +1,332 @@ +<!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>HBaseResolver</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="HBaseResolver"; + } + } + 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/hbase/HBaseFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hbase"><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/hbase/HBaseResolver.html" target="_top">Frames</a></li> +<li><a href="HBaseResolver.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.hbase</div> +<h2 title="Class HBaseResolver" class="title">Class HBaseResolver</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.hbase.HBaseResolver</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">HBaseResolver</span> +extends <a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a> +implements <a href="../../../../../../org/apache/hawq/pxf/api/ReadResolver.html" title="interface in org.apache.hawq.pxf.api">ReadResolver</a></pre> +<div class="block">Record resolver for HBase. + + The class is responsible to convert rows from HBase scans (returned as <code>Result</code> objects) + into a List of <a href="../../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api"><code>OneField</code></a> objects. + That also includes the conversion process of each HBase column's value into its HAWQ assigned type. + + Currently, the class assumes all HBase values are stored as String object Bytes encoded.</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/hbase/HBaseResolver.html#HBaseResolver-org.apache.hawq.pxf.api.utilities.InputData-">HBaseResolver</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 resolver and initializes the table's tuple description.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api">OneField</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseResolver.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">Splits an HBase <code>Result</code> object into a list of <a href="../../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api"><code>OneField</code></a>, + based on the table's tuple description.</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="HBaseResolver-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HBaseResolver</h4> +<pre>public HBaseResolver(<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 resolver and initializes the table's tuple description.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>input</code> - query information, contains HBase table name and filter</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">Splits an HBase <code>Result</code> object into a list of <a href="../../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api"><code>OneField</code></a>, + based on the table's tuple description. + Each field is converted from HBase bytes into its column description type.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadResolver.html#getFields-org.apache.hawq.pxf.api.OneRow-">getFields</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/ReadResolver.html" title="interface in org.apache.hawq.pxf.api">ReadResolver</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>onerow</code> - the row to get the fields from</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>list of fields</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/hbase/HBaseFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hbase"><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/hbase/HBaseResolver.html" target="_top">Frames</a></li> +<li><a href="HBaseResolver.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/hbase/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/package-frame.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/package-frame.html new file mode 100644 index 0000000..3151a95 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/package-frame.html @@ -0,0 +1,23 @@ +<!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.hbase</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/hbase/package-summary.html" target="classFrame">org.apache.hawq.pxf.plugins.hbase</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="HBaseAccessor.html" title="class in org.apache.hawq.pxf.plugins.hbase" target="classFrame">HBaseAccessor</a></li> +<li><a href="HBaseDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hbase" target="classFrame">HBaseDataFragmenter</a></li> +<li><a href="HBaseFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hbase" target="classFrame">HBaseFilterBuilder</a></li> +<li><a href="HBaseResolver.html" title="class in org.apache.hawq.pxf.plugins.hbase" target="classFrame">HBaseResolver</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/hbase/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/package-summary.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/package-summary.html new file mode 100644 index 0000000..5ff635f --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/package-summary.html @@ -0,0 +1,169 @@ +<!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.hbase</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.hbase"; + } + } + 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/api/utilities/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/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.hbase</h1> +<div class="docSummary"> +<div class="block">Provides PXF HBase Plugin.</div> +</div> +<p>See: <a href="#package.description">Description</a></p> +</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/hbase/HBaseAccessor.html" title="class in org.apache.hawq.pxf.plugins.hbase">HBaseAccessor</a></td> +<td class="colLast"> +<div class="block">Accessor for HBase.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hbase">HBaseDataFragmenter</a></td> +<td class="colLast"> +<div class="block">Fragmenter class for HBase data resources.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hbase">HBaseFilterBuilder</a></td> +<td class="colLast"> +<div class="block">This is the implementation of <code>FilterParser.FilterBuilder</code> for HBase.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseResolver.html" title="class in org.apache.hawq.pxf.plugins.hbase">HBaseResolver</a></td> +<td class="colLast"> +<div class="block">Record resolver for HBase.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package.description"> +<!-- --> +</a> +<h2 title="Package org.apache.hawq.pxf.plugins.hbase Description">Package org.apache.hawq.pxf.plugins.hbase Description</h2> +<div class="block">Provides PXF HBase Plugin.</div> +</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/api/utilities/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/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/hbase/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/package-tree.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/package-tree.html new file mode 100644 index 0000000..d582917 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/package-tree.html @@ -0,0 +1,146 @@ +<!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.hbase 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.hbase 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/api/utilities/package-tree.html">Prev</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/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.hbase</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.hawq.pxf.plugins.hbase.<a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">HBaseFilterBuilder</span></a> (implements org.apache.hawq.pxf.api.<a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a>)</li> +<li type="circle">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"><span class="typeNameLink">Plugin</span></a> +<ul> +<li type="circle">org.apache.hawq.pxf.api.<a href="../../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api"><span class="typeNameLink">Fragmenter</span></a> +<ul> +<li type="circle">org.apache.hawq.pxf.plugins.hbase.<a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">HBaseDataFragmenter</span></a></li> +</ul> +</li> +<li type="circle">org.apache.hawq.pxf.plugins.hbase.<a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseAccessor.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">HBaseAccessor</span></a> (implements org.apache.hawq.pxf.api.<a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a>)</li> +<li type="circle">org.apache.hawq.pxf.plugins.hbase.<a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseResolver.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">HBaseResolver</span></a> (implements org.apache.hawq.pxf.api.<a href="../../../../../../org/apache/hawq/pxf/api/ReadResolver.html" title="interface in org.apache.hawq.pxf.api">ReadResolver</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/api/utilities/package-tree.html">Prev</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/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/hbase/utilities/HBaseColumnDescriptor.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/utilities/HBaseColumnDescriptor.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/utilities/HBaseColumnDescriptor.html new file mode 100644 index 0000000..3d162aa --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/utilities/HBaseColumnDescriptor.html @@ -0,0 +1,363 @@ +<!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>HBaseColumnDescriptor</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="HBaseColumnDescriptor"; + } + } + 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/hbase/utilities/HBaseIntegerComparator.html" title="class in org.apache.hawq.pxf.plugins.hbase.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/utilities/HBaseColumnDescriptor.html" target="_top">Frames</a></li> +<li><a href="HBaseColumnDescriptor.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.ColumnDescriptor">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.hbase.utilities</div> +<h2 title="Class HBaseColumnDescriptor" class="title">Class HBaseColumnDescriptor</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/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">org.apache.hawq.pxf.api.utilities.ColumnDescriptor</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.plugins.hbase.utilities.HBaseColumnDescriptor</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">HBaseColumnDescriptor</span> +extends <a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a></pre> +<div class="block"><a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities"><code>ColumnDescriptor</code></a> for HBase columns.</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.ColumnDescriptor"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.hawq.pxf.api.utilities.<a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a></h3> +<code><a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html#RECORD_KEY_NAME">RECORD_KEY_NAME</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/hbase/utilities/HBaseColumnDescriptor.html#HBaseColumnDescriptor-org.apache.hawq.pxf.api.utilities.ColumnDescriptor-">HBaseColumnDescriptor</a></span>(<a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a> copy)</code> +<div class="block">Constructs a column descriptor using the given copy's column name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/HBaseColumnDescriptor.html#HBaseColumnDescriptor-org.apache.hawq.pxf.api.utilities.ColumnDescriptor-byte:A-">HBaseColumnDescriptor</a></span>(<a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a> copy, + byte[] newColumnName)</code> +<div class="block">Constructs an HBase column descriptor from a generic column descriptor and an HBase column name.</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>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/HBaseColumnDescriptor.html#columnFamilyBytes--">columnFamilyBytes</a></span>()</code> +<div class="block">Returns the family column name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/HBaseColumnDescriptor.html#qualifierBytes--">qualifierBytes</a></span>()</code> +<div class="block">Returns the qualifier column name.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hawq.pxf.api.utilities.ColumnDescriptor"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hawq.pxf.api.utilities.<a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a></h3> +<code><a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html#columnIndex--">columnIndex</a>, <a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html#columnName--">columnName</a>, <a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html#columnTypeCode--">columnTypeCode</a>, <a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html#columnTypeName--">columnTypeName</a>, <a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html#isKeyColumn--">isKeyColumn</a>, <a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html#toString--">toString</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, 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="HBaseColumnDescriptor-org.apache.hawq.pxf.api.utilities.ColumnDescriptor-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HBaseColumnDescriptor</h4> +<pre>public HBaseColumnDescriptor(<a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a> copy)</pre> +<div class="block">Constructs a column descriptor using the given copy's column name.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>copy</code> - column descriptor to be copied</dd> +</dl> +</li> +</ul> +<a name="HBaseColumnDescriptor-org.apache.hawq.pxf.api.utilities.ColumnDescriptor-byte:A-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HBaseColumnDescriptor</h4> +<pre>public HBaseColumnDescriptor(<a href="../../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a> copy, + byte[] newColumnName)</pre> +<div class="block">Constructs an HBase column descriptor from a generic column descriptor and an HBase column name. + <p> + The column name must be in either of the following forms: + <ol> + <li>columnfamily:qualifier - standard HBase column.</li> + <li>recordkey - Row key column (case insensitive).</li> + </ol> + <p> + For recordkey, no HBase name is created.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>copy</code> - column descriptor</dd> +<dd><code>newColumnName</code> - HBase column name - can be different than the given column descriptor name.</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="columnFamilyBytes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>columnFamilyBytes</h4> +<pre>public byte[] columnFamilyBytes()</pre> +<div class="block">Returns the family column name. + (E.g. "cf1:q2" will return "cf1")</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>family column name</dd> +</dl> +</li> +</ul> +<a name="qualifierBytes--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>qualifierBytes</h4> +<pre>public byte[] qualifierBytes()</pre> +<div class="block">Returns the qualifier column name. + (E.g. "cf1:q2" will return "q2")</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>qualifier column name</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/hbase/utilities/HBaseIntegerComparator.html" title="class in org.apache.hawq.pxf.plugins.hbase.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/utilities/HBaseColumnDescriptor.html" target="_top">Frames</a></li> +<li><a href="HBaseColumnDescriptor.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.ColumnDescriptor">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>
