http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/ProfileConfException.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/ProfileConfException.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/ProfileConfException.html new file mode 100644 index 0000000..c29d25f --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/ProfileConfException.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>ProfileConfException</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="ProfileConfException"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/utilities/ProfileConfException.html" target="_top">Frames</a></li> +<li><a href="ProfileConfException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.api.utilities</div> +<h2 title="Class ProfileConfException" class="title">Class ProfileConfException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.api.utilities.ProfileConfException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ProfileConfException</span> +extends java.lang.RuntimeException</pre> +<div class="block">Thrown when there is a configuration problem with pxf profiles definitions. + <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html#PROFILES_FILE_NOT_FOUND"><code>ProfileConfException.MessageFormat.PROFILES_FILE_NOT_FOUND</code></a> when pxf-profiles.xml is missing from the CLASSPATH. + <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html#PROFILES_FILE_LOAD_ERR"><code>ProfileConfException.MessageFormat.PROFILES_FILE_LOAD_ERR</code></a> when pxf-profiles.xml is not valid. + <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html#NO_PROFILE_DEF"><code>ProfileConfException.MessageFormat.NO_PROFILE_DEF</code></a> when a profile entry or attribute is missing.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.hawq.pxf.api.utilities.ProfileConfException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfileConfException.MessageFormat</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.html#ProfileConfException-org.apache.hawq.pxf.api.utilities.ProfileConfException.MessageFormat-java.lang.String...-">ProfileConfException</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfileConfException.MessageFormat</a> msgFormat, + java.lang.String... msgArgs)</code> +<div class="block">Constructs a ProfileConfException.</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><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfileConfException.MessageFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.html#getMsgFormat--">getMsgFormat</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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="ProfileConfException-org.apache.hawq.pxf.api.utilities.ProfileConfException.MessageFormat-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ProfileConfException</h4> +<pre>public ProfileConfException(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfileConfException.MessageFormat</a> msgFormat, + java.lang.String... msgArgs)</pre> +<div class="block">Constructs a ProfileConfException.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>msgFormat</code> - the message format</dd> +<dd><code>msgArgs</code> - the message arguments</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="getMsgFormat--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMsgFormat</h4> +<pre>public <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfileConfException.MessageFormat</a> getMsgFormat()</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/utilities/ProfileConfException.html" target="_top">Frames</a></li> +<li><a href="ProfileConfException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/ProfilesConf.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/ProfilesConf.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/ProfilesConf.html new file mode 100644 index 0000000..463f32b --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/ProfilesConf.html @@ -0,0 +1,353 @@ +<!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>ProfilesConf</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="ProfilesConf"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Utilities.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/utilities/ProfilesConf.html" target="_top">Frames</a></li> +<li><a href="ProfilesConf.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.api.utilities</div> +<h2 title="Enum ProfilesConf" class="title">Enum ProfilesConf</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfilesConf</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.api.utilities.ProfilesConf</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfilesConf</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="typeNameLabel">ProfilesConf</span> +extends java.lang.Enum<<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfilesConf</a>></pre> +<div class="block">This enum holds the profiles files: pxf-profiles.xml and pxf-profiles-default.xml. + It exposes a public static method getProfilePluginsMap(String plugin) which returns the requested profile plugins</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html#INSTANCE">INSTANCE</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static java.util.Map<java.lang.String,java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html#getProfilePluginsMap-java.lang.String-">getProfilePluginsMap</a></span>(java.lang.String profile)</code> +<div class="block">Get requested profile plugins map.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfilesConf</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfilesConf</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="INSTANCE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>INSTANCE</h4> +<pre>public static final <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfilesConf</a> INSTANCE</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfilesConf</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (ProfilesConf c : ProfilesConf.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfilesConf</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> +</dl> +</li> +</ul> +<a name="getProfilePluginsMap-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getProfilePluginsMap</h4> +<pre>public static java.util.Map<java.lang.String,java.lang.String> getProfilePluginsMap(java.lang.String profile)</pre> +<div class="block">Get requested profile plugins map. + In case pxf-profiles.xml is not on the classpath, or it doesn't contains the requested profile, + Fallback to pxf-profiles-default.xml occurs (@see useProfilesDefaults(String msgFormat))</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>profile</code> - The requested profile</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Plugins map of the requested profile</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Utilities.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/utilities/ProfilesConf.html" target="_top">Frames</a></li> +<li><a href="ProfilesConf.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/Utilities.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/Utilities.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/Utilities.html new file mode 100644 index 0000000..dcee91f --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/Utilities.html @@ -0,0 +1,380 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>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="Utilities"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.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/api/utilities/Utilities.html" target="_top">Frames</a></li> +<li><a href="Utilities.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hawq.pxf.api.utilities</div> +<h2 title="Class Utilities" class="title">Class Utilities</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.api.utilities.Utilities</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Utilities</span> +extends java.lang.Object</pre> +<div class="block">Utilities class exposes helper method for PXF classes</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Utilities.html#Utilities--">Utilities</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Utilities.html#byteArrayToOctalString-byte:A-java.lang.StringBuilder-">byteArrayToOctalString</a></span>(byte[] bytes, + java.lang.StringBuilder sb)</code> +<div class="block">Transforms a byte array into a string of octal codes in the form + \\xyz\\xyz + + We double escape each char because it is required in postgres bytea for + some bytes.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Utilities.html#createAnyInstance-java.lang.Class-java.lang.String-org.apache.hawq.pxf.api.utilities.InputData-">createAnyInstance</a></span>(java.lang.Class<?> confClass, + java.lang.String className, + <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> metaData)</code> +<div class="block">Creates an object using the class name.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Utilities.html#createAnyInstance-java.lang.String-">createAnyInstance</a></span>(java.lang.String className)</code> +<div class="block">Creates an object using the class name with its default constructor.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Utilities.html#maskNonPrintables-java.lang.String-">maskNonPrintables</a></span>(java.lang.String input)</code> +<div class="block">Replaces any non-alpha-numeric character with a '.'.</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="Utilities--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Utilities</h4> +<pre>public Utilities()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createAnyInstance-java.lang.Class-java.lang.String-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAnyInstance</h4> +<pre>public static java.lang.Object createAnyInstance(java.lang.Class<?> confClass, + java.lang.String className, + <a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> metaData) + throws java.lang.Exception</pre> +<div class="block">Creates an object using the class name. The class name has to be a class + located in the webapp's CLASSPATH.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>confClass</code> - the class of the metaData used to initialize the + instance</dd> +<dd><code>className</code> - a class name to be initialized.</dd> +<dd><code>metaData</code> - input data used to initialize the class</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Initialized instance of given className</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - throws exception if classname was not found in + classpath, didn't have expected constructor or failed to be + instantiated</dd> +</dl> +</li> +</ul> +<a name="createAnyInstance-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAnyInstance</h4> +<pre>public static java.lang.Object createAnyInstance(java.lang.String className) + throws java.lang.Exception</pre> +<div class="block">Creates an object using the class name with its default constructor. The + class name has to be a class located in the webapp's CLASSPATH.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>className</code> - a class name to be initialized</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>initialized instance of given className</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - throws exception if classname was not found in + classpath, didn't have expected constructor or failed to be + instantiated</dd> +</dl> +</li> +</ul> +<a name="byteArrayToOctalString-byte:A-java.lang.StringBuilder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>byteArrayToOctalString</h4> +<pre>public static void byteArrayToOctalString(byte[] bytes, + java.lang.StringBuilder sb)</pre> +<div class="block">Transforms a byte array into a string of octal codes in the form + \\xyz\\xyz + + We double escape each char because it is required in postgres bytea for + some bytes. In the minimum all non-printables, backslash, null and single + quote. Easier to just escape everything see + http://www.postgresql.org/docs/9.0/static/datatype-binary.html + + Octal codes must be padded to 3 characters (001, 012)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bytes</code> - bytes to escape</dd> +<dd><code>sb</code> - octal codes of given bytes</dd> +</dl> +</li> +</ul> +<a name="maskNonPrintables-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>maskNonPrintables</h4> +<pre>public static java.lang.String maskNonPrintables(java.lang.String input)</pre> +<div class="block">Replaces any non-alpha-numeric character with a '.'. This measure is used + to prevent cross-site scripting (XSS) when an input string might include + code or script. By removing all special characters and returning a + censured string to the user this threat is avoided.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>input</code> - string to be masked</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>masked string</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.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/api/utilities/Utilities.html" target="_top">Frames</a></li> +<li><a href="Utilities.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-frame.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-frame.html new file mode 100644 index 0000000..a22857d --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-frame.html @@ -0,0 +1,32 @@ +<!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.api.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/api/utilities/package-summary.html" target="classFrame">org.apache.hawq.pxf.api.utilities</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities" target="classFrame">ColumnDescriptor</a></li> +<li><a href="InputData.html" title="class in org.apache.hawq.pxf.api.utilities" target="classFrame">InputData</a></li> +<li><a href="Plugin.html" title="class in org.apache.hawq.pxf.api.utilities" target="classFrame">Plugin</a></li> +<li><a href="Utilities.html" title="class in org.apache.hawq.pxf.api.utilities" target="classFrame">Utilities</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities" target="classFrame">ProfileConfException.MessageFormat</a></li> +<li><a href="ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities" target="classFrame">ProfilesConf</a></li> +</ul> +<h2 title="Exceptions">Exceptions</h2> +<ul title="Exceptions"> +<li><a href="ProfileConfException.html" title="class in org.apache.hawq.pxf.api.utilities" target="classFrame">ProfileConfException</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/api/utilities/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-summary.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-summary.html new file mode 100644 index 0000000..fa37ba3 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-summary.html @@ -0,0 +1,198 @@ +<!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.api.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.api.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/api/io/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/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.api.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/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a></td> +<td class="colLast"> +<div class="block">ColumnDescriptor describes one column in hawq database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a></td> +<td class="colLast"> +<div class="block">Common configuration available to all PXF plugins.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a></td> +<td class="colLast"> +<div class="block">Base class for all plugin types (Accessor, Resolver, Fragmenter, ...).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Utilities.html" title="class in org.apache.hawq.pxf.api.utilities">Utilities</a></td> +<td class="colLast"> +<div class="block">Utilities class exposes helper method for PXF classes</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/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfileConfException.MessageFormat</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities">ProfilesConf</a></td> +<td class="colLast"> +<div class="block">This enum holds the profiles files: pxf-profiles.xml and pxf-profiles-default.xml.</div> +</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/api/utilities/ProfileConfException.html" title="class in org.apache.hawq.pxf.api.utilities">ProfileConfException</a></td> +<td class="colLast"> +<div class="block">Thrown when there is a configuration problem with pxf profiles definitions.</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/api/io/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/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/api/utilities/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-tree.html b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-tree.html new file mode 100644 index 0000000..b53a32e --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/package-tree.html @@ -0,0 +1,164 @@ +<!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.api.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.api.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/api/io/package-tree.html">Prev</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/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.api.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.hawq.pxf.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">ColumnDescriptor</span></a></li> +<li type="circle">org.apache.hawq.pxf.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">InputData</span></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></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.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">ProfileConfException</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li type="circle">org.apache.hawq.pxf.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/Utilities.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Utilities</span></a></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.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfileConfException.MessageFormat.html" title="enum in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">ProfileConfException.MessageFormat</span></a></li> +<li type="circle">org.apache.hawq.pxf.api.utilities.<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ProfilesConf.html" title="enum in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">ProfilesConf</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/api/io/package-tree.html">Prev</a></li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/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/hbase/HBaseAccessor.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseAccessor.html b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseAccessor.html new file mode 100644 index 0000000..730141d --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/plugins/hbase/HBaseAccessor.html @@ -0,0 +1,380 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_65) on Wed Apr 20 18:03:36 PDT 2016 --> +<title>HBaseAccessor</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="HBaseAccessor"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseDataFragmenter.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/HBaseAccessor.html" target="_top">Frames</a></li> +<li><a href="HBaseAccessor.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 HBaseAccessor" class="title">Class HBaseAccessor</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.HBaseAccessor</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">HBaseAccessor</span> +extends <a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities">Plugin</a> +implements <a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></pre> +<div class="block">Accessor for HBase. + This class is responsible for opening the HBase table requested and + for iterating over its relevant fragments (regions) to return the relevant table's rows. + <p> + The table is divided into several splits. Each accessor instance is assigned a single split. + For each region, a Scan object is used to describe the requested rows. + <p> + The class supports filters using the <a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hbase"><code>HBaseFilterBuilder</code></a>. + Regions can be filtered out according to input from <a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" title="class in org.apache.hawq.pxf.plugins.hbase"><code>HBaseFilterBuilder</code></a>.</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/HBaseAccessor.html#HBaseAccessor-org.apache.hawq.pxf.api.utilities.InputData-">HBaseAccessor</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 href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/HBaseTupleDescription.html" title="class in org.apache.hawq.pxf.plugins.hbase.utilities"><code>HBaseTupleDescription</code></a> based on HAWQ table description and + initializes the scan start and end keys of the HBase table to default values.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseAccessor.html#closeForRead--">closeForRead</a></span>()</code> +<div class="block">Closes the HBase table.</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/hbase/HBaseAccessor.html#openForRead--">openForRead</a></span>()</code> +<div class="block">Opens the HBase table.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseAccessor.html#readNextObject--">readNextObject</a></span>()</code> +<div class="block">Returns the next row in the HBase table, null if end of fragment.</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="HBaseAccessor-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HBaseAccessor</h4> +<pre>public HBaseAccessor(<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 href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/HBaseTupleDescription.html" title="class in org.apache.hawq.pxf.plugins.hbase.utilities"><code>HBaseTupleDescription</code></a> based on HAWQ table description and + initializes the scan start and end keys of the HBase table to default values.</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="openForRead--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openForRead</h4> +<pre>public boolean openForRead() + throws java.lang.Exception</pre> +<div class="block">Opens the HBase table.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html#openForRead--">openForRead</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the current fragment (split) is + available for reading and includes in the filter</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if opening the resource failed</dd> +</dl> +</li> +</ul> +<a name="closeForRead--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>closeForRead</h4> +<pre>public void closeForRead() + throws java.lang.Exception</pre> +<div class="block">Closes the HBase table.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html#closeForRead--">closeForRead</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if closing the resource failed</dd> +</dl> +</li> +</ul> +<a name="readNextObject--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>readNextObject</h4> +<pre>public <a href="../../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a> readNextObject() + throws java.io.IOException</pre> +<div class="block">Returns the next row in the HBase table, null if end of fragment.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html#readNextObject--">readNextObject</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the object which was read</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +</dl> +</li> +</ul> +</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/HBaseDataFragmenter.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/HBaseAccessor.html" target="_top">Frames</a></li> +<li><a href="HBaseAccessor.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>
