http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html index fc48b1f..8a070e5 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":9,"i12":10,"i13":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":10,"i1":9,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":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"; @@ -221,7 +221,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> @@ -238,58 +238,64 @@ 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/ColumnRangeFilter.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> kv)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.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/ColumnRangeFilter.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/ColumnRangeFilter.html#filterRowKey-org.apache.hadoop.hbase.Cell-">filterRowKey</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> <div class="block">Filters a row based on the row key.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#getMaxColumn--">getMaxColumn</a></span>()</code> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i6" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#getMaxColumnInclusive--">getMaxColumnInclusive</a></span>()</code> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#getMinColumn--">getMinColumn</a></span>()</code> </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/ColumnRangeFilter.html#getMinColumnInclusive--">getMinColumnInclusive</a></span>()</code> </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/ColumnRangeFilter.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">getNextCellHint</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> <div class="block">Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell.</div> </td> </tr> -<tr id="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/ColumnRangeFilter.html#isMaxColumnInclusive--">isMaxColumnInclusive</a></span>()</code> </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/ColumnRangeFilter.html#isMinColumnInclusive--">isMinColumnInclusive</a></span>()</code> </td> </tr> -<tr id="i11" class="rowColor"> +<tr id="i12" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnRangeFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.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>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.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="i13" class="rowColor"> +<tr id="i14" 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/ColumnRangeFilter.html#toString--">toString</a></span>()</code> <div class="block">Return filter's info for debugging and logging purpose.</div> @@ -494,7 +500,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. @@ -518,7 +524,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/ColumnRangeFilter.html#line.124">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> kv)</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/ColumnRangeFilter.html#line.125">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 @@ -531,14 +539,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>kv</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/ColumnRangeFilter.html#line.130">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> @@ -552,7 +594,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/ColumnRangeFilter.html#line.153">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#line.159">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> </li> </ul> <a name="toByteArray--"> @@ -561,7 +603,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/ColumnRangeFilter.html#line.172">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#line.178">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> @@ -578,7 +620,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/ColumnRangeFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnRangeFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#line.190">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnRangeFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#line.196">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> @@ -598,7 +640,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>areSerializedFieldsEqual</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#line.208">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/ColumnRangeFilter.html#line.214">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> @@ -618,7 +660,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockList"> <li class="blockList"> <h4>getNextCellHint</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#line.220">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#line.226">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">FilterBase</a></code></span></div> <div class="block">Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell. @@ -644,7 +686,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html#line.225">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/ColumnRangeFilter.html#line.231">toString</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toString--">FilterBase</a></code></span></div> <div class="block">Return filter's info for debugging and logging purpose.</div> <dl>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html b/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html index 96d4dd4..55bd437 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html @@ -341,7 +341,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/CompareFilter.CompareOp.html" title="enum in org.apache.hadoop.hbase.filter">CompareFilter.CompareOp</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html#line.203">values</a>()</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html" title="enum in org.apache.hadoop.hbase.filter">CompareFilter.CompareOp</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html#line.240">values</a>()</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <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 @@ -362,7 +362,7 @@ for (CompareFilter.CompareOp c : CompareFilter.CompareOp.values()) <ul class="blockListLast"> <li class="blockList"> <h4>valueOf</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html" title="enum in org.apache.hadoop.hbase.filter">CompareFilter.CompareOp</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html#line.203">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/CompareFilter.CompareOp.html" title="enum in org.apache.hadoop.hbase.filter">CompareFilter.CompareOp</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html#line.240">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"><span class="deprecatedLabel">Deprecated.</span> </div> <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 http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.html index 9d4e722..f83da9e 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/CompareFilter.html @@ -378,7 +378,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" <!-- --> </a> <h3>Methods inherited from class org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></h3> -<code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#isReversed--">isReversed</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#parseFrom-byte:A-">parseFrom</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#setReversed-boolean-">setReversed</a></code></li> +<code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#isReversed--">isReversed</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#parseFrom-byte:A-">parseFrom</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#setReversed-boolean-">setReversed</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> @@ -516,7 +516,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter 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. http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/DependentColumnFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/DependentColumnFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/DependentColumnFilter.html index cd96fc5..5506ab6 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/DependentColumnFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/DependentColumnFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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"]}; +var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":42,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":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"; @@ -264,7 +264,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.htm </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> @@ -292,26 +292,32 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.htm </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/DependentColumnFilter.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/DependentColumnFilter.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="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">filterKeyValue</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +<tr id="i6" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.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="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/DependentColumnFilter.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">Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.</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/DependentColumnFilter.html#filterRowKey-byte:A-int-int-">filterRowKey</a></span>(byte[] buffer, int offset, @@ -320,43 +326,43 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.htm never filters anything.</div> </td> </tr> -<tr id="i8" class="altColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.html#getDropDependentColumn--">getDropDependentColumn</a></span>()</code> </td> </tr> -<tr id="i9" class="rowColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.html#getFamily--">getFamily</a></span>()</code> </td> </tr> -<tr id="i10" class="altColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.html#getQualifier--">getQualifier</a></span>()</code> </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/DependentColumnFilter.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>static <a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.html" title="class in org.apache.hadoop.hbase.filter">DependentColumnFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr id="i13" class="rowColor"> +<tr id="i14" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.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="i14" class="altColor"> +<tr id="i15" class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.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="i15" class="rowColor"> +<tr id="i16" 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/DependentColumnFilter.html#toString--">toString</a></span>()</code> <div class="block">Return filter's info for debugging and logging purpose.</div> @@ -626,7 +632,9 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <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/DependentColumnFilter.html#line.159">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/DependentColumnFilter.html#line.160">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 @@ -639,15 +647,49 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe 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/DependentColumnFilter.html#line.165">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> @@ -660,7 +702,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <ul class="blockList"> <li class="blockList"> <h4>filterRowCells</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.178">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> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.184">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> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRowCells-java.util.List-">FilterBase</a></code></span></div> <div class="block">Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. @@ -683,7 +725,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <ul class="blockList"> <li class="blockList"> <h4>hasFilterRow</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.183">hasFilterRow</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.189">hasFilterRow</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#hasFilterRow--">FilterBase</a></code></span></div> <div class="block">Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. @@ -704,13 +746,13 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <ul class="blockList"> <li class="blockList"> <h4>filterRow</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.188">filterRow</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.194">filterRow</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRow--">FilterBase</a></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). @@ -730,7 +772,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <ul class="blockList"> <li class="blockList"> <h4>filterRowKey</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.193">filterRowKey</a>(byte[] buffer, +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.199">filterRowKey</a>(byte[] buffer, int offset, int length)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRowKey-byte:A-int-int-">FilterBase</a></code></span></div> @@ -738,7 +780,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe 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> @@ -760,7 +802,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <ul class="blockList"> <li class="blockList"> <h4>reset</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.197">reset</a>()</pre> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.203">reset</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#reset--">FilterBase</a></code></span></div> <div class="block">Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. @@ -781,7 +823,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <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/DependentColumnFilter.html#line.201">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/DependentColumnFilter.html#line.207">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> </li> </ul> <a name="toByteArray--"> @@ -790,7 +832,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.234">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.240">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> @@ -807,7 +849,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <ul class="blockList"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.html" title="class in org.apache.hadoop.hbase.filter">DependentColumnFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.254">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/DependentColumnFilter.html" title="class in org.apache.hadoop.hbase.filter">DependentColumnFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.260">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> @@ -827,7 +869,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <ul class="blockList"> <li class="blockList"> <h4>areSerializedFieldsEqual</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/DependentColumnFilter.html#line.285">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/DependentColumnFilter.html#line.291">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> @@ -847,7 +889,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Depe <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/DependentColumnFilter.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/DependentColumnFilter.html#line.303">toString</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toString--">FilterBase</a></code></span></div> <div class="block">Return filter's info for debugging and logging purpose.</div> <dl> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/FamilyFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/FamilyFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/FamilyFilter.html index 43f3db6..fb40020 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/FamilyFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/FamilyFilter.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":9,"i2":10,"i3":9,"i4":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":9,"i5":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"; @@ -225,7 +225,7 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.htm </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> @@ -242,15 +242,21 @@ extends <a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.htm </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/FamilyFilter.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/FamilyFilter.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/FamilyFilter.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>static <a href="../../../../../org/apache/hadoop/hbase/filter/FamilyFilter.html" title="class in org.apache.hadoop.hbase.filter">FamilyFilter</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/FamilyFilter.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/FamilyFilter.html#toByteArray--">toByteArray</a></span>()</code> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> @@ -348,7 +354,9 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Fami <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/FamilyFilter.html#line.76">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/FamilyFilter.html#line.77">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 @@ -361,14 +369,48 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Fami 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/FamilyFilter.html#line.82">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> @@ -382,7 +424,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Fami <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/FamilyFilter.html#line.86">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/FamilyFilter.html#line.92">createFilterFromArguments</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><byte[]> filterArguments)</pre> </li> </ul> <a name="toByteArray--"> @@ -391,7 +433,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Fami <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FamilyFilter.html#line.96">toByteArray</a>()</pre> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FamilyFilter.html#line.102">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> @@ -408,7 +450,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Fami <ul class="blockList"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FamilyFilter.html" title="class in org.apache.hadoop.hbase.filter">FamilyFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FamilyFilter.html#line.109">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FamilyFilter.html" title="class in org.apache.hadoop.hbase.filter">FamilyFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FamilyFilter.html#line.115">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> @@ -428,7 +470,7 @@ public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Fami <ul class="blockListLast"> <li class="blockList"> <h4>areSerializedFieldsEqual</h4> -<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FamilyFilter.html#line.134">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/FamilyFilter.html#line.140">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> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/00c22388/devapidocs/org/apache/hadoop/hbase/filter/Filter.ReturnCode.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/Filter.ReturnCode.html b/devapidocs/org/apache/hadoop/hbase/filter/Filter.ReturnCode.html index 7e0455f..400cac1 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/Filter.ReturnCode.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/Filter.ReturnCode.html @@ -123,7 +123,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public -public static enum <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Filter.html#line.157">Filter.ReturnCode</a> +public static enum <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/Filter.html#line.187">Filter.ReturnCode</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/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a>></pre> <div class="block">Return codes for filterValue().</div> </li> @@ -241,7 +241,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>INCLUDE</h4> -<pre>public static final <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/Filter.ReturnCode.html#line.161">INCLUDE</a></pre> +<pre>public static final <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/Filter.ReturnCode.html#line.191">INCLUDE</a></pre> <div class="block">Include the Cell</div> </li> </ul> @@ -251,7 +251,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>INCLUDE_AND_NEXT_COL</h4> -<pre>public static final <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/Filter.ReturnCode.html#line.165">INCLUDE_AND_NEXT_COL</a></pre> +<pre>public static final <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/Filter.ReturnCode.html#line.195">INCLUDE_AND_NEXT_COL</a></pre> <div class="block">Include the Cell and seek to the next column skipping older versions.</div> </li> </ul> @@ -261,7 +261,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>SKIP</h4> -<pre>public static final <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/Filter.ReturnCode.html#line.169">SKIP</a></pre> +<pre>public static final <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/Filter.ReturnCode.html#line.199">SKIP</a></pre> <div class="block">Skip this Cell</div> </li> </ul> @@ -271,7 +271,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>NEXT_COL</h4> -<pre>public static final <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/Filter.ReturnCode.html#line.173">NEXT_COL</a></pre> +<pre>public static final <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/Filter.ReturnCode.html#line.203">NEXT_COL</a></pre> <div class="block">Skip this column. Go to the next column in this row.</div> </li> </ul> @@ -281,9 +281,9 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>NEXT_ROW</h4> -<pre>public static final <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/Filter.ReturnCode.html#line.182">NEXT_ROW</a></pre> +<pre>public static final <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/Filter.ReturnCode.html#line.212">NEXT_ROW</a></pre> <div class="block">Seek to next row in current family. It may still pass a cell whose family is different but - row is the same as previous cell to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-"><code>Filter.filterKeyValue(Cell)</code></a> , even if we get a NEXT_ROW + row is the same as previous cell to <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-"><code>Filter.filterCell(Cell)</code></a> , even if we get a NEXT_ROW returned for previous cell. For more details see HBASE-18368. <br> Once reset() method was invoked, then we switch to the next row for all family, and you can catch the event by invoking CellUtils.matchingRows(previousCell, currentCell). <br> @@ -296,7 +296,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>SEEK_NEXT_USING_HINT</h4> -<pre>public static final <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/Filter.ReturnCode.html#line.186">SEEK_NEXT_USING_HINT</a></pre> +<pre>public static final <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/Filter.ReturnCode.html#line.216">SEEK_NEXT_USING_HINT</a></pre> <div class="block">Seek to next key which is given as hint by the filter.</div> </li> </ul> @@ -306,7 +306,7 @@ the order they are declared.</div> <ul class="blockListLast"> <li class="blockList"> <h4>INCLUDE_AND_SEEK_NEXT_ROW</h4> -<pre>public static final <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/Filter.ReturnCode.html#line.190">INCLUDE_AND_SEEK_NEXT_ROW</a></pre> +<pre>public static final <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/Filter.ReturnCode.html#line.220">INCLUDE_AND_SEEK_NEXT_ROW</a></pre> <div class="block">Include KeyValue and done with row, seek to next. See NEXT_ROW.</div> </li> </ul>
