http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/FilterWrapper.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/FilterWrapper.html b/devapidocs/org/apache/hadoop/hbase/filter/FilterWrapper.html index 1830d8e..02e1b24 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/FilterWrapper.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/FilterWrapper.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":9,"i12":10,"i13":10,"i14":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":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":10,"i15":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"; @@ -203,7 +203,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl </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> @@ -223,27 +223,33 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl </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/FilterWrapper.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/FilterWrapper.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/FilterWrapper.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/FilterWrapper.html#filterRow--">filterRow</a></span>()</code> -<div class="block">Last chance to veto row based on previous <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> calls.</div> +<div class="block">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.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.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>> kvs)</code> <div class="block">Chance to alter the list of Cells to be submitted.</div> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.FilterRowRetCode.html" title="enum in org.apache.hadoop.hbase.filter">FilterWrapper.FilterRowRetCode</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.html#filterRowCellsWithRet-java.util.List-">filterRowCellsWithRet</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>> kvs)</code> </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/FilterWrapper.html#filterRowKey-byte:A-int-int-">filterRowKey</a></span>(byte[] buffer, int offset, @@ -251,43 +257,43 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <div class="block">Filters a row based on the row key.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.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="i8" class="altColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">getNextCellHint</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)</code> <div class="block">If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is the next key it must seek to.</div> </td> </tr> -<tr id="i9" class="rowColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.html#hasFilterRow--">hasFilterRow</a></span>()</code> <div class="block">Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time).</div> </td> </tr> -<tr id="i10" class="altColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.html#isFamilyEssential-byte:A-">isFamilyEssential</a></span>(byte[] name)</code> <div class="block">Check that given column family is essential for filter to check row.</div> </td> </tr> -<tr id="i11" class="rowColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.html" title="class in org.apache.hadoop.hbase.filter">FilterWrapper</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr id="i12" class="altColor"> +<tr id="i13" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.html#reset--">reset</a></span>()</code> <div class="block">Reset the state of the filter between rows.</div> </td> </tr> -<tr id="i13" class="rowColor"> +<tr id="i14" class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.html#toByteArray--">toByteArray</a></span>()</code> <div class="block">TODO: JAVADOC @@ -296,7 +302,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <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> </td> </tr> -<tr id="i14" class="altColor"> +<tr id="i15" 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/FilterWrapper.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> v)</code> <div class="block">Give the filter a chance to transform the passed KeyValue.</div> @@ -461,7 +467,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.93">filterRow</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRow--">Filter</a></code></span></div> -<div class="block">Last chance to veto row based on previous <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> calls. The filter +<div class="block">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). @@ -515,7 +521,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-byte:A-int-int-">Filter</a></code></span></div> <div class="block">Filters a row based on the row key. If this returns true, the entire row will be excluded. If - 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> @@ -543,7 +549,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl 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. @@ -567,8 +573,10 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <ul class="blockList"> <li class="blockList"> <h4>filterKeyValue</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.116">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> v) - 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/FilterWrapper.html#line.117">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 @@ -581,14 +589,51 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl 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="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/FilterWrapper.html#line.121">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> @@ -604,7 +649,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <ul class="blockList"> <li class="blockList"> <h4>transformCell</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.121">transformCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> v) +<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/FilterWrapper.html#line.126">transformCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> v) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#transformCell-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div> <div class="block">Give the filter a chance to transform the passed KeyValue. If the Cell is changed a new @@ -635,7 +680,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <ul class="blockList"> <li class="blockList"> <h4>hasFilterRow</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.126">hasFilterRow</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.131">hasFilterRow</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#hasFilterRow--">Filter</a></code></span></div> <div class="block">Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time).</div> @@ -653,7 +698,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <ul class="blockList"> <li class="blockList"> <h4>filterRowCells</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.131">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>> kvs) +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.136">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>> kvs) 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#filterRowCells-java.util.List-">Filter</a></code></span></div> <div class="block">Chance to alter the list of Cells to be submitted. Modifications to the list will carry on @@ -676,7 +721,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <ul class="blockList"> <li class="blockList"> <h4>filterRowCellsWithRet</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.FilterRowRetCode.html" title="enum in org.apache.hadoop.hbase.filter">FilterWrapper.FilterRowRetCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.141">filterRowCellsWithRet</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>> kvs) +<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.FilterRowRetCode.html" title="enum in org.apache.hadoop.hbase.filter">FilterWrapper.FilterRowRetCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.146">filterRowCellsWithRet</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>> kvs) 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> <dl> <dt><span class="throwsLabel">Throws:</span></dt> @@ -690,7 +735,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <ul class="blockList"> <li class="blockList"> <h4>isFamilyEssential</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.159">isFamilyEssential</a>(byte[] name) +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.164">isFamilyEssential</a>(byte[] name) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#isFamilyEssential-byte:A-">Filter</a></code></span></div> <div class="block">Check that given column family is essential for filter to check row. Most filters always return @@ -714,7 +759,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <ul class="blockListLast"> <li class="blockList"> <h4>areSerializedFieldsEqual</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.168">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterWrapper.html#line.173">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">Filter</a></code></span></div> <div class="block">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> @@ -722,7 +767,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" titl <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">areSerializedFieldsEqual</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>other</code> - </dd> +<dd><code>o</code> - the other filter to compare with</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.</dd>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html index 35b90e5..b3dbebe 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":10,"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"]}; +var methods = {"i0":10,"i1":9,"i2":10,"i3":42,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -200,7 +200,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> @@ -217,36 +217,42 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/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="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/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="i4" class="altColor"> <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="i4" class="altColor"> +<tr id="i5" class="rowColor"> <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="i5" class="rowColor"> +<tr id="i6" class="altColor"> <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="i6" class="altColor"> +<tr id="i7" class="rowColor"> <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="i7" class="rowColor"> +<tr id="i8" class="altColor"> <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="i8" class="altColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#toByteArray--">toByteArray</a></span>()</code> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> @@ -353,7 +359,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div> <div class="block">Filters a row based on the row key. If this returns true, the entire row will be excluded. If - false, each KeyValue in the row will be passed to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> below. + false, each KeyValue in the row will be passed to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> below. If <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterAllRemaining--"><code>Filter.filterAllRemaining()</code></a> returns true, then <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-"><code>Filter.filterRowKey(Cell)</code></a> should also return true. @@ -377,7 +383,9 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>filterKeyValue</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/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 @@ -390,14 +398,48 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return <code>ReturnCode.NEXT_ROW</code> until <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--"><code>Filter.reset()</code></a> is called just in case the caller calls for the next row. - + Concrete implementers can signal a failure condition in their code by throwing an <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io"><code>IOException</code></a>.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>v</code> - the Cell in question</dd> +<dd><code>c</code> - the Cell in question</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>code as described below, Filter.ReturnCode.INCLUDE by default</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter"><code>Filter.ReturnCode</code></a></dd> +</dl> +</li> +</ul> +<a name="filterCell-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filterCell</h4> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/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> @@ -411,7 +453,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>createFilterFromArguments</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/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--"> @@ -420,7 +462,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <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> @@ -433,7 +475,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <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> @@ -446,7 +488,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/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><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toByteArray--">FilterBase</a></code></span></div> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> <dl> @@ -463,7 +505,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/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 <a href="../../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -483,14 +525,14 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockListLast"> <li class="blockList"> <h4>areSerializedFieldsEqual</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#line.114">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#line.120">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">FilterBase</a></code></span></div> <div class="block">Default implementation so that writers of custom filters aren't forced to implement.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">areSerializedFieldsEqual</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>other</code> - </dd> +<dd><code>o</code> - the other filter to compare with</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.</dd> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html index bcb237f..a34e59f 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":42,"i1":42,"i2":42,"i3":41,"i4":42}; +var methods = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":41,"i5":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"; @@ -230,24 +230,30 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte </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> 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="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/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="i3" class="rowColor"> <td class="colFirst"><code>private boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#hasOneMatchingQualifier-org.apache.hadoop.hbase.Cell-">hasOneMatchingQualifier</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#hasOneMatchingQualifier-org.apache.hadoop.hbase.Cell-">hasOneMatchingQualifier</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"> +<tr id="i4" 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="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/FirstKeyValueMatchingQualifiersFilter.html#toByteArray--">toByteArray</a></span>()</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> @@ -345,7 +351,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 @@ -359,14 +366,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> @@ -380,7 +422,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte <ul class="blockList"> <li class="blockList"> <h4>hasOneMatchingQualifier</h4> -<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#line.73">hasOneMatchingQualifier</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> v)</pre> +<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#line.79">hasOneMatchingQualifier</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> </li> </ul> @@ -390,7 +432,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><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toByteArray--">FilterBase</a></code></span></div> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> @@ -408,7 +450,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte <ul class="blockList"> <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 <a href="../../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <dl> @@ -429,7 +471,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte <ul class="blockListLast"> <li class="blockList"> <h4>areSerializedFieldsEqual</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#line.121">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.html#line.127">areSerializedFieldsEqual</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">FilterBase</a></code></span></div> <div class="block">Default implementation so that writers of custom filters aren't forced to implement.</div> @@ -437,7 +479,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilte <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FirstKeyOnlyFilter.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">areSerializedFieldsEqual</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>other</code> - </dd> +<dd><code>o</code> - the other filter to compare with</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.</dd> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html b/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html index 56c2c9d..5039380 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html @@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>private static enum <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.453">FuzzyRowFilter.Order</a> +<pre>private static enum <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.459">FuzzyRowFilter.Order</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a>></pre> <div class="block">Abstracts directional comparisons based on scan direction.</div> </li> @@ -247,7 +247,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>ASC</h4> -<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.454">ASC</a></pre> +<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.460">ASC</a></pre> </li> </ul> <a name="DESC"> @@ -256,7 +256,7 @@ the order they are declared.</div> <ul class="blockListLast"> <li class="blockList"> <h4>DESC</h4> -<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.476">DESC</a></pre> +<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.482">DESC</a></pre> </li> </ul> </li> @@ -273,7 +273,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>values</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.453">values</a>()</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.459">values</a>()</pre> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: @@ -293,7 +293,7 @@ for (FuzzyRowFilter.Order c : FuzzyRowFilter.Order.values()) <ul class="blockList"> <li class="blockList"> <h4>valueOf</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.453">valueOf</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> name)</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.459">valueOf</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> name)</pre> <div class="block">Returns the enum constant of this type with the specified name. The string must match <i>exactly</i> an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are @@ -315,7 +315,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>orderFor</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.499">orderFor</a>(boolean reverse)</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.Order</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.505">orderFor</a>(boolean reverse)</pre> </li> </ul> <a name="lt-int-int-"> @@ -324,7 +324,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>lt</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.504">lt</a>(int lhs, +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.510">lt</a>(int lhs, int rhs)</pre> <div class="block">Returns true when <code>lhs < rhs</code>.</div> </li> @@ -335,7 +335,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>gt</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.507">gt</a>(int lhs, +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.513">gt</a>(int lhs, int rhs)</pre> <div class="block">Returns true when <code>lhs > rhs</code>.</div> </li> @@ -346,7 +346,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>inc</h4> -<pre>public abstract byte <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.510">inc</a>(byte val)</pre> +<pre>public abstract byte <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.516">inc</a>(byte val)</pre> <div class="block">Returns <code>val</code> incremented by 1.</div> </li> </ul> @@ -356,7 +356,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>isMax</h4> -<pre>public abstract boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.513">isMax</a>(byte val)</pre> +<pre>public abstract boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.519">isMax</a>(byte val)</pre> <div class="block">Return true when <code>val</code> is the maximum value</div> </li> </ul> @@ -366,7 +366,7 @@ not permitted.)</div> <ul class="blockListLast"> <li class="blockList"> <h4>min</h4> -<pre>public abstract byte <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.516">min</a>()</pre> +<pre>public abstract byte <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.Order.html#line.522">min</a>()</pre> <div class="block">Return the minimum value according to this ordering scheme.</div> </li> </ul> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html b/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html index 5e5063a..59a1426 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html @@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>private class <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.195">FuzzyRowFilter.RowTracker</a> +<pre>private class <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.201">FuzzyRowFilter.RowTracker</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></pre> <div class="block">If we have multiple fuzzy keys, row tracker should improve overall performance. It calculates all next rows (one per every fuzzy key) and put them (the fuzzy key is bundled) into a priority @@ -225,7 +225,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>nextRows</h4> -<pre>private final <a href="http://docs.oracle.com/javase/8/docs/api/java/util/PriorityQueue.html?is-external=true"; title="class or interface in java.util">PriorityQueue</a><<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><byte[],<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><byte[],byte[]>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.196">nextRows</a></pre> +<pre>private final <a href="http://docs.oracle.com/javase/8/docs/api/java/util/PriorityQueue.html?is-external=true"; title="class or interface in java.util">PriorityQueue</a><<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><byte[],<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><byte[],byte[]>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.202">nextRows</a></pre> </li> </ul> <a name="initialized"> @@ -234,7 +234,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>initialized</h4> -<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.197">initialized</a></pre> +<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.203">initialized</a></pre> </li> </ul> </li> @@ -251,7 +251,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>RowTracker</h4> -<pre><a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.199">RowTracker</a>()</pre> +<pre><a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.205">RowTracker</a>()</pre> </li> </ul> </li> @@ -268,7 +268,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>nextRow</h4> -<pre>byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.211">nextRow</a>()</pre> +<pre>byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.217">nextRow</a>()</pre> </li> </ul> <a name="updateTracker-org.apache.hadoop.hbase.Cell-"> @@ -277,7 +277,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>updateTracker</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.220">updateTracker</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)</pre> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.226">updateTracker</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell)</pre> </li> </ul> <a name="lessThan-org.apache.hadoop.hbase.Cell-byte:A-"> @@ -286,7 +286,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>lessThan</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.236">lessThan</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell, +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.242">lessThan</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell, byte[] nextRowKey)</pre> </li> </ul> @@ -296,7 +296,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>updateWith</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.242">updateWith</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell, +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.RowTracker.html#line.248">updateWith</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell, <a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><byte[],byte[]> fuzzyData)</pre> </li> </ul> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html b/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html index f51d599..386e3c97 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html @@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>static enum <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.311">FuzzyRowFilter.SatisfiesCode</a> +<pre>static enum <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.html#line.317">FuzzyRowFilter.SatisfiesCode</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a>></pre> </li> </ul> @@ -219,7 +219,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>YES</h4> -<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.313">YES</a></pre> +<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.319">YES</a></pre> <div class="block">row satisfies fuzzy rule</div> </li> </ul> @@ -229,7 +229,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>NEXT_EXISTS</h4> -<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.315">NEXT_EXISTS</a></pre> +<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.321">NEXT_EXISTS</a></pre> <div class="block">row doesn't satisfy fuzzy rule, but there's possible greater row that does</div> </li> </ul> @@ -239,7 +239,7 @@ the order they are declared.</div> <ul class="blockListLast"> <li class="blockList"> <h4>NO_NEXT</h4> -<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.317">NO_NEXT</a></pre> +<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.323">NO_NEXT</a></pre> <div class="block">row doesn't satisfy fuzzy rule and there's no greater row that does</div> </li> </ul> @@ -257,7 +257,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>values</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.311">values</a>()</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.317">values</a>()</pre> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: @@ -277,7 +277,7 @@ for (FuzzyRowFilter.SatisfiesCode c : FuzzyRowFilter.SatisfiesCode.values()) <ul class="blockListLast"> <li class="blockList"> <h4>valueOf</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.311">valueOf</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> name)</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html" title="enum in org.apache.hadoop.hbase.filter">FuzzyRowFilter.SatisfiesCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FuzzyRowFilter.SatisfiesCode.html#line.317">valueOf</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> name)</pre> <div class="block">Returns the enum constant of this type with the specified name. The string must match <i>exactly</i> an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are
