| <!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>HBaseFilterBuilder</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="HBaseFilterBuilder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":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/plugins/hbase/HBaseDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseResolver.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" target="_top">Frames</a></li> |
| <li><a href="HBaseFilterBuilder.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.plugins.hbase</div> |
| <h2 title="Class HBaseFilterBuilder" class="title">Class HBaseFilterBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hawq.pxf.plugins.hbase.HBaseFilterBuilder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">HBaseFilterBuilder</span> |
| extends java.lang.Object |
| implements <a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a></pre> |
| <div class="block">This is the implementation of <code>FilterParser.FilterBuilder</code> for HBase. |
| <p> |
| The class uses the filter parser code to build a filter object, |
| either simple (single <code>Filter</code> class) or a compound (<code>FilterList</code>) |
| for <a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseAccessor.html" title="class in org.apache.hawq.pxf.plugins.hbase"><code>HBaseAccessor</code></a> to use for its scan. |
| <p> |
| This is done before the scan starts. It is not a scan time operation. |
| <p> |
| HBase row key column is a special case. |
| If the user defined row key column as TEXT and used <code><,>,<=,>=,=</code> operators |
| the startkey (<code>>/>=</code>) and the endkey (<code></<=</code>) are stored in addition to |
| the created filter. |
| This is an addition on top of regular filters and does not replace |
| any logic in HBase filter objects.</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/plugins/hbase/HBaseFilterBuilder.html#HBaseFilterBuilder-org.apache.hawq.pxf.plugins.hbase.utilities.HBaseTupleDescription-">HBaseFilterBuilder</a></span>(<a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/HBaseTupleDescription.html" title="class in org.apache.hawq.pxf.plugins.hbase.utilities">HBaseTupleDescription</a> tupleDescription)</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/plugins/hbase/HBaseFilterBuilder.html#build-org.apache.hawq.pxf.api.FilterParser.Operation-java.lang.Object-java.lang.Object-">build</a></span>(<a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.Operation.html" title="enum in org.apache.hawq.pxf.api">FilterParser.Operation</a> opId, |
| java.lang.Object leftOperand, |
| java.lang.Object rightOperand)</code> |
| <div class="block">Builds a filter from the input operands and operation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html#endKey--">endKey</a></span>()</code> |
| <div class="block">Returns the endKey for scanning the HBase table.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.hbase.filter.Filter</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html#getFilterObject-java.lang.String-">getFilterObject</a></span>(java.lang.String filterString)</code> |
| <div class="block">Translates a filterString into a HBase <code>Filter</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html#startKey--">startKey</a></span>()</code> |
| <div class="block">Returns the startKey for scanning the HBase table.</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="HBaseFilterBuilder-org.apache.hawq.pxf.plugins.hbase.utilities.HBaseTupleDescription-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HBaseFilterBuilder</h4> |
| <pre>public HBaseFilterBuilder(<a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/utilities/HBaseTupleDescription.html" title="class in org.apache.hawq.pxf.plugins.hbase.utilities">HBaseTupleDescription</a> tupleDescription)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getFilterObject-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFilterObject</h4> |
| <pre>public org.apache.hadoop.hbase.filter.Filter getFilterObject(java.lang.String filterString) |
| throws java.lang.Exception</pre> |
| <div class="block">Translates a filterString into a HBase <code>Filter</code> object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filterString</code> - filter string</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>filter object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if parsing failed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startKey</h4> |
| <pre>public byte[] startKey()</pre> |
| <div class="block">Returns the startKey for scanning the HBase table. |
| If the user specified a <code>> / >=</code> operation |
| on a textual row key column, this value will be returned. |
| Otherwise, the start of table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>start key for scanning HBase table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="endKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endKey</h4> |
| <pre>public byte[] endKey()</pre> |
| <div class="block">Returns the endKey for scanning the HBase table. |
| If the user specified a <code>< / <=</code> operation |
| on a textual row key column, this value will be returned. |
| Otherwise, the end of table.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>end key for scanning HBase table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build-org.apache.hawq.pxf.api.FilterParser.Operation-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public java.lang.Object build(<a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.Operation.html" title="enum in org.apache.hawq.pxf.api">FilterParser.Operation</a> opId, |
| java.lang.Object leftOperand, |
| java.lang.Object rightOperand) |
| throws java.lang.Exception</pre> |
| <div class="block">Builds a filter from the input operands and operation. |
| Two kinds of operations are handled: |
| <ol> |
| <li>Simple operation between <code>FilterParser.Constant</code> and <code>FilterParser.ColumnIndex</code>. |
| Supported operations are <code><, >, <=, <=, >=, =, !=</code>. </li> |
| <li>Compound operations between <code>Filter</code> objects. |
| The only supported operation is <code>AND</code>. </li> |
| </ol> |
| <p> |
| This function is called by <a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.html" title="class in org.apache.hawq.pxf.api"><code>FilterParser</code></a>, |
| each time the parser comes across an operator.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html#build-org.apache.hawq.pxf.api.FilterParser.Operation-java.lang.Object-java.lang.Object-">build</a></code> in interface <code><a href="../../../../../../org/apache/hawq/pxf/api/FilterParser.FilterBuilder.html" title="interface in org.apache.hawq.pxf.api">FilterParser.FilterBuilder</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>opId</code> - the parse operation to perform</dd> |
| <dd><code>leftOperand</code> - the left operand</dd> |
| <dd><code>rightOperand</code> - the right operand</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the built filter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if building the filter failed</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/plugins/hbase/HBaseDataFragmenter.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hawq/pxf/plugins/hbase/HBaseResolver.html" title="class in org.apache.hawq.pxf.plugins.hbase"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hawq/pxf/plugins/hbase/HBaseFilterBuilder.html" target="_top">Frames</a></li> |
| <li><a href="HBaseFilterBuilder.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> |