| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_65) on Wed Apr 20 18:03:37 PDT 2016 --> |
| <title>org.apache.hawq.pxf.api</title> |
| <meta name="date" content="2016-04-20"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.hawq.pxf.api"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Package</li> |
| <li><a href="../../../../../org/apache/hawq/pxf/api/io/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hawq/pxf/api/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.hawq.pxf.api</h1> |
| <div class="docSummary"> |
| <div class="block">Provides PXF base classes and interfaces for all the PXF plugins.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Interface a user of FilterParser should implement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api">ReadAccessor</a></td> |
| <td class="colLast"> |
| <div class="block">Interface that defines access to the source data store (e.g, a file on HDFS, a region of an HBase table, etc).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/ReadResolver.html" title="interface in org.apache.hawq.pxf.api">ReadResolver</a></td> |
| <td class="colLast"> |
| <div class="block">Interface that defines the deserialization of one record brought from the <a href="../../../../../org/apache/hawq/pxf/api/ReadAccessor.html" title="interface in org.apache.hawq.pxf.api"><code>ReadAccessor</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/WriteAccessor.html" title="interface in org.apache.hawq.pxf.api">WriteAccessor</a></td> |
| <td class="colLast"> |
| <div class="block">Interface for writing data into a data store (e.g.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/WriteResolver.html" title="interface in org.apache.hawq.pxf.api">WriteResolver</a></td> |
| <td class="colLast"> |
| <div class="block">Interface that defines the serialization of data read from the DB |
| into a OneRow object.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.html" title="class in org.apache.hawq.pxf.api">FilterParser</a></td> |
| <td class="colLast"> |
| <div class="block">The parser code which goes over a filter string and pushes operands onto a stack.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.BasicFilter.html" title="class in org.apache.hawq.pxf.api">FilterParser.BasicFilter</a></td> |
| <td class="colLast"> |
| <div class="block">Basic filter provided for cases where the target storage system does not provide it own filter |
| For example: Hbase storage provides its own filter but for a Writable based record in a |
| SequenceFile there is no filter provided and so we need to have a default</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/Fragment.html" title="class in org.apache.hawq.pxf.api">Fragment</a></td> |
| <td class="colLast"> |
| <div class="block">Fragment holds a data fragment' information.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/Fragmenter.html" title="class in org.apache.hawq.pxf.api">Fragmenter</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract class that defines the splitting of a data resource into fragments |
| that can be processed in parallel.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.html" title="class in org.apache.hawq.pxf.api">FragmentsStats</a></td> |
| <td class="colLast"> |
| <div class="block">FragmentsStats holds statistics for a given path.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/Metadata.html" title="class in org.apache.hawq.pxf.api">Metadata</a></td> |
| <td class="colLast"> |
| <div class="block">Metadata holds an item's metadata information.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/Metadata.Field.html" title="class in org.apache.hawq.pxf.api">Metadata.Field</a></td> |
| <td class="colLast"> |
| <div class="block">Class representing item field - name and type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/Metadata.Item.html" title="class in org.apache.hawq.pxf.api">Metadata.Item</a></td> |
| <td class="colLast"> |
| <div class="block">Class representing item name - db/schema/path name and table/file name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/MetadataFetcher.html" title="class in org.apache.hawq.pxf.api">MetadataFetcher</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract class that defines getting metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/OneField.html" title="class in org.apache.hawq.pxf.api">OneField</a></td> |
| <td class="colLast"> |
| <div class="block">Defines a one field in a deserialized record.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/OneRow.html" title="class in org.apache.hawq.pxf.api">OneRow</a></td> |
| <td class="colLast"> |
| <div class="block">Represents one row in the external system data store.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/FilterParser.Operation.html" title="enum in org.apache.hawq.pxf.api">FilterParser.Operation</a></td> |
| <td class="colLast"> |
| <div class="block">Supported operations by the parser.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/FragmentsStats.SizeUnit.html" title="enum in org.apache.hawq.pxf.api">FragmentsStats.SizeUnit</a></td> |
| <td class="colLast"> |
| <div class="block">Enum to represent unit (Bytes/KB/MB/GB/TB)</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/OutputFormat.html" title="enum in org.apache.hawq.pxf.api">OutputFormat</a></td> |
| <td class="colLast"> |
| <div class="block">PXF supported output formats: <a href="../../../../../org/apache/hawq/pxf/api/OutputFormat.html#TEXT"><code>OutputFormat.TEXT</code></a> and <a href="../../../../../org/apache/hawq/pxf/api/OutputFormat.html#BINARY"><code>OutputFormat.BINARY</code></a></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/BadRecordException.html" title="class in org.apache.hawq.pxf.api">BadRecordException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when a problem occurs while fetching or parsing a record from the user's input data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/UnsupportedTypeException.html" title="class in org.apache.hawq.pxf.api">UnsupportedTypeException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when the resolver tries to serializes/deserializes an unsupported type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/hawq/pxf/api/UserDataException.html" title="class in org.apache.hawq.pxf.api">UserDataException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when Accessor/Resolver failes to parse <a href="../../../../../org/apache/hawq/pxf/api/utilities/InputData.html#userData"><code>InputData.userData</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.hawq.pxf.api Description">Package org.apache.hawq.pxf.api Description</h2> |
| <div class="block">Provides PXF base classes and interfaces for all the PXF plugins.</div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Package</li> |
| <li><a href="../../../../../org/apache/hawq/pxf/api/io/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hawq/pxf/api/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |