http://git-wip-us.apache.org/repos/asf/incubator-hawq-site/blob/ab8cf62a/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmenterFactory.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmenterFactory.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmenterFactory.html new file mode 100644 index 0000000..b5c23fb --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmenterFactory.html @@ -0,0 +1,276 @@ +<!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>FragmenterFactory</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="FragmenterFactory"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/service/BridgeOutputBuilder.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/FragmenterFactory.html" target="_top">Frames</a></li> +<li><a href="FragmenterFactory.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.service</div> +<h2 title="Class FragmenterFactory" class="title">Class FragmenterFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.FragmenterFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FragmenterFactory</span> +extends java.lang.Object</pre> +<div class="block">Factory class for creation of <a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api"><code>Fragmenter</code></a> objects. The actual <a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api"><code>Fragmenter</code></a> object is "hidden" behind + an <a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api"><code>Fragmenter</code></a> abstract class which is returned by the FragmenterFactory.</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/service/FragmenterFactory.html#FragmenterFactory--">FragmenterFactory</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 <a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/service/FragmenterFactory.html#create-org.apache.hawq.pxf.api.utilities.InputData-">create</a></span>(<a href="../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inputData)</code> </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="FragmenterFactory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FragmenterFactory</h4> +<pre>public FragmenterFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a> create(<a href="../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inputData) + throws java.lang.Exception</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</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/service/BridgeOutputBuilder.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/FragmenterFactory.html" target="_top">Frames</a></li> +<li><a href="FragmenterFactory.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/service/FragmentsResponse.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmentsResponse.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmentsResponse.html new file mode 100644 index 0000000..1e7bb9f --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmentsResponse.html @@ -0,0 +1,308 @@ +<!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>FragmentsResponse</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="FragmentsResponse"; + } + } + 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/service/FragmenterFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponseFormatter.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/FragmentsResponse.html" target="_top">Frames</a></li> +<li><a href="FragmentsResponse.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.service</div> +<h2 title="Class FragmentsResponse" class="title">Class FragmentsResponse</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.FragmentsResponse</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>javax.ws.rs.core.StreamingOutput</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FragmentsResponse</span> +extends java.lang.Object +implements javax.ws.rs.core.StreamingOutput</pre> +<div class="block">Class for serializing fragments metadata in JSON format. The class implements + <code>StreamingOutput</code> so the serialization will be done in a stream and not + in one bulk, this in order to avoid running out of memory when processing a + lot of fragments.</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/service/FragmentsResponse.html#FragmentsResponse-java.util.List-">FragmentsResponse</a></span>(java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>> fragments)</code> +<div class="block">Constructs fragments response out of a list of fragments</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/service/FragmentsResponse.html#write-java.io.OutputStream-">write</a></span>(java.io.OutputStream output)</code> +<div class="block">Serializes a fragments list in JSON, To be used as the result string for + HAWQ.</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="FragmentsResponse-java.util.List-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FragmentsResponse</h4> +<pre>public FragmentsResponse(java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>> fragments)</pre> +<div class="block">Constructs fragments response out of a list of fragments</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fragments</code> - fragment list</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="write-java.io.OutputStream-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(java.io.OutputStream output) + throws java.io.IOException, + javax.ws.rs.WebApplicationException</pre> +<div class="block">Serializes a fragments list in JSON, To be used as the result string for + HAWQ. An example result is as follows: + <code>{"PXFFragments":[{"replicas": + ["sdw1.corp.emc.com","sdw3.corp.emc.com","sdw8.corp.emc.com"], + "sourceName":"text2.csv", "index":"0","metadata":"<base64 metadata for fragment>", + "userData":"<data_specific_to_third_party_fragmenter>" + },{"replicas":["sdw2.corp.emc.com","sdw4.corp.emc.com","sdw5.corp.emc.com" + ],"sourceName":"text_data.csv","index":"0","metadata": + "<base64 metadata for fragment>" + ,"userData":"<data_specific_to_third_party_fragmenter>" + }]}</code></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>write</code> in interface <code>javax.ws.rs.core.StreamingOutput</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +<dd><code>javax.ws.rs.WebApplicationException</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hawq/pxf/service/FragmenterFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponseFormatter.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/FragmentsResponse.html" target="_top">Frames</a></li> +<li><a href="FragmentsResponse.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/service/FragmentsResponseFormatter.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmentsResponseFormatter.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmentsResponseFormatter.html new file mode 100644 index 0000000..28d8667 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/FragmentsResponseFormatter.html @@ -0,0 +1,288 @@ +<!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>FragmentsResponseFormatter</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="FragmentsResponseFormatter"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/GPDBWritableMapper.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/FragmentsResponseFormatter.html" target="_top">Frames</a></li> +<li><a href="FragmentsResponseFormatter.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.service</div> +<h2 title="Class FragmentsResponseFormatter" class="title">Class FragmentsResponseFormatter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.FragmentsResponseFormatter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FragmentsResponseFormatter</span> +extends java.lang.Object</pre> +<div class="block">Utility class for converting Fragments into a <a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service"><code>FragmentsResponse</code></a> that + will serialize them into JSON format.</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/service/FragmentsResponseFormatter.html#FragmentsResponseFormatter--">FragmentsResponseFormatter</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 <a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service">FragmentsResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponseFormatter.html#formatResponse-java.util.List-java.lang.String-">formatResponse</a></span>(java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>> fragments, + java.lang.String data)</code> +<div class="block">Converts Fragments list to FragmentsResponse after replacing host name by + their respective IPs.</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="FragmentsResponseFormatter--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FragmentsResponseFormatter</h4> +<pre>public FragmentsResponseFormatter()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="formatResponse-java.util.List-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>formatResponse</h4> +<pre>public static <a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service">FragmentsResponse</a> formatResponse(java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a>> fragments, + java.lang.String data) + throws java.net.UnknownHostException</pre> +<div class="block">Converts Fragments list to FragmentsResponse after replacing host name by + their respective IPs.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fragments</code> - list of fragments</dd> +<dd><code>data</code> - data (e.g. path) related to the fragments</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>FragmentsResponse with given fragments</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.net.UnknownHostException</code> - if converting host names to IP fails</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/service/FragmentsResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/GPDBWritableMapper.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/FragmentsResponseFormatter.html" target="_top">Frames</a></li> +<li><a href="FragmentsResponseFormatter.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/service/GPDBWritableMapper.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/GPDBWritableMapper.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/GPDBWritableMapper.html new file mode 100644 index 0000000..feace69 --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/GPDBWritableMapper.html @@ -0,0 +1,309 @@ +<!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>GPDBWritableMapper</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="GPDBWritableMapper"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponseFormatter.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/MetadataFetcherFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/GPDBWritableMapper.html" target="_top">Frames</a></li> +<li><a href="GPDBWritableMapper.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.service</div> +<h2 title="Class GPDBWritableMapper" class="title">Class GPDBWritableMapper</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.GPDBWritableMapper</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">GPDBWritableMapper</span> +extends java.lang.Object</pre> +</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/service/GPDBWritableMapper.html#GPDBWritableMapper-org.apache.hawq.pxf.service.io.GPDBWritable-">GPDBWritableMapper</a></span>(<a href="../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable</a> gpdbWritable)</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/service/GPDBWritableMapper.html#getData-int-">getData</a></span>(int colIdx)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/service/GPDBWritableMapper.html#setDataType-int-">setDataType</a></span>(int type)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/service/GPDBWritableMapper.html#toString--">toString</a></span>()</code> </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, 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="GPDBWritableMapper-org.apache.hawq.pxf.service.io.GPDBWritable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>GPDBWritableMapper</h4> +<pre>public GPDBWritableMapper(<a href="../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable</a> gpdbWritable)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setDataType-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataType</h4> +<pre>public void setDataType(int type) + throws <a href="../../../../../org/apache/hawq/pxf/api/UnsupportedTypeException.html" title="class in org.apache.hawq.pxf.api">UnsupportedTypeException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/hawq/pxf/api/UnsupportedTypeException.html" title="class in org.apache.hawq.pxf.api">UnsupportedTypeException</a></code></dd> +</dl> +</li> +</ul> +<a name="getData-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public java.lang.Object getData(int colIdx) + throws <a href="../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/hawq/pxf/service/io/GPDBWritable.TypeMismatchException.html" title="class in org.apache.hawq.pxf.service.io">GPDBWritable.TypeMismatchException</a></code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hawq/pxf/service/FragmentsResponseFormatter.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/MetadataFetcherFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/GPDBWritableMapper.html" target="_top">Frames</a></li> +<li><a href="GPDBWritableMapper.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/service/MetadataFetcherFactory.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/MetadataFetcherFactory.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/MetadataFetcherFactory.html new file mode 100644 index 0000000..6903f2b --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/MetadataFetcherFactory.html @@ -0,0 +1,277 @@ +<!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>MetadataFetcherFactory</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="MetadataFetcherFactory"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/service/GPDBWritableMapper.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/MetadataResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/MetadataFetcherFactory.html" target="_top">Frames</a></li> +<li><a href="MetadataFetcherFactory.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.service</div> +<h2 title="Class MetadataFetcherFactory" class="title">Class MetadataFetcherFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.MetadataFetcherFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">MetadataFetcherFactory</span> +extends java.lang.Object</pre> +<div class="block">Factory class for creation of <a href="../../../../../org/apache/hawq/pxf/api/MetadataFetcher.html" title="class in org.apache.hawq.pxf.api"><code>MetadataFetcher</code></a> objects. + The actual <a href="../../../../../org/apache/hawq/pxf/api/MetadataFetcher.html" title="class in org.apache.hawq.pxf.api"><code>MetadataFetcher</code></a> object is "hidden" behind an <a href="../../../../../org/apache/hawq/pxf/api/MetadataFetcher.html" title="class in org.apache.hawq.pxf.api"><code>MetadataFetcher</code></a> + abstract class which is returned by the MetadataFetcherFactory.</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/service/MetadataFetcherFactory.html#MetadataFetcherFactory--">MetadataFetcherFactory</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 <a href="../../../../../org/apache/hawq/pxf/api/MetadataFetcher.html" title="class in org.apache.hawq.pxf.api">MetadataFetcher</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/service/MetadataFetcherFactory.html#create-org.apache.hawq.pxf.api.utilities.InputData-">create</a></span>(<a href="../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inputData)</code> </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="MetadataFetcherFactory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MetadataFetcherFactory</h4> +<pre>public MetadataFetcherFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create-org.apache.hawq.pxf.api.utilities.InputData-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/hawq/pxf/api/MetadataFetcher.html" title="class in org.apache.hawq.pxf.api">MetadataFetcher</a> create(<a href="../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a> inputData) + throws java.lang.Exception</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</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/service/GPDBWritableMapper.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/MetadataResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/MetadataFetcherFactory.html" target="_top">Frames</a></li> +<li><a href="MetadataFetcherFactory.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/service/MetadataResponse.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/MetadataResponse.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/MetadataResponse.html new file mode 100644 index 0000000..2a8b93c --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/MetadataResponse.html @@ -0,0 +1,297 @@ +<!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>MetadataResponse</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="MetadataResponse"; + } + } + 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/service/MetadataFetcherFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/MetadataResponseFormatter.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/MetadataResponse.html" target="_top">Frames</a></li> +<li><a href="MetadataResponse.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.service</div> +<h2 title="Class MetadataResponse" class="title">Class MetadataResponse</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.MetadataResponse</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>javax.ws.rs.core.StreamingOutput</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">MetadataResponse</span> +extends java.lang.Object +implements javax.ws.rs.core.StreamingOutput</pre> +<div class="block">Class for serializing metadata in JSON format. The class implements + <code>StreamingOutput</code> so the serialization will be done in a stream and not + in one bulk, this in order to avoid running out of memory when processing a + lot of items.</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/service/MetadataResponse.html#MetadataResponse-java.util.List-">MetadataResponse</a></span>(java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api">Metadata</a>> metadataList)</code> +<div class="block">Constructs metadata response out of a metadata list</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/service/MetadataResponse.html#write-java.io.OutputStream-">write</a></span>(java.io.OutputStream output)</code> +<div class="block">Serializes the metadata list in JSON, To be used as the result string for HAWQ.</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="MetadataResponse-java.util.List-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MetadataResponse</h4> +<pre>public MetadataResponse(java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api">Metadata</a>> metadataList)</pre> +<div class="block">Constructs metadata response out of a metadata list</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>metadataList</code> - metadata list</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="write-java.io.OutputStream-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(java.io.OutputStream output) + throws java.io.IOException, + javax.ws.rs.WebApplicationException</pre> +<div class="block">Serializes the metadata list in JSON, To be used as the result string for HAWQ.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>write</code> in interface <code>javax.ws.rs.core.StreamingOutput</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd> +<dd><code>javax.ws.rs.WebApplicationException</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hawq/pxf/service/MetadataFetcherFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/MetadataResponseFormatter.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/MetadataResponse.html" target="_top">Frames</a></li> +<li><a href="MetadataResponse.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/service/MetadataResponseFormatter.html ---------------------------------------------------------------------- diff --git a/docs/pxf/javadoc/org/apache/hawq/pxf/service/MetadataResponseFormatter.html b/docs/pxf/javadoc/org/apache/hawq/pxf/service/MetadataResponseFormatter.html new file mode 100644 index 0000000..e41454a --- /dev/null +++ b/docs/pxf/javadoc/org/apache/hawq/pxf/service/MetadataResponseFormatter.html @@ -0,0 +1,285 @@ +<!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>MetadataResponseFormatter</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="MetadataResponseFormatter"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/service/MetadataResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/ReadBridge.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/MetadataResponseFormatter.html" target="_top">Frames</a></li> +<li><a href="MetadataResponseFormatter.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.service</div> +<h2 title="Class MetadataResponseFormatter" class="title">Class MetadataResponseFormatter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.hawq.pxf.service.MetadataResponseFormatter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">MetadataResponseFormatter</span> +extends java.lang.Object</pre> +<div class="block">Utility class for converting <a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api"><code>Metadata</code></a> into a JSON format.</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/service/MetadataResponseFormatter.html#MetadataResponseFormatter--">MetadataResponseFormatter</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 <a href="../../../../../org/apache/hawq/pxf/service/MetadataResponse.html" title="class in org.apache.hawq.pxf.service">MetadataResponse</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/service/MetadataResponseFormatter.html#formatResponse-java.util.List-java.lang.String-">formatResponse</a></span>(java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api">Metadata</a>> metadataList, + java.lang.String path)</code> +<div class="block">Converts list of <a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api"><code>Metadata</code></a> to JSON String format.</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="MetadataResponseFormatter--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MetadataResponseFormatter</h4> +<pre>public MetadataResponseFormatter()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="formatResponse-java.util.List-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>formatResponse</h4> +<pre>public static <a href="../../../../../org/apache/hawq/pxf/service/MetadataResponse.html" title="class in org.apache.hawq.pxf.service">MetadataResponse</a> formatResponse(java.util.List<<a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api">Metadata</a>> metadataList, + java.lang.String path) + throws java.io.IOException</pre> +<div class="block">Converts list of <a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api"><code>Metadata</code></a> to JSON String format.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>metadataList</code> - list of metadata objects to convert</dd> +<dd><code>path</code> - path string</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>JSON formatted response</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if converting the data to JSON fails</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/service/MetadataResponse.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hawq/pxf/service/ReadBridge.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/MetadataResponseFormatter.html" target="_top">Frames</a></li> +<li><a href="MetadataResponseFormatter.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>
