http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html b/apidocs/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html index 64cbea3..b1aefe7 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html +++ b/apidocs/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":9,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":9,"i7":10,"i8":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"; @@ -186,7 +186,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> </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> @@ -204,31 +204,37 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> </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/InclusiveStopFilter.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/InclusiveStopFilter.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/InclusiveStopFilter.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/InclusiveStopFilter.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="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/InclusiveStopFilter.html#getStopRowKey--">getStopRowKey</a></span>()</code> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/InclusiveStopFilter.html" title="class in org.apache.hadoop.hbase.filter">InclusiveStopFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/InclusiveStopFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/InclusiveStopFilter.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="i7" class="rowColor"> +<tr id="i8" 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/InclusiveStopFilter.html#toString--">toString</a></span>()</code> <div class="block">Return filter's info for debugging and logging purpose.</div> @@ -302,7 +308,9 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <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/InclusiveStopFilter.html#line.55">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/InclusiveStopFilter.html#line.56">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 @@ -315,14 +323,48 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> 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/InclusiveStopFilter.html#line.61">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> @@ -336,10 +378,10 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterRowKey</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html#line.60">filterRowKey</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> firstRowCell)</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html#line.66">filterRowKey</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> firstRowCell)</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. @@ -361,7 +403,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterAllRemaining</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html#line.68">filterAllRemaining</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html#line.74">filterAllRemaining</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">Filters that never filter all remaining can inherit this implementation that never stops the filter early. @@ -384,7 +426,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <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/InclusiveStopFilter.html#line.72">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/InclusiveStopFilter.html#line.78">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--"> @@ -393,7 +435,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html#line.82">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html#line.88">toByteArray</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 length 0 byte array for Filters that don't require special serialization</div> <dl> @@ -410,7 +452,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/InclusiveStopFilter.html" title="class in org.apache.hadoop.hbase.filter">InclusiveStopFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html#line.96">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/InclusiveStopFilter.html" title="class in org.apache.hadoop.hbase.filter">InclusiveStopFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/InclusiveStopFilter.html#line.102">parseFrom</a>(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -430,7 +472,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <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/InclusiveStopFilter.html#line.121">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/InclusiveStopFilter.html#line.127">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>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html b/apidocs/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html index eb5a1ae..bb0de89 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html +++ b/apidocs/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":9,"i1":10,"i2":42,"i3":10,"i4":9,"i5":10,"i6":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"; @@ -190,7 +190,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> </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> @@ -201,27 +201,33 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> </tr> <tr id="i1" 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/KeyOnlyFilter.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> ignored)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/KeyOnlyFilter.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> ignored)</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="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/KeyOnlyFilter.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> ignored)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/KeyOnlyFilter.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="i3" class="rowColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/KeyOnlyFilter.html" title="class in org.apache.hadoop.hbase.filter">KeyOnlyFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/KeyOnlyFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </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/KeyOnlyFilter.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="i5" class="rowColor"> +<tr id="i6" class="altColor"> <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/KeyOnlyFilter.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> cell)</code> <div class="block">By default no transformation takes place @@ -301,7 +307,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> 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. @@ -355,8 +361,10 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <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/KeyOnlyFilter.html#line.71">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> ignored) - 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> +<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/KeyOnlyFilter.html#line.72">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> ignored) + 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="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 @@ -369,15 +377,52 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> 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>ignored</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="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> +<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/KeyOnlyFilter.html#line.77">filterCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> ignored) + 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#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>ignored</code> - the Cell in question</dd> +<dt><span class="returnLabel">Returns:</span></dt> <dd>code as described below</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> @@ -392,7 +437,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <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/KeyOnlyFilter.html#line.75">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/KeyOnlyFilter.html#line.81">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--"> @@ -401,7 +446,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html#line.88">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html#line.94">toByteArray</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 length 0 byte array for Filters that don't require special serialization</div> <dl> @@ -418,7 +463,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockListLast"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/KeyOnlyFilter.html" title="class in org.apache.hadoop.hbase.filter">KeyOnlyFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html#line.101">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/KeyOnlyFilter.html" title="class in org.apache.hadoop.hbase.filter">KeyOnlyFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/KeyOnlyFilter.html#line.107">parseFrom</a>(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/org/apache/hadoop/hbase/filter/LongComparator.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/LongComparator.html b/apidocs/org/apache/hadoop/hbase/filter/LongComparator.html index 98de221..9f55417 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/LongComparator.html +++ b/apidocs/org/apache/hadoop/hbase/filter/LongComparator.html @@ -302,9 +302,9 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparab throws org.apache.hadoop.hbase.exceptions.DeserializationException</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>pbBytes</code> - A pb serialized <a href="../../../../../org/apache/hadoop/hbase/filter/BinaryComparator.html" title="class in org.apache.hadoop.hbase.filter"><code>BinaryComparator</code></a> instance</dd> +<dd><code>pbBytes</code> - A pb serialized <a href="../../../../../org/apache/hadoop/hbase/filter/LongComparator.html" title="class in org.apache.hadoop.hbase.filter"><code>LongComparator</code></a> instance</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>An instance of <a href="../../../../../org/apache/hadoop/hbase/filter/BinaryComparator.html" title="class in org.apache.hadoop.hbase.filter"><code>BinaryComparator</code></a> made from <code>bytes</code></dd> +<dd>An instance of <a href="../../../../../org/apache/hadoop/hbase/filter/LongComparator.html" title="class in org.apache.hadoop.hbase.filter"><code>LongComparator</code></a> made from <code>bytes</code></dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>org.apache.hadoop.hbase.exceptions.DeserializationException</code></dd> <dt><span class="seeLabel">See Also:</span></dt> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html b/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html index 07efd6b..75eced6 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html +++ b/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html @@ -118,7 +118,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public -public static class <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#line.414">MultiRowRangeFilter.RowRange</a> +public static class <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#line.420">MultiRowRangeFilter.RowRange</a> extends <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> implements <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><<a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a>></pre> </li> @@ -233,7 +233,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>RowRange</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.420">RowRange</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.426">RowRange</a>()</pre> </li> </ul> <a name="RowRange-java.lang.String-boolean-java.lang.String-boolean-"> @@ -242,7 +242,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>RowRange</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.427">RowRange</a>(<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> startRow, +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.433">RowRange</a>(<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> startRow, boolean startRowInclusive, <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> stopRow, boolean stopRowInclusive)</pre> @@ -257,7 +257,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockListLast"> <li class="blockList"> <h4>RowRange</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.435">RowRange</a>(byte[] startRow, +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.441">RowRange</a>(byte[] startRow, boolean startRowInclusive, byte[] stopRow, boolean stopRowInclusive)</pre> @@ -277,7 +277,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>getStartRow</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.443">getStartRow</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.449">getStartRow</a>()</pre> </li> </ul> <a name="getStopRow--"> @@ -286,7 +286,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>getStopRow</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.447">getStopRow</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.453">getStopRow</a>()</pre> </li> </ul> <a name="isStartRowInclusive--"> @@ -295,7 +295,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>isStartRowInclusive</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.454">isStartRowInclusive</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.460">isStartRowInclusive</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>if start row is inclusive.</dd> @@ -308,7 +308,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>isStopRowInclusive</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.461">isStopRowInclusive</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.467">isStopRowInclusive</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>if stop row is inclusive.</dd> @@ -321,7 +321,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>contains</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.465">contains</a>(byte[] row)</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.471">contains</a>(byte[] row)</pre> </li> </ul> <a name="contains-byte:A-int-int-"> @@ -330,7 +330,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>contains</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.469">contains</a>(byte[] buffer, +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.475">contains</a>(byte[] buffer, int offset, int length)</pre> </li> @@ -341,7 +341,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockList"> <li class="blockList"> <h4>compareTo</h4> -<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.496">compareTo</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a> other)</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.502">compareTo</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a> other)</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo-T-"; title="class or interface in java.lang">compareTo</a></code> in interface <code><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><<a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a>></code></dd> @@ -354,7 +354,7 @@ implements <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparabl <ul class="blockListLast"> <li class="blockList"> <h4>isValid</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.500">isValid</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.RowRange.html#line.506">isValid</a>()</pre> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html b/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html index 107c684..827fa81 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html +++ b/apidocs/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":10,"i1":10,"i2":42,"i3":10,"i4":10,"i5":10,"i6":9,"i7":9,"i8":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"; @@ -206,7 +206,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> </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> @@ -220,38 +220,44 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> </tr> <tr id="i1" 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/MultiRowRangeFilter.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> ignored)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.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> ignored)</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="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/MultiRowRangeFilter.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> ignored)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.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="i3" class="rowColor"> +<tr id="i4" class="altColor"> <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/MultiRowRangeFilter.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> currentKV)</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="i4" class="altColor"> +<tr id="i5" class="rowColor"> <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/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#getRowRanges--">getRowRanges</a></span>()</code> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>static <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/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#sortAndMerge-java.util.List-">sortAndMerge</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/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a>> ranges)</code> <div class="block">sort the ranges and if the ranges with overlap, then merge them.</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/MultiRowRangeFilter.html#toByteArray--">toByteArray</a></span>()</code> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> @@ -355,7 +361,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#line.79">filterRowKey</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> firstRowCell)</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. @@ -377,7 +383,9 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <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/MultiRowRangeFilter.html#line.128">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> ignored)</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/MultiRowRangeFilter.html#line.129">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> ignored)</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 @@ -390,15 +398,49 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> 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>ignored</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/MultiRowRangeFilter.html#line.134">filterCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> ignored)</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>ignored</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> <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> @@ -411,7 +453,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <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/MultiRowRangeFilter.html#line.133">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentKV)</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/MultiRowRangeFilter.html#line.139">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentKV)</pre> <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. @@ -437,7 +479,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#line.142">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#line.148">toByteArray</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 length 0 byte array for Filters that don't require special serialization</div> <dl> @@ -454,7 +496,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#line.165">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#line.171">parseFrom</a>(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -472,7 +514,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockListLast"> <li class="blockList"> <h4>sortAndMerge</h4> -<pre>public static <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/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#line.249">sortAndMerge</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/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a>> ranges)</pre> +<pre>public static <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/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#line.255">sortAndMerge</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/MultiRowRangeFilter.RowRange.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter.RowRange</a>> ranges)</pre> <div class="block">sort the ranges and if the ranges with overlap, then merge them.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt>
