docs/pxf/javadoc/org/apache/hawq/pxf/api/utilities/InputData.html - hawq-site - Git at Google

 <!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>InputData</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="InputData";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/utilities/InputData.html" target="_top">Frames</a></li>
 <li><a href="InputData.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.api.utilities</div>
 <h2 title="Class InputData" class="title">Class InputData</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li>org.apache.hawq.pxf.api.utilities.InputData</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><a href="../../../../../../org/apache/hawq/pxf/service/utilities/ProtocolData.html" title="class in org.apache.hawq.pxf.service.utilities">ProtocolData</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public class <span class="typeNameLabel">InputData</span>
 extends java.lang.Object</pre>
 <div class="block">Common configuration available to all PXF plugins. Represents input data
  coming from client applications, such as Hawq.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== FIELD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Field and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#accessor">accessor</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#dataFragment">dataFragment</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#dataSource">dataSource</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#filterString">filterString</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#filterStringValid">filterStringValid</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#fragmenter">fragmenter</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected byte[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#fragmentMetadata">fragmentMetadata</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#INVALID_SPLIT_IDX">INVALID_SPLIT_IDX</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#metadata">metadata</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#recordkeyColumn">recordkeyColumn</a></span></code>
 <div class="block">The name of the recordkey column.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#remoteLogin">remoteLogin</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#remoteSecret">remoteSecret</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#requestParametersMap">requestParametersMap</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#resolver">resolver</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#segmentId">segmentId</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#threadSafe">threadSafe</a></span></code>
 <div class="block">When false the bridge has to run in synchronized mode.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#totalSegments">totalSegments</a></span></code>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected java.util.ArrayList&lt;<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#tupleDescription">tupleDescription</a></span></code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected byte[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#userData">userData</a></span></code>&nbsp;</td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 <caption><span>Constructors</span><span class="tabEnd">&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/api/utilities/InputData.html#InputData--">InputData</a></span>()</code>
 <div class="block">Constructs an empty InputData</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#InputData-org.apache.hawq.pxf.api.utilities.InputData-">InputData</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a>&nbsp;copy)</code>
 <div class="block">Constructs an InputData from a copy.</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>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getAccessor--">getAccessor</a></span>()</code>
 <div class="block">Returns the ClassName for the java class that was defined as Accessor.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getColumn-int-">getColumn</a></span>(int&nbsp;index)</code>
 <div class="block">Returns column index from tuple description.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getColumns--">getColumns</a></span>()</code>
 <div class="block">Returns the number of columns in tuple description.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getDataFragment--">getDataFragment</a></span>()</code>
 <div class="block">Returns a data fragment index.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getDataSource--">getDataSource</a></span>()</code>
 <div class="block">Returns the data source of the required resource (i.e a file path or a
  table name).</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getFilterString--">getFilterString</a></span>()</code>
 <div class="block">Returns the filter string, <tt>null</tt> if #hasFilter is <tt>false</tt>.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getFragmenter--">getFragmenter</a></span>()</code>
 <div class="block">Returns the ClassName for the java class that was defined as Fragmenter
  or null if no fragmenter was defined.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>byte[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getFragmentMetadata--">getFragmentMetadata</a></span>()</code>
 <div class="block">The byte serialization of a data fragment.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>byte[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getFragmentUserData--">getFragmentUserData</a></span>()</code>
 <div class="block">Gets any custom user data that may have been passed from the fragmenter.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getLogin--">getLogin</a></span>()</code>
 <div class="block">Returns the contents of pxf_remote_service_login set in Hawq.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getMetadata--">getMetadata</a></span>()</code>
 <div class="block">Returns the ClassName for the java class that was defined as Metadata
  or null if no metadata was defined.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getRecordkeyColumn--">getRecordkeyColumn</a></span>()</code>
 <div class="block">Returns the column descriptor of the recordkey column.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getResolver--">getResolver</a></span>()</code>
 <div class="block">Returns the ClassName for the java class that was defined as Resolver.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getSecret--">getSecret</a></span>()</code>
 <div class="block">Returns the contents of pxf_remote_service_secret set in Hawq.</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getSegmentId--">getSegmentId</a></span>()</code>
 <div class="block">Returns the current segment ID in HAWQ.</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getTotalSegments--">getTotalSegments</a></span>()</code>
 <div class="block">Returns the number of segments in HAWQ.</div>
 </td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code>java.util.ArrayList&lt;<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getTupleDescription--">getTupleDescription</a></span>()</code>
 <div class="block">Returns tuple description.</div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#getUserProperty-java.lang.String-">getUserProperty</a></span>(java.lang.String&nbsp;userProp)</code>
 <div class="block">Returns a user defined property.</div>
 </td>
 </tr>
 <tr id="i18" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#hasFilter--">hasFilter</a></span>()</code>
 <div class="block">Returns true if there is a filter string to parse.</div>
 </td>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#isThreadSafe--">isThreadSafe</a></span>()</code>
 <div class="block">Returns whether this request is thread safe.</div>
 </td>
 </tr>
 <tr id="i20" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#setDataSource-java.lang.String-">setDataSource</a></span>(java.lang.String&nbsp;dataSource)</code>
 <div class="block">Sets the data source for the required resource.</div>
 </td>
 </tr>
 <tr id="i21" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#setFragmentMetadata-byte:A-">setFragmentMetadata</a></span>(byte[]&nbsp;location)</code>
 <div class="block">Sets the byte serialization of a fragment meta data.</div>
 </td>
 </tr>
 <tr id="i22" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#setFragmentUserData-byte:A-">setFragmentUserData</a></span>(byte[]&nbsp;userData)</code>
 <div class="block">Sets any custom user data that needs to be shared across plugins.</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">
 <!-- ============ FIELD DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a name="INVALID_SPLIT_IDX">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>INVALID_SPLIT_IDX</h4>
 <pre>public static final&nbsp;int INVALID_SPLIT_IDX</pre>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../../constant-values.html#org.apache.hawq.pxf.api.utilities.InputData.INVALID_SPLIT_IDX">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 <a name="requestParametersMap">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>requestParametersMap</h4>
 <pre>protected&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt; requestParametersMap</pre>
 </li>
 </ul>
 <a name="tupleDescription">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>tupleDescription</h4>
 <pre>protected&nbsp;java.util.ArrayList&lt;<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a>&gt; tupleDescription</pre>
 </li>
 </ul>
 <a name="segmentId">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>segmentId</h4>
 <pre>protected&nbsp;int segmentId</pre>
 </li>
 </ul>
 <a name="totalSegments">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>totalSegments</h4>
 <pre>protected&nbsp;int totalSegments</pre>
 </li>
 </ul>
 <a name="fragmentMetadata">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>fragmentMetadata</h4>
 <pre>protected&nbsp;byte[] fragmentMetadata</pre>
 </li>
 </ul>
 <a name="userData">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>userData</h4>
 <pre>protected&nbsp;byte[] userData</pre>
 </li>
 </ul>
 <a name="filterStringValid">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>filterStringValid</h4>
 <pre>protected&nbsp;boolean filterStringValid</pre>
 </li>
 </ul>
 <a name="filterString">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>filterString</h4>
 <pre>protected&nbsp;java.lang.String filterString</pre>
 </li>
 </ul>
 <a name="dataSource">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>dataSource</h4>
 <pre>protected&nbsp;java.lang.String dataSource</pre>
 </li>
 </ul>
 <a name="accessor">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>accessor</h4>
 <pre>protected&nbsp;java.lang.String accessor</pre>
 </li>
 </ul>
 <a name="resolver">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>resolver</h4>
 <pre>protected&nbsp;java.lang.String resolver</pre>
 </li>
 </ul>
 <a name="fragmenter">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>fragmenter</h4>
 <pre>protected&nbsp;java.lang.String fragmenter</pre>
 </li>
 </ul>
 <a name="metadata">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>metadata</h4>
 <pre>protected&nbsp;java.lang.String metadata</pre>
 </li>
 </ul>
 <a name="remoteLogin">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>remoteLogin</h4>
 <pre>protected&nbsp;java.lang.String remoteLogin</pre>
 </li>
 </ul>
 <a name="remoteSecret">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>remoteSecret</h4>
 <pre>protected&nbsp;java.lang.String remoteSecret</pre>
 </li>
 </ul>
 <a name="dataFragment">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>dataFragment</h4>
 <pre>protected&nbsp;int dataFragment</pre>
 </li>
 </ul>
 <a name="threadSafe">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>threadSafe</h4>
 <pre>protected&nbsp;boolean threadSafe</pre>
 <div class="block">When false the bridge has to run in synchronized mode. default value -
  true.</div>
 </li>
 </ul>
 <a name="recordkeyColumn">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>recordkeyColumn</h4>
 <pre>protected&nbsp;<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a> recordkeyColumn</pre>
 <div class="block">The name of the recordkey column. It can appear in any location in the
  columns list. By specifying the recordkey column, the user declares that
  he is interested to receive for every record retrieved also the the
  recordkey in the database. The recordkey is present in HBase table (it is
  called rowkey), and in sequence files. When the HDFS storage element
  queried will not have a recordkey and the user will still specify it in
  the "create external table" statement, then the values for this field
  will be null. This field will always be the first field in the tuple
  returned.</div>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="InputData--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>InputData</h4>
 <pre>public&nbsp;InputData()</pre>
 <div class="block">Constructs an empty InputData</div>
 </li>
 </ul>
 <a name="InputData-org.apache.hawq.pxf.api.utilities.InputData-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>InputData</h4>
 <pre>public&nbsp;InputData(<a href="../../../../../../org/apache/hawq/pxf/api/utilities/InputData.html" title="class in org.apache.hawq.pxf.api.utilities">InputData</a>&nbsp;copy)</pre>
 <div class="block">Constructs an InputData from a copy. Used to create from an extending
  class.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>copy</code> - the input data to copy</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="getUserProperty-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getUserProperty</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getUserProperty(java.lang.String&nbsp;userProp)</pre>
 <div class="block">Returns a user defined property.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>userProp</code> - the lookup user property</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>property value as a String</dd>
 </dl>
 </li>
 </ul>
 <a name="setFragmentMetadata-byte:A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setFragmentMetadata</h4>
 <pre>public&nbsp;void&nbsp;setFragmentMetadata(byte[]&nbsp;location)</pre>
 <div class="block">Sets the byte serialization of a fragment meta data.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>location</code> - start, len, and location of the fragment</dd>
 </dl>
 </li>
 </ul>
 <a name="getFragmentMetadata--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getFragmentMetadata</h4>
 <pre>public&nbsp;byte[]&nbsp;getFragmentMetadata()</pre>
 <div class="block">The byte serialization of a data fragment.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>serialized fragment metadata</dd>
 </dl>
 </li>
 </ul>
 <a name="getFragmentUserData--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getFragmentUserData</h4>
 <pre>public&nbsp;byte[]&nbsp;getFragmentUserData()</pre>
 <div class="block">Gets any custom user data that may have been passed from the fragmenter.
  Will mostly be used by the accessor or resolver.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>fragment user data</dd>
 </dl>
 </li>
 </ul>
 <a name="setFragmentUserData-byte:A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setFragmentUserData</h4>
 <pre>public&nbsp;void&nbsp;setFragmentUserData(byte[]&nbsp;userData)</pre>
 <div class="block">Sets any custom user data that needs to be shared across plugins. Will
  mostly be set by the fragmenter.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>userData</code> - user data</dd>
 </dl>
 </li>
 </ul>
 <a name="getTotalSegments--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTotalSegments</h4>
 <pre>public&nbsp;int&nbsp;getTotalSegments()</pre>
 <div class="block">Returns the number of segments in HAWQ.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>number of segments</dd>
 </dl>
 </li>
 </ul>
 <a name="getSegmentId--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSegmentId</h4>
 <pre>public&nbsp;int&nbsp;getSegmentId()</pre>
 <div class="block">Returns the current segment ID in HAWQ.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>current segment ID</dd>
 </dl>
 </li>
 </ul>
 <a name="hasFilter--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>hasFilter</h4>
 <pre>public&nbsp;boolean&nbsp;hasFilter()</pre>
 <div class="block">Returns true if there is a filter string to parse.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>whether there is a filter string</dd>
 </dl>
 </li>
 </ul>
 <a name="getFilterString--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getFilterString</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getFilterString()</pre>
 <div class="block">Returns the filter string, <tt>null</tt> if #hasFilter is <tt>false</tt>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the filter string or null</dd>
 </dl>
 </li>
 </ul>
 <a name="getTupleDescription--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTupleDescription</h4>
 <pre>public&nbsp;java.util.ArrayList&lt;<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a>&gt;&nbsp;getTupleDescription()</pre>
 <div class="block">Returns tuple description.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>tuple description</dd>
 </dl>
 </li>
 </ul>
 <a name="getColumns--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getColumns</h4>
 <pre>public&nbsp;int&nbsp;getColumns()</pre>
 <div class="block">Returns the number of columns in tuple description.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>number of columns</dd>
 </dl>
 </li>
 </ul>
 <a name="getColumn-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getColumn</h4>
 <pre>public&nbsp;<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a>&nbsp;getColumn(int&nbsp;index)</pre>
 <div class="block">Returns column index from tuple description.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>index</code> - index of column</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>column by index</dd>
 </dl>
 </li>
 </ul>
 <a name="getRecordkeyColumn--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRecordkeyColumn</h4>
 <pre>public&nbsp;<a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities">ColumnDescriptor</a>&nbsp;getRecordkeyColumn()</pre>
 <div class="block">Returns the column descriptor of the recordkey column. If the recordkey
  column was not specified by the user in the create table statement will
  return null.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>column of record key or null</dd>
 </dl>
 </li>
 </ul>
 <a name="getDataSource--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getDataSource</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getDataSource()</pre>
 <div class="block">Returns the data source of the required resource (i.e a file path or a
  table name).</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>data source</dd>
 </dl>
 </li>
 </ul>
 <a name="setDataSource-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setDataSource</h4>
 <pre>public&nbsp;void&nbsp;setDataSource(java.lang.String&nbsp;dataSource)</pre>
 <div class="block">Sets the data source for the required resource.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>dataSource</code> - data source to be set</dd>
 </dl>
 </li>
 </ul>
 <a name="getAccessor--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getAccessor</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getAccessor()</pre>
 <div class="block">Returns the ClassName for the java class that was defined as Accessor.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>class name for Accessor</dd>
 </dl>
 </li>
 </ul>
 <a name="getResolver--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getResolver</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getResolver()</pre>
 <div class="block">Returns the ClassName for the java class that was defined as Resolver.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>class name for Resolver</dd>
 </dl>
 </li>
 </ul>
 <a name="getFragmenter--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getFragmenter</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getFragmenter()</pre>
 <div class="block">Returns the ClassName for the java class that was defined as Fragmenter
  or null if no fragmenter was defined.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>class name for Fragmenter or null</dd>
 </dl>
 </li>
 </ul>
 <a name="getMetadata--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMetadata</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getMetadata()</pre>
 <div class="block">Returns the ClassName for the java class that was defined as Metadata
  or null if no metadata was defined.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>class name for METADATA or null</dd>
 </dl>
 </li>
 </ul>
 <a name="getLogin--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getLogin</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getLogin()</pre>
 <div class="block">Returns the contents of pxf_remote_service_login set in Hawq. Should the
  user set it to an empty string this function will return null.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>remote login details if set, null otherwise</dd>
 </dl>
 </li>
 </ul>
 <a name="getSecret--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSecret</h4>
 <pre>public&nbsp;java.lang.String&nbsp;getSecret()</pre>
 <div class="block">Returns the contents of pxf_remote_service_secret set in Hawq. Should the
  user set it to an empty string this function will return null.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>remote password if set, null otherwise</dd>
 </dl>
 </li>
 </ul>
 <a name="isThreadSafe--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isThreadSafe</h4>
 <pre>public&nbsp;boolean&nbsp;isThreadSafe()</pre>
 <div class="block">Returns whether this request is thread safe.
  If it is not, request will be handled consequentially and not in parallel.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>whether the request is thread safe</dd>
 </dl>
 </li>
 </ul>
 <a name="getDataFragment--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getDataFragment</h4>
 <pre>public&nbsp;int&nbsp;getDataFragment()</pre>
 <div class="block">Returns a data fragment index. plan to deprecate it in favor of using
  getFragmentMetadata().</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>data fragment index</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/ColumnDescriptor.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/hawq/pxf/api/utilities/Plugin.html" title="class in org.apache.hawq.pxf.api.utilities"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/hawq/pxf/api/utilities/InputData.html" target="_top">Frames</a></li>
 <li><a href="InputData.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>