http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html index 7a20bbf..bd43512 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":42,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -201,7 +201,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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> @@ -225,38 +225,44 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" </tr> <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/ColumnCountGetFilter.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> v)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</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="i4" class="altColor"> +<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/ColumnCountGetFilter.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"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnCountGetFilter.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> cell)</code> <div class="block">Filters a row based on the row key.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#getLimit--">getLimit</a></span>()</code> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnCountGetFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr id="i7" class="rowColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#reset--">reset</a></span>()</code> <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="i8" class="altColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#toByteArray--">toByteArray</a></span>()</code> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> </td> </tr> -<tr id="i9" class="rowColor"> +<tr id="i10" class="altColor"> <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/ColumnCountGetFilter.html#toString--">toString</a></span>()</code> <div class="block">Return filter's info for debugging and logging purpose.</div> @@ -360,7 +366,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" 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 - 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. + false, each KeyValue in the row will be passed to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> below. If <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterAllRemaining--"><code>Filter.filterAllRemaining()</code></a> returns true, then <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-"><code>Filter.filterRowKey(Cell)</code></a> should also return true. @@ -407,7 +413,9 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <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/ColumnCountGetFilter.html#line.66">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> v)</pre> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +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/ColumnCountGetFilter.html#line.67">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <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 code is described below. This allows filters to filter only certain number of columns, then @@ -420,14 +428,48 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return <code>ReturnCode.NEXT_ROW</code> until <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--"><code>Filter.reset()</code></a> is called just in case the caller calls for the next row. - + 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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</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="paramLabel">Parameters:</span></dt> -<dd><code>v</code> - the Cell in question</dd> +<dd><code>c</code> - the Cell in question</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>code as described below, Filter.ReturnCode.INCLUDE by default</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter"><code>Filter.ReturnCode</code></a></dd> +</dl> +</li> +</ul> +<a name="filterCell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filterCell</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/ColumnCountGetFilter.html#line.72">filterCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-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 + code is described below. This allows filters to filter only certain number of columns, then + terminate without matching ever column. + + If filterRowKey returns true, filterCell needs to be consistent with it. + + filterCell can assume that filterRowKey has already been called for the row. + + If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return + <code>ReturnCode.NEXT_ROW</code> until <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--"><code>Filter.reset()</code></a> is called just in case the caller calls + for the next row. + + 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">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</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="paramLabel">Parameters:</span></dt> +<dd><code>c</code> - the Cell in question</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>code as described below</dd> <dt><span class="seeLabel">See Also:</span></dt> @@ -441,7 +483,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>reset</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#line.72">reset</a>()</pre> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#line.78">reset</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#reset--">FilterBase</a></code></span></div> <div class="block">Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. @@ -462,7 +504,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>createFilterFromArguments</h4> -<pre>public static <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/ColumnCountGetFilter.html#line.76">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> +<pre>public static <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/ColumnCountGetFilter.html#line.82">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> </li> </ul> <a name="toByteArray--"> @@ -471,7 +513,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#line.86">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#line.92">toByteArray</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toByteArray--">FilterBase</a></code></span></div> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> <dl> @@ -488,7 +530,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnCountGetFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#line.99">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnCountGetFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#line.105">parseFrom</a>(byte[] pbBytes) throws <a href="../../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -508,14 +550,14 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>areSerializedFieldsEqual</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#line.115">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html#line.121">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">FilterBase</a></code></span></div> <div class="block">Default implementation so that writers of custom filters aren't forced to implement.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">areSerializedFieldsEqual</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>other</code> - </dd> +<dd><code>o</code> - the other filter to compare with</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.</dd> @@ -528,7 +570,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockListLast"> <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/ColumnCountGetFilter.html#line.124">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/ColumnCountGetFilter.html#line.130">toString</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toString--">FilterBase</a></code></span></div> <div class="block">Return filter's info for debugging and logging purpose.</div> <dl>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html index af191bb..9867f8a 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":10,"i1":9,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":10,"i11":10,"i12":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -218,7 +218,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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> @@ -235,53 +235,59 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" </tr> <tr id="i2" class="altColor"> <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/ColumnPaginationFilter.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> v)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</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"> +<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/ColumnPaginationFilter.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"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<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/ColumnPaginationFilter.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> cell)</code> <div class="block">Filters a row based on the row key.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#getColumnOffset--">getColumnOffset</a></span>()</code> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#getLimit--">getLimit</a></span>()</code> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" 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/ColumnPaginationFilter.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> cell)</code> <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="i7" class="rowColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#getOffset--">getOffset</a></span>()</code> </td> </tr> -<tr id="i8" class="altColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnPaginationFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr id="i9" class="rowColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#reset--">reset</a></span>()</code> <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="i10" class="altColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#toByteArray--">toByteArray</a></span>()</code> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> </td> </tr> -<tr id="i11" class="rowColor"> +<tr id="i12" class="altColor"> <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/ColumnPaginationFilter.html#toString--">toString</a></span>()</code> <div class="block">Return filter's info for debugging and logging purpose.</div> @@ -463,7 +469,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" 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 - 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. + false, each KeyValue in the row will be passed to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> below. If <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterAllRemaining--"><code>Filter.filterAllRemaining()</code></a> returns true, then <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-"><code>Filter.filterRowKey(Cell)</code></a> should also return true. @@ -487,7 +493,9 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <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/ColumnPaginationFilter.html#line.113">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> v)</pre> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +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/ColumnPaginationFilter.html#line.114">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <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 code is described below. This allows filters to filter only certain number of columns, then @@ -500,14 +508,48 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return <code>ReturnCode.NEXT_ROW</code> until <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--"><code>Filter.reset()</code></a> is called just in case the caller calls for the next row. - + 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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</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="paramLabel">Parameters:</span></dt> -<dd><code>v</code> - the Cell in question</dd> +<dd><code>c</code> - the Cell in question</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>code as described below, Filter.ReturnCode.INCLUDE by default</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter"><code>Filter.ReturnCode</code></a></dd> +</dl> +</li> +</ul> +<a name="filterCell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filterCell</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/ColumnPaginationFilter.html#line.119">filterCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-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 + code is described below. This allows filters to filter only certain number of columns, then + terminate without matching ever column. + + If filterRowKey returns true, filterCell needs to be consistent with it. + + filterCell can assume that filterRowKey has already been called for the row. + + If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return + <code>ReturnCode.NEXT_ROW</code> until <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--"><code>Filter.reset()</code></a> is called just in case the caller calls + for the next row. + + 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">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</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="paramLabel">Parameters:</span></dt> +<dd><code>c</code> - the Cell in question</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>code as described below</dd> <dt><span class="seeLabel">See Also:</span></dt> @@ -521,7 +563,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <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/ColumnPaginationFilter.html#line.143">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> +<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/ColumnPaginationFilter.html#line.149">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">FilterBase</a></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. @@ -547,7 +589,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>reset</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#line.148">reset</a>()</pre> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#line.154">reset</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#reset--">FilterBase</a></code></span></div> <div class="block">Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. @@ -568,7 +610,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>createFilterFromArguments</h4> -<pre>public static <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/ColumnPaginationFilter.html#line.153">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> +<pre>public static <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/ColumnPaginationFilter.html#line.159">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> </li> </ul> <a name="toByteArray--"> @@ -577,7 +619,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#line.164">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#line.170">toByteArray</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toByteArray--">FilterBase</a></code></span></div> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> <dl> @@ -594,7 +636,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnPaginationFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#line.183">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnPaginationFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#line.189">parseFrom</a>(byte[] pbBytes) throws <a href="../../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -614,14 +656,14 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>areSerializedFieldsEqual</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#line.203">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html#line.209">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">FilterBase</a></code></span></div> <div class="block">Default implementation so that writers of custom filters aren't forced to implement.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">areSerializedFieldsEqual</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>other</code> - </dd> +<dd><code>o</code> - the other filter to compare with</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.</dd> @@ -634,7 +676,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockListLast"> <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/ColumnPaginationFilter.html#line.216">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/ColumnPaginationFilter.html#line.222">toString</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toString--">FilterBase</a></code></span></div> <div class="block">Return filter's info for debugging and logging purpose.</div> <dl> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html index 6f00059..171f28c 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":10,"i5":42,"i6":10,"i7":10,"i8":10,"i9":9,"i10":10,"i11":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -196,7 +196,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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> @@ -219,42 +219,48 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" </tr> <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/ColumnPrefixFilter.html#filterColumn-org.apache.hadoop.hbase.Cell-">filterColumn</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</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="i4" class="altColor"> <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/ColumnPrefixFilter.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> cell)</code> -<div class="block">A way to filter based on the column family, column qualifier and/or the column value.</div> -</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#filterColumn-org.apache.hadoop.hbase.Cell-">filterColumn</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> </td> </tr> <tr id="i5" 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/ColumnPrefixFilter.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"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<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/ColumnPrefixFilter.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> cell)</code> <div class="block">Filters a row based on the row key.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" 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/ColumnPrefixFilter.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> cell)</code> <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="i7" class="rowColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#getPrefix--">getPrefix</a></span>()</code> </td> </tr> -<tr id="i8" class="altColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnPrefixFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr id="i9" class="rowColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#toByteArray--">toByteArray</a></span>()</code> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> </td> </tr> -<tr id="i10" class="altColor"> +<tr id="i11" 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/ColumnPrefixFilter.html#toString--">toString</a></span>()</code> <div class="block">Return filter's info for debugging and logging purpose.</div> @@ -349,7 +355,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" 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 - 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. + false, each KeyValue in the row will be passed to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> below. If <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterAllRemaining--"><code>Filter.filterAllRemaining()</code></a> returns true, then <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-"><code>Filter.filterRowKey(Cell)</code></a> should also return true. @@ -373,7 +379,9 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <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/ColumnPrefixFilter.html#line.62">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +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/ColumnPrefixFilter.html#line.63">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <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 code is described below. This allows filters to filter only certain number of columns, then @@ -386,13 +394,47 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return <code>ReturnCode.NEXT_ROW</code> until <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--"><code>Filter.reset()</code></a> is called just in case the caller calls for the next row. - + 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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</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="paramLabel">Parameters:</span></dt> +<dd><code>c</code> - the Cell in question</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>code as described below, Filter.ReturnCode.INCLUDE by default</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter"><code>Filter.ReturnCode</code></a></dd> +</dl> +</li> +</ul> +<a name="filterCell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filterCell</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/ColumnPrefixFilter.html#line.68">filterCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-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 + code is described below. This allows filters to filter only certain number of columns, then + terminate without matching ever column. + + If filterRowKey returns true, filterCell needs to be consistent with it. + + filterCell can assume that filterRowKey has already been called for the row. + + If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return + <code>ReturnCode.NEXT_ROW</code> until <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--"><code>Filter.reset()</code></a> is called just in case the caller calls + for the next row. + + 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">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</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="paramLabel">Parameters:</span></dt> <dd><code>cell</code> - the Cell in question</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>code as described below</dd> @@ -407,7 +449,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>filterColumn</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/ColumnPrefixFilter.html#line.70">filterColumn</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> +<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/ColumnPrefixFilter.html#line.76">filterColumn</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> </li> </ul> <a name="compareQualifierPart-org.apache.hadoop.hbase.Cell-int-byte:A-"> @@ -416,7 +458,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>compareQualifierPart</h4> -<pre>private static int <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#line.91">compareQualifierPart</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell, +<pre>private static int <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#line.97">compareQualifierPart</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell, int length, byte[] prefix)</pre> </li> @@ -427,7 +469,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>createFilterFromArguments</h4> -<pre>public static <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/ColumnPrefixFilter.html#line.100">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> +<pre>public static <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/ColumnPrefixFilter.html#line.106">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> </li> </ul> <a name="toByteArray--"> @@ -436,7 +478,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#line.110">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#line.116">toByteArray</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toByteArray--">FilterBase</a></code></span></div> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> <dl> @@ -453,7 +495,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnPrefixFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#line.123">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnPrefixFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#line.129">parseFrom</a>(byte[] pbBytes) throws <a href="../../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -473,14 +515,14 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>areSerializedFieldsEqual</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#line.139">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html#line.145">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">FilterBase</a></code></span></div> <div class="block">Default implementation so that writers of custom filters aren't forced to implement.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">areSerializedFieldsEqual</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>other</code> - </dd> +<dd><code>o</code> - the other filter to compare with</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.</dd> @@ -493,7 +535,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <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/ColumnPrefixFilter.html#line.148">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> +<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/ColumnPrefixFilter.html#line.154">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">FilterBase</a></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. @@ -519,7 +561,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockListLast"> <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/ColumnPrefixFilter.html#line.153">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/ColumnPrefixFilter.html#line.159">toString</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toString--">FilterBase</a></code></span></div> <div class="block">Return filter's info for debugging and logging purpose.</div> <dl>