Google Git
Sign in
apache / hawq-site / ab8cf62a32e8c7904318356964a0d38bd433c921 / . / docs / pxf / javadoc / org / apache / hawq / pxf / service / BridgeOutputBuilder.html
blob: c5deb8aca187dafeac5a8a4dbf35491b4f622ec7 [file] [log] [blame]
<!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>BridgeOutputBuilder</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="BridgeOutputBuilder";
}
}
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/BridgeInputBuilder.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hawq/pxf/service/FragmenterFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/BridgeOutputBuilder.html" target="_top">Frames</a></li>
<li><a href="BridgeOutputBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 BridgeOutputBuilder" class="title">Class BridgeOutputBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.hawq.pxf.service.BridgeOutputBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">BridgeOutputBuilder</span>
extends java.lang.Object</pre>
<div class="block">Class creates the output record that is piped by the java process to the HAWQ
backend. Actually, the output record is serialized and the obtained byte
string is piped to the HAWQ segment. The output record will implement
Writable, and the mission of BridgeOutputBuilder will be to translate a list
of <a href="../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api"><code>OneField</code></a> objects (obtained from the Resolver) into an output
record.</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">&nbsp;</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/BridgeOutputBuilder.html#BridgeOutputBuilder-org.apache.hawq.pxf.service.utilities.ProtocolData-">BridgeOutputBuilder</a></span>(<a href="../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html" title="class in org.apache.hawq.pxf.service.utilities">ProtocolData</a>&nbsp;input)</code>
<div class="block">Constructs a BridgeOutputBuilder.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/service/BridgeOutputBuilder.html#getErrorOutput-java.lang.Exception-">getErrorOutput</a></span>(java.lang.Exception&nbsp;ex)</code>
<div class="block">Returns the error record.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/service/BridgeOutputBuilder.html#getPartialLine--">getPartialLine</a></span>()</code>
<div class="block">Returns whether or not this is a partial line.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.LinkedList&lt;<a href="../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hawq/pxf/service/BridgeOutputBuilder.html#makeOutput-java.util.List-">makeOutput</a></span>(java.util.List&lt;<a href="../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api">OneField</a>&gt;&nbsp;recFields)</code>
<div class="block">Translates recFields (obtained from the Resolver) into an output record.</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&nbsp;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="BridgeOutputBuilder-org.apache.hawq.pxf.service.utilities.ProtocolData-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BridgeOutputBuilder</h4>
<pre>public&nbsp;BridgeOutputBuilder(<a href="../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html" title="class in org.apache.hawq.pxf.service.utilities">ProtocolData</a>&nbsp;input)</pre>
<div class="block">Constructs a BridgeOutputBuilder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>input</code> - input data, like requested output format and schema
information</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="getErrorOutput-java.lang.Exception-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorOutput</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a>&nbsp;getErrorOutput(java.lang.Exception&nbsp;ex)
throws java.lang.Exception</pre>
<div class="block">Returns the error record. If the output format is not binary, error
records are not supported, and the given exception will be thrown</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ex</code> - exception to be stored in record</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>error record</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if the output format is not binary</dd>
</dl>
</li>
</ul>
<a name="makeOutput-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeOutput</h4>
<pre>public&nbsp;java.util.LinkedList&lt;<a href="../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a>&gt;&nbsp;makeOutput(java.util.List&lt;<a href="../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api">OneField</a>&gt;&nbsp;recFields)
throws <a href="../../../../../org/apache/hawq/pxf/api/BadRecordException.html" title="class in org.apache.hawq.pxf.api">BadRecordException</a></pre>
<div class="block">Translates recFields (obtained from the Resolver) into an output record.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recFields</code> - record fields to be serialized</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of Writable objects with serialized row</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/hawq/pxf/api/BadRecordException.html" title="class in org.apache.hawq.pxf.api">BadRecordException</a></code> - if building the output record failed</dd>
</dl>
</li>
</ul>
<a name="getPartialLine--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPartialLine</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/hawq/pxf/service/io/Writable.html" title="interface in org.apache.hawq.pxf.service.io">Writable</a>&nbsp;getPartialLine()</pre>
<div class="block">Returns whether or not this is a partial line.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true for a partial line</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/BridgeInputBuilder.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hawq/pxf/service/FragmenterFactory.html" title="class in org.apache.hawq.pxf.service"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hawq/pxf/service/BridgeOutputBuilder.html" target="_top">Frames</a></li>
<li><a href="BridgeOutputBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>