http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/org/apache/hadoop/hbase/filter/FilterList.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/FilterList.html b/apidocs/org/apache/hadoop/hbase/filter/FilterList.html index face26a..a1b8f66 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/FilterList.html +++ b/apidocs/org/apache/hadoop/hbase/filter/FilterList.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":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":10,"i3":10,"i4":42,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":9,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":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"; @@ -127,7 +127,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html#MUST_PASS_ONE"><code>FilterList.Operator.MUST_PASS_ONE</code></a> (<code>OR</code>). Since you can use Filter Lists as children of Filter Lists, you can create a hierarchy of filters to be evaluated. <br> <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html#MUST_PASS_ALL"><code>FilterList.Operator.MUST_PASS_ALL</code></a> evaluates lazily: evaluation stops as soon as one filter does not - include the KeyValue. <br> + include the Cell. <br> <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html#MUST_PASS_ONE"><code>FilterList.Operator.MUST_PASS_ONE</code></a> evaluates non-lazily: all filters are always evaluated. <br> Defaults to <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html#MUST_PASS_ALL"><code>FilterList.Operator.MUST_PASS_ALL</code></a>.</div> </li> @@ -227,7 +227,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> @@ -251,26 +251,32 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> </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/FilterList.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.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/FilterList.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</code> +<div class="block"><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/FilterList.html#filterRow--">filterRow</a></span>()</code> <div class="block">Filters that never filter by rows based on previously gathered state from - <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> can inherit this implementation that + <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> can inherit this implementation that never filters a row.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#filterRowCells-java.util.List-">filterRowCells</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>> cells)</code> <div class="block">Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#filterRowKey-byte:A-int-int-">filterRowKey</a></span>(byte[] rowKey, int offset, @@ -279,82 +285,82 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> never filters anything.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#filterRowKey-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="i8" class="altColor"> +<tr id="i9" 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/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#getFilters--">getFilters</a></span>()</code> <div class="block">Get the filters.</div> </td> </tr> -<tr id="i9" class="rowColor"> +<tr id="i10" 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/FilterList.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">getNextCellHint</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)</code> <div class="block">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="i10" class="altColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#getOperator--">getOperator</a></span>()</code> <div class="block">Get the operator.</div> </td> </tr> -<tr id="i11" class="rowColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#hasFilterRow--">hasFilterRow</a></span>()</code> <div class="block">Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.</div> </td> </tr> -<tr id="i12" class="altColor"> +<tr id="i13" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#isFamilyEssential-byte:A-">isFamilyEssential</a></span>(byte[] name)</code> <div class="block">By default, we require all scan's column families to be present.</div> </td> </tr> -<tr id="i13" class="rowColor"> +<tr id="i14" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#isReversed--">isReversed</a></span>()</code> </td> </tr> -<tr id="i14" class="altColor"> +<tr id="i15" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html" title="class in org.apache.hadoop.hbase.filter">FilterList</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr id="i15" class="rowColor"> +<tr id="i16" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#reset--">reset</a></span>()</code> <div class="block">Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.</div> </td> </tr> -<tr id="i16" class="altColor"> +<tr id="i17" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#setReversed-boolean-">setReversed</a></span>(boolean reversed)</code> <div class="block">alter the reversed scan flag</div> </td> </tr> -<tr id="i17" class="rowColor"> +<tr id="i18" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#size--">size</a></span>()</code> </td> </tr> -<tr id="i18" class="altColor"> +<tr id="i19" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#toByteArray--">toByteArray</a></span>()</code> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> </td> </tr> -<tr id="i19" class="rowColor"> +<tr id="i20" 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/FilterList.html#toString--">toString</a></span>()</code> <div class="block">Return filter's info for debugging and logging purpose.</div> </td> </tr> -<tr id="i20" class="altColor"> +<tr id="i21" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html#transformCell-org.apache.hadoop.hbase.Cell-">transformCell</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</code> <div class="block">By default no transformation takes place @@ -574,7 +580,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> never filters anything. (ie: returns false). Filters a row based on the row key. If this returns true, the entire row will be excluded. If - false, each KeyValue in the row will be passed to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> below. + 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. 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> @@ -602,7 +608,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. @@ -685,8 +691,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/FilterList.html#line.188">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c) - throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<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/FilterList.html#line.189">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="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 @@ -699,15 +707,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>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="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/FilterList.html#line.194">filterCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#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="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> @@ -722,7 +767,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterRowCells</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.197">filterRowCells</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>> cells) +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.203">filterRowCells</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>> cells) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block">Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. Filters that never filter by modifying the returned List of Cells can @@ -748,7 +793,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>hasFilterRow</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.202">hasFilterRow</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.208">hasFilterRow</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. @@ -769,14 +814,14 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterRow</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.207">filterRow</a>() +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.213">filterRow</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Filters that never filter by rows based on previously gathered state from - <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> can inherit this implementation that + <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> can inherit this implementation that never filters a row. - Last chance to veto row based on previous <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> calls. The filter + Last chance to veto row based on previous <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> calls. The filter needs to retain state then return a particular value for this call if they wish to exclude a row if a certain column is missing (for example). @@ -798,7 +843,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/FilterList.html#line.214">toByteArray</a>() +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.220">toByteArray</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>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> @@ -818,7 +863,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/FilterList.html" title="class in org.apache.hadoop.hbase.filter">FilterList</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.230">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html" title="class in org.apache.hadoop.hbase.filter">FilterList</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.236">parseFrom</a>(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -838,7 +883,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/FilterList.html#line.265">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell) +<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.271">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>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 @@ -867,7 +912,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>isFamilyEssential</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.270">isFamilyEssential</a>(byte[] name) +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.276">isFamilyEssential</a>(byte[] name) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">By default, we require all scan's column families to be present. Our @@ -894,7 +939,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>setReversed</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.275">setReversed</a>(boolean reversed)</pre> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.281">setReversed</a>(boolean reversed)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#setReversed-boolean-">Filter</a></code></span></div> <div class="block">alter the reversed scan flag</div> <dl> @@ -911,7 +956,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>isReversed</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.281">isReversed</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.287">isReversed</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#isReversed--">isReversed</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> @@ -924,7 +969,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/FilterList.html#line.287">toString</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.293">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/FirstKeyOnlyFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html b/apidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html index c44b3c0..0dec5a6 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html +++ b/apidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"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":42,"i3":10,"i4":10,"i5":9,"i6":10,"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"; @@ -189,7 +189,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> @@ -200,36 +200,42 @@ 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/FirstKeyOnlyFilter.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/FirstKeyOnlyFilter.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="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/FirstKeyOnlyFilter.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="i3" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.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>protected boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#hasFoundKV--">hasFoundKV</a></span>()</code> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html" title="class in org.apache.hadoop.hbase.filter">FirstKeyOnlyFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.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="i6" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#setFoundKV-boolean-">setFoundKV</a></span>(boolean value)</code> </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/FirstKeyOnlyFilter.html#toByteArray--">toByteArray</a></span>()</code> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> @@ -319,7 +325,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. @@ -343,7 +349,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/FirstKeyOnlyFilter.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/FirstKeyOnlyFilter.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 @@ -356,14 +364,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/FirstKeyOnlyFilter.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> @@ -377,7 +419,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/FirstKeyOnlyFilter.html#line.61">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/FirstKeyOnlyFilter.html#line.67">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="hasFoundKV--"> @@ -386,7 +428,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>hasFoundKV</h4> -<pre>protected boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#line.70">hasFoundKV</a>()</pre> +<pre>protected boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#line.76">hasFoundKV</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if first KV has been found.</dd> @@ -399,7 +441,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>setFoundKV</h4> -<pre>protected void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#line.78">setFoundKV</a>(boolean value)</pre> +<pre>protected void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#line.84">setFoundKV</a>(boolean value)</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>value</code> - update <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#foundKV"><code>foundKV</code></a> flag with value.</dd> @@ -412,7 +454,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/FirstKeyOnlyFilter.html#line.85">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#line.91">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> @@ -429,7 +471,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/FirstKeyOnlyFilter.html" title="class in org.apache.hadoop.hbase.filter">FirstKeyOnlyFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#line.97">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html" title="class in org.apache.hadoop.hbase.filter">FirstKeyOnlyFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#line.103">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/FirstKeyValueMatchingQualifiersFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html b/apidocs/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html index 60a664e..3f9186d 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html +++ b/apidocs/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":42,"i1":41,"i2":42}; +var methods = {"i0":42,"i1":42,"i2":41,"i3":42}; 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"; @@ -210,18 +210,24 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte </tr> <tr id="i0" 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/FirstKeyValueMatchingQualifiersFilter.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/FirstKeyValueMatchingQualifiersFilter.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"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">A way to filter based on the column family, column qualifier and/or the column value.</div> </td> </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/FirstKeyValueMatchingQualifiersFilter.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="i2" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html" title="class in org.apache.hadoop.hbase.filter">FirstKeyValueMatchingQualifiersFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#toByteArray--">toByteArray</a></span>()</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> @@ -301,7 +307,8 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte <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/FirstKeyValueMatchingQualifiersFilter.html#line.64">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/FirstKeyValueMatchingQualifiersFilter.html#line.65">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 @@ -315,14 +322,49 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte 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/FirstKeyOnlyFilter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html" title="class in org.apache.hadoop.hbase.filter">FirstKeyOnlyFilter</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/FirstKeyValueMatchingQualifiersFilter.html#line.70">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="deprecatedLabel">Deprecated.</span> </div> +<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/FirstKeyOnlyFilter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html" title="class in org.apache.hadoop.hbase.filter">FirstKeyOnlyFilter</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,7 +378,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#line.85">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#line.91">toByteArray</a>()</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> @@ -354,7 +396,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte <ul class="blockListLast"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html" title="class in org.apache.hadoop.hbase.filter">FirstKeyValueMatchingQualifiersFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#line.100">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html" title="class in org.apache.hadoop.hbase.filter">FirstKeyValueMatchingQualifiersFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#line.106">parseFrom</a>(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <dl> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/apidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html b/apidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html index f5f2db3..c3a99c8 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html +++ b/apidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"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":10,"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"; @@ -198,7 +198,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> @@ -212,28 +212,34 @@ 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/FuzzyRowFilter.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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.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="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/FuzzyRowFilter.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="i3" 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/FuzzyRowFilter.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">getNextCellHint</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)</code> <div class="block">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="i3" class="rowColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.html" title="class in org.apache.hadoop.hbase.filter">FuzzyRowFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.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/FuzzyRowFilter.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="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/FuzzyRowFilter.html#toString--">toString</a></span>()</code> <div class="block">Return filter's info for debugging and logging purpose.</div> @@ -298,7 +304,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/FuzzyRowFilter.html#line.151">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</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/FuzzyRowFilter.html#line.152">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 @@ -311,15 +319,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>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/FuzzyRowFilter.html#line.157">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> <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> @@ -332,7 +374,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/FuzzyRowFilter.html#line.177">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)</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/FuzzyRowFilter.html#line.183">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)</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. @@ -358,7 +400,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/FuzzyRowFilter.html#line.254">filterAllRemaining</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.260">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. @@ -381,7 +423,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/FuzzyRowFilter.html#line.261">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.267">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> @@ -398,7 +440,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/FuzzyRowFilter.html" title="class in org.apache.hadoop.hbase.filter">FuzzyRowFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.278">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.html" title="class in org.apache.hadoop.hbase.filter">FuzzyRowFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.284">parseFrom</a>(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -418,7 +460,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/FuzzyRowFilter.html#line.297">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/FuzzyRowFilter.html#line.303">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>