You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by di...@apache.org on 2016/10/17 21:28:01 UTC
[43/52] [partial] hbase-site git commit: Published site at
278625312047a2100f4dbb2d2eaa4e2219d00e14.
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f07ee53f/apidocs/org/apache/hadoop/hbase/filter/FilterList.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/filter/FilterList.html b/apidocs/org/apache/hadoop/hbase/filter/FilterList.html
index 8bf8c8b..2a50d5b 100644
--- a/apidocs/org/apache/hadoop/hbase/filter/FilterList.html
+++ b/apidocs/org/apache/hadoop/hbase/filter/FilterList.html
@@ -18,7 +18,7 @@
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":9,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10};
+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":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -103,12 +103,17 @@ var activeTableTab = "activeTableTab";
<li><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">org.apache.hadoop.hbase.filter.Filter</a></li>
<li>
<ul class="inheritance">
+<li>org.apache.hadoop.hbase.filter.FilterBase</li>
+<li>
+<ul class="inheritance">
<li>org.apache.hadoop.hbase.filter.FilterList</li>
</ul>
</li>
</ul>
</li>
</ul>
+</li>
+</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
@@ -117,7 +122,7 @@ var activeTableTab = "activeTableTab";
<pre>@InterfaceAudience.Public
@InterfaceStability.Stable
public final class <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.55">FilterList</a>
-extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></pre>
+extends org.apache.hadoop.hbase.filter.FilterBase</pre>
<div class="block">Implementation of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a> that represents an ordered List of Filters
which will be evaluated with a specified boolean operator <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html#MUST_PASS_ALL"><code>FilterList.Operator.MUST_PASS_ALL</code></a>
(<code>AND</code>) or <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html#MUST_PASS_ONE"><code>FilterList.Operator.MUST_PASS_ONE</code></a> (<code>OR</code>).
@@ -242,117 +247,134 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
</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/hadoop/hbase/filter/FilterList.html#addFilter-java.util.List-">addFilter</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> filters)</code> </td>
+</tr>
+<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#filterAllRemaining--">filterAllRemaining</a></span>()</code>
-<div class="block">If this returns true, the scan will terminate.</div>
+<div class="block">Filters that never filter all remaining can inherit this implementation that
+ never stops the filter early.</div>
</td>
</tr>
-<tr id="i2" class="altColor">
+<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</code>
<div class="block">A way to filter based on the column family, column qualifier and/or the column value.</div>
</td>
</tr>
-<tr id="i3" class="rowColor">
+<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#filterRow--">filterRow</a></span>()</code>
-<div class="block">Last chance to veto row based on previous <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> calls.</div>
+<div class="block">Filters that never filter by rows based on previously gathered state from
+ <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> can inherit this implementation that
+ never filters a row.</div>
</td>
</tr>
-<tr id="i4" class="altColor">
+<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#filterRowCells-java.util.List-">filterRowCells</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>> cells)</code>
<div class="block">Filters that never filter by modifying the returned List of Cells can
inherit this implementation that does nothing.</div>
</td>
</tr>
-<tr id="i5" class="rowColor">
+<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#filterRowKey-byte:A-int-int-">filterRowKey</a></span>(byte[] rowKey,
int offset,
int length)</code>
-<div class="block">Filters a row based on the row key.</div>
+<div class="block">Filters that do not filter by row key can inherit this implementation that
+ never filters anything.</div>
</td>
</tr>
-<tr id="i6" class="altColor">
+<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#filterRowKey-org.apache.hadoop.hbase.Cell-">filterRowKey</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> firstRowCell)</code>
<div class="block">Filters a row based on the row key.</div>
</td>
</tr>
-<tr id="i7" class="rowColor">
+<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#getFilters--">getFilters</a></span>()</code>
<div class="block">Get the filters.</div>
</td>
</tr>
-<tr id="i8" class="altColor">
+<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">getNextCellHint</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)</code>
-<div class="block">If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is
- the next key it must seek to.</div>
+<div class="block">Filters that are not sure which key must be next seeked to, can inherit
+ this implementation that, by default, returns a null Cell.</div>
</td>
</tr>
-<tr id="i9" class="rowColor">
+<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#getOperator--">getOperator</a></span>()</code>
<div class="block">Get the operator.</div>
</td>
</tr>
-<tr id="i10" class="altColor">
+<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#hasFilterRow--">hasFilterRow</a></span>()</code>
-<div class="block">Primarily used to check for conflicts with scans(such as scans that do not read a full row at a
- time).</div>
+<div class="block">Fitlers that never filter by modifying the returned List of Cells can
+ inherit this implementation that does nothing.</div>
</td>
</tr>
-<tr id="i11" class="rowColor">
+<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#isFamilyEssential-byte:A-">isFamilyEssential</a></span>(byte[] name)</code>
-<div class="block">Check that given column family is essential for filter to check row.</div>
+<div class="block">By default, we require all scan's column families to be present.</div>
</td>
</tr>
-<tr id="i12" class="altColor">
+<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html" title="class in org.apache.hadoop.hbase.filter">FilterList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td>
</tr>
-<tr id="i13" class="rowColor">
+<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#reset--">reset</a></span>()</code>
-<div class="block">Reset the state of the filter between rows.</div>
+<div class="block">Filters that are purely stateless and do nothing in their reset() methods can inherit
+ this null/empty implementation.</div>
</td>
</tr>
-<tr id="i14" class="altColor">
+<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#setReversed-boolean-">setReversed</a></span>(boolean reversed)</code>
<div class="block">alter the reversed scan flag</div>
</td>
</tr>
-<tr id="i15" class="rowColor">
+<tr id="i16" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#toByteArray--">toByteArray</a></span>()</code>
-<div class="block">TODO: JAVADOC
-
- Concrete implementers can signal a failure condition in their code by throwing an
- <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
+<div class="block">Return length 0 byte array for Filters that don't require special serialization</div>
</td>
</tr>
-<tr id="i16" class="altColor">
+<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#toString--">toString</a></span>()</code> </td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#toString--">toString</a></span>()</code>
+<div class="block">Return filter's info for debugging and logging purpose.</div>
+</td>
</tr>
-<tr id="i17" class="rowColor">
+<tr id="i18" class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#toString-int-">toString</a></span>(int maxFilters)</code> </td>
</tr>
-<tr id="i18" class="altColor">
+<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#transformCell-org.apache.hadoop.hbase.Cell-">transformCell</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</code>
-<div class="block">Give the filter a chance to transform the passed KeyValue.</div>
+<div class="block">By default no transformation takes place
+
+ Give the filter a chance to transform the passed KeyValue.</div>
</td>
</tr>
</table>
<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.filter.FilterBase">
+<!-- -->
+</a>
+<h3>Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase</h3>
+<code>createFilterFromArguments</code></li>
+</ul>
+<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.filter.Filter">
<!-- -->
</a>
@@ -388,7 +410,8 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<h4>FilterList</h4>
<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.89">FilterList</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> rowFilters)</pre>
<div class="block">Constructor that takes a set of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s. The default operator
- MUST_PASS_ALL is assumed.</div>
+ MUST_PASS_ALL is assumed.
+ All filters are cloned to internal list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowFilters</code> - list of filters</dd>
@@ -401,7 +424,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>FilterList</h4>
-<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.102">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>... rowFilters)</pre>
+<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.99">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>... rowFilters)</pre>
<div class="block">Constructor that takes a var arg number of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s. The fefault operator
MUST_PASS_ALL is assumed.</div>
<dl>
@@ -416,7 +439,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>FilterList</h4>
-<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.111">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator)</pre>
+<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.108">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator)</pre>
<div class="block">Constructor that takes an operator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -430,7 +453,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>FilterList</h4>
-<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.121">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator,
+<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.119">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> rowFilters)</pre>
<div class="block">Constructor that takes a set of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s and an operator.</div>
<dl>
@@ -446,7 +469,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockListLast">
<li class="blockList">
<h4>FilterList</h4>
-<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.132">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator,
+<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.130">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator,
<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>... rowFilters)</pre>
<div class="block">Constructor that takes a var arg number of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s and an operator.</div>
<dl>
@@ -470,7 +493,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>getOperator</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.142">getOperator</a>()</pre>
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.140">getOperator</a>()</pre>
<div class="block">Get the operator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -484,7 +507,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>getFilters</h4>
-<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.151">getFilters</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.149">getFilters</a>()</pre>
<div class="block">Get the filters.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -492,13 +515,22 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
</dl>
</li>
</ul>
+<a name="addFilter-java.util.List-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addFilter</h4>
+<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.186">addFilter</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> filters)</pre>
+</li>
+</ul>
<a name="addFilter-org.apache.hadoop.hbase.filter.Filter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFilter</h4>
-<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.160">addFilter</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</pre>
+<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.196">addFilter</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</pre>
<div class="block">Add a filter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -512,16 +544,19 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
-<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.170">reset</a>()
+<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.201">reset</a>()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--">Filter</a></code></span></div>
-<div class="block">Reset the state of the filter between rows.
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">Filters that are purely stateless and do nothing in their reset() methods can inherit
+ this null/empty implementation.
+
+ Reset the state of the filter between rows.
Concrete implementers can signal a failure condition in their code by throwing an
<a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--">reset</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>reset</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case an I/O or an filter specific failure needs to be signaled.</dd>
</dl>
@@ -533,19 +568,22 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>filterRowKey</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.179">filterRowKey</a>(byte[] rowKey,
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.210">filterRowKey</a>(byte[] rowKey,
int offset,
int length)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-byte:A-int-int-">Filter</a></code></span></div>
-<div class="block">Filters a row based on the row key. If this returns true, the entire row will be excluded. If
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">Filters that do not filter by row key can inherit this implementation that
+ never filters anything. (ie: returns false).
+
+ Filters a row based on the row key. If this returns true, the entire row will be excluded. If
false, each KeyValue in the row will be passed to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> below.
Concrete implementers can signal a failure condition in their code by throwing an
<a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-byte:A-int-int-">filterRowKey</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>filterRowKey</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowKey</code> - buffer containing row key</dd>
<dd><code>offset</code> - offset into buffer where row key starts</dd>
@@ -563,7 +601,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>filterRowKey</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.200">filterRowKey</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> firstRowCell)
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.234">filterRowKey</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> firstRowCell)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div>
<div class="block">Filters a row based on the row key. If this returns true, the entire row will be excluded. If
@@ -574,8 +612,8 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
Concrete implementers can signal a failure condition in their code by throwing an
<a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-">filterRowKey</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>filterRowKey</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>firstRowCell</code> - The first cell coming in the new row</dd>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -591,16 +629,19 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>filterAllRemaining</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.219">filterAllRemaining</a>()
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.256">filterAllRemaining</a>()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterAllRemaining--">Filter</a></code></span></div>
-<div class="block">If this returns true, the scan will terminate.
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">Filters that never filter all remaining can inherit this implementation that
+ never stops the filter early.
+
+ If this returns true, the scan will terminate.
Concrete implementers can signal a failure condition in their code by throwing an
<a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterAllRemaining--">filterAllRemaining</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>filterAllRemaining</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true to end scan, false to continue.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
@@ -614,14 +655,16 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>transformCell</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.236">transformCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.276">transformCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#transformCell-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div>
-<div class="block">Give the filter a chance to transform the passed KeyValue. If the Cell is changed a new
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">By default no transformation takes place
+
+ Give the filter a chance to transform the passed KeyValue. If the Cell is changed a new
Cell object must be returned.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#transformCell-org.apache.hadoop.hbase.Cell-">transformCell</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>transformCell</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>c</code> - the KeyValue in question</dd>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -645,7 +688,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>filterKeyValue</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.247">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.290">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div>
<div class="block">A way to filter based on the column family, column qualifier and/or the column value. Return
@@ -682,18 +725,21 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>filterRowCells</h4>
-<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.341">filterRowCells</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>> cells)
+<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.387">filterRowCells</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>> cells)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Filters that never filter by modifying the returned List of Cells can
inherit this implementation that does nothing.
+ Filters that never filter by modifying the returned List of Cells can
+ inherit this implementation that does nothing.
+
Chance to alter the list of Cells to be submitted. Modifications to the list will carry on
Concrete implementers can signal a failure condition in their code by throwing an
<a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowCells-java.util.List-">filterRowCells</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>filterRowCells</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cells</code> - the list of Cells to be filtered</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
@@ -707,13 +753,16 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>hasFilterRow</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.349">hasFilterRow</a>()</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#hasFilterRow--">Filter</a></code></span></div>
-<div class="block">Primarily used to check for conflicts with scans(such as scans that do not read a full row at a
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.395">hasFilterRow</a>()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">Fitlers that never filter by modifying the returned List of Cells can
+ inherit this implementation that does nothing.
+
+ Primarily used to check for conflicts with scans(such as scans that do not read a full row at a
time).</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#hasFilterRow--">hasFilterRow</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>hasFilterRow</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if this filter actively uses filterRowCells(List) or filterRow().</dd>
</dl>
@@ -725,18 +774,22 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>filterRow</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.360">filterRow</a>()
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.406">filterRow</a>()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRow--">Filter</a></code></span></div>
-<div class="block">Last chance to veto row based on previous <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> calls. The filter
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">Filters that never filter by rows based on previously gathered state from
+ <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> can inherit this implementation that
+ never filters a row.
+
+ Last chance to veto row based on previous <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> calls. The filter
needs to retain state then return a particular value for this call if they wish to exclude a
row if a certain column is missing (for example).
Concrete implementers can signal a failure condition in their code by throwing an
<a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRow--">filterRow</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>filterRow</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true to exclude row, false to include row.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
@@ -750,16 +803,13 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>toByteArray</h4>
-<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.380">toByteArray</a>()
+<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.429">toByteArray</a>()
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#toByteArray--">Filter</a></code></span></div>
-<div class="block">TODO: JAVADOC
-
- Concrete implementers can signal a failure condition in their code by throwing an
- <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">Return length 0 byte array for Filters that don't require special serialization</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#toByteArray--">toByteArray</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>toByteArray</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The filter serialized using pb</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
@@ -773,7 +823,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>parseFrom</h4>
-<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html" title="class in org.apache.hadoop.hbase.filter">FilterList</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.397">parseFrom</a>(byte[] pbBytes)
+<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html" title="class in org.apache.hadoop.hbase.filter">FilterList</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.446">parseFrom</a>(byte[] pbBytes)
throws org.apache.hadoop.hbase.exceptions.DeserializationException</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -793,18 +843,21 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>getNextCellHint</h4>
-<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.435">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)
+<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.484">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div>
-<div class="block">If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">Filters that are not sure which key must be next seeked to, can inherit
+ this implementation that, by default, returns a null Cell.
+
+ If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is
the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the
QueryMatcher would call this function to find out which key it must next seek to.
Concrete implementers can signal a failure condition in their code by throwing an
<a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">getNextCellHint</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>getNextCellHint</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>KeyValue which must be next seeked. return null if the filter is not sure which key to
seek to next.</dd>
@@ -819,10 +872,13 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>isFamilyEssential</h4>
-<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.468">isFamilyEssential</a>(byte[] name)
+<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.518">isFamilyEssential</a>(byte[] name)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#isFamilyEssential-byte:A-">Filter</a></code></span></div>
-<div class="block">Check that given column family is essential for filter to check row. Most filters always return
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">By default, we require all scan's column families to be present. Our
+ subclasses may be more precise.
+
+ Check that given column family is essential for filter to check row. Most filters always return
true here. But some could have more sophisticated logic which could significantly reduce
scanning process by not even touching columns until we are 100% sure that it's data is needed
in result.
@@ -830,8 +886,8 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
Concrete implementers can signal a failure condition in their code by throwing an
<a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#isFamilyEssential-byte:A-">isFamilyEssential</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd>
+<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
+<dd><code>isFamilyEssential</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - in case an I/O or an filter specific failure needs to be signaled.</dd>
</dl>
@@ -843,7 +899,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>setReversed</h4>
-<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.479">setReversed</a>(boolean reversed)</pre>
+<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.532">setReversed</a>(boolean reversed)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#setReversed-boolean-">Filter</a></code></span></div>
<div class="block">alter the reversed scan flag</div>
<dl>
@@ -860,10 +916,12 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
-<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.488">toString</a>()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.541">toString</a>()</pre>
+<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div>
+<div class="block">Return filter's info for debugging and logging purpose.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
-<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
+<dd><code>toString</code> in class <code>org.apache.hadoop.hbase.filter.FilterBase</code></dd>
</dl>
</li>
</ul>
@@ -873,7 +931,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
-<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.492">toString</a>(int maxFilters)</pre>
+<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.545">toString</a>(int maxFilters)</pre>
</li>
</ul>
</li>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f07ee53f/apidocs/org/apache/hadoop/hbase/filter/class-use/Filter.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/filter/class-use/Filter.html b/apidocs/org/apache/hadoop/hbase/filter/class-use/Filter.html
index 644a013..53c93e9 100644
--- a/apidocs/org/apache/hadoop/hbase/filter/class-use/Filter.html
+++ b/apidocs/org/apache/hadoop/hbase/filter/class-use/Filter.html
@@ -541,6 +541,10 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div>
</tr>
<tbody>
<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><span class="typeNameLabel">FilterList.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/filter/FilterList.html#addFilter-java.util.List-">addFilter</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> filters)</code> </td>
+</tr>
+<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></td>
<td class="colLast"><span class="typeNameLabel">ParseFilter.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/filter/ParseFilter.html#popArguments-java.util.Stack-java.util.Stack-">popArguments</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>> operatorStack,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a><<a href="../../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> filterStack)</code>
@@ -548,7 +552,7 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div>
from the filterStack and evaluates them</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><span class="typeNameLabel">ParseFilter.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/filter/ParseFilter.html#reduce-java.util.Stack-java.util.Stack-java.nio.ByteBuffer-">reduce</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>> operatorStack,
<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Stack.html?is-external=true" title="class or interface in java.util">Stack</a><<a href="../../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> filterStack,
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f07ee53f/apidocs/org/apache/hadoop/hbase/filter/package-tree.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/filter/package-tree.html b/apidocs/org/apache/hadoop/hbase/filter/package-tree.html
index 2077317..769f5e3 100644
--- a/apidocs/org/apache/hadoop/hbase/filter/package-tree.html
+++ b/apidocs/org/apache/hadoop/hbase/filter/package-tree.html
@@ -109,6 +109,7 @@
<li type="circle">org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/ValueFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">ValueFilter</span></a></li>
</ul>
</li>
+<li type="circle">org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">FilterList</span></a></li>
<li type="circle">org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">FirstKeyOnlyFilter</span></a>
<ul>
<li type="circle">org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">FirstKeyValueMatchingQualifiersFilter</span></a></li>
@@ -132,7 +133,6 @@
<li type="circle">org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/WhileMatchFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">WhileMatchFilter</span></a></li>
</ul>
</li>
-<li type="circle">org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">FilterList</span></a></li>
</ul>
</li>
<li type="circle">org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">MultiRowRangeFilter.RowRange</span></a> (implements java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><T>)</li>