http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ec8bf761/devapidocs/org/apache/hadoop/hbase/client/MasterCallable.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/MasterCallable.html b/devapidocs/org/apache/hadoop/hbase/client/MasterCallable.html index bb9f461..3c505c9 100644 --- a/devapidocs/org/apache/hadoop/hbase/client/MasterCallable.html +++ b/devapidocs/org/apache/hadoop/hbase/client/MasterCallable.html @@ -118,7 +118,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Private -abstract class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.46">MasterCallable</a><V> +abstract class <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.45">MasterCallable</a><V> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallable.html" title="interface in org.apache.hadoop.hbase.client">RetryingCallable</a><V>, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></pre> <div class="block">A RetryingCallable for Master RPC operations. @@ -282,7 +282,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>connection</h4> -<pre>protected final <a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.47">connection</a></pre> +<pre>protected final <a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.46">connection</a></pre> </li> </ul> <a name="master"> @@ -291,7 +291,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>master</h4> -<pre>protected <a href="../../../../../org/apache/hadoop/hbase/client/MasterKeepAliveConnection.html" title="interface in org.apache.hadoop.hbase.client">MasterKeepAliveConnection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.48">master</a></pre> +<pre>protected <a href="../../../../../org/apache/hadoop/hbase/client/MasterKeepAliveConnection.html" title="interface in org.apache.hadoop.hbase.client">MasterKeepAliveConnection</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.47">master</a></pre> </li> </ul> <a name="rpcController"> @@ -300,7 +300,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockListLast"> <li class="blockList"> <h4>rpcController</h4> -<pre>private final <a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.49">rpcController</a></pre> +<pre>private final <a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.48">rpcController</a></pre> </li> </ul> </li> @@ -317,7 +317,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockListLast"> <li class="blockList"> <h4>MasterCallable</h4> -<pre><a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.51">MasterCallable</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> connection, +<pre><a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.50">MasterCallable</a>(<a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> connection, <a href="../../../../../org/apache/hadoop/hbase/ipc/RpcControllerFactory.html" title="class in org.apache.hadoop.hbase.ipc">RpcControllerFactory</a> rpcConnectionFactory)</pre> </li> </ul> @@ -335,7 +335,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>prepare</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.57">prepare</a>(boolean reload) +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.56">prepare</a>(boolean reload) 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 interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallable.html#prepare-boolean-">RetryingCallable</a></code></span></div> <div class="block">Prepare by setting up any connections to servers, etc., ahead of call invocation. @@ -356,7 +356,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>close</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.62">close</a>() +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.61">close</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> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -374,7 +374,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>throwable</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.71">throwable</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> t, +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.70">throwable</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> t, boolean retrying)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallable.html#throwable-java.lang.Throwable-boolean-">RetryingCallable</a></code></span></div> <div class="block">Called when call throws an exception and we are going to retry; take action to @@ -396,7 +396,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>getExceptionMessageAdditionalDetail</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/client/MasterCallable.html#line.75">getExceptionMessageAdditionalDetail</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/client/MasterCallable.html#line.74">getExceptionMessageAdditionalDetail</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallable.html#getExceptionMessageAdditionalDetail--">getExceptionMessageAdditionalDetail</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallable.html" title="interface in org.apache.hadoop.hbase.client">RetryingCallable</a><<a href="../../../../../org/apache/hadoop/hbase/client/MasterCallable.html" title="type parameter in MasterCallable">V</a>></code></dd> @@ -413,7 +413,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>sleep</h4> -<pre>public long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.80">sleep</a>(long pause, +<pre>public long <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.79">sleep</a>(long pause, int tries)</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -432,7 +432,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>call</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/MasterCallable.html" title="type parameter in MasterCallable">V</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.94">call</a>(int callTimeout) +<pre>public <a href="../../../../../org/apache/hadoop/hbase/client/MasterCallable.html" title="type parameter in MasterCallable">V</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.93">call</a>(int callTimeout) 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">Override that changes the <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Callable.html?is-external=true#call--"; title="class or interface in java.util.concurrent"><code>Callable.call()</code></a> Exception from <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang"><code>Exception</code></a> to <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>. It also does setup of an rpcController and calls through to the rpcCall() @@ -456,7 +456,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>rpcCall</h4> -<pre>protected abstract <a href="../../../../../org/apache/hadoop/hbase/client/MasterCallable.html" title="type parameter in MasterCallable">V</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.114">rpcCall</a>() +<pre>protected abstract <a href="../../../../../org/apache/hadoop/hbase/client/MasterCallable.html" title="type parameter in MasterCallable">V</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.113">rpcCall</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Run the RPC call. Implement this method. To get at the rpcController that has been created and configured to make this rpc call, use getRpcController(). We are trying to contain @@ -475,7 +475,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>getRpcController</h4> -<pre><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.116">getRpcController</a>()</pre> +<pre><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.115">getRpcController</a>()</pre> </li> </ul> <a name="setPriority-int-"> @@ -484,7 +484,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>setPriority</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.120">setPriority</a>(int priority)</pre> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.119">setPriority</a>(int priority)</pre> </li> </ul> <a name="setPriority-org.apache.hadoop.hbase.TableName-"> @@ -493,7 +493,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>setPriority</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.126">setPriority</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</pre> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.125">setPriority</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</pre> </li> </ul> <a name="setPriority-byte:A-"> @@ -502,7 +502,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockList"> <li class="blockList"> <h4>setPriority</h4> -<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.135">setPriority</a>(byte[] regionName)</pre> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.134">setPriority</a>(byte[] regionName)</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>regionName</code> - RegionName. If hbase:meta, we'll set high priority.</dd> @@ -515,7 +515,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/client/RetryingCallab <ul class="blockListLast"> <li class="blockList"> <h4>isMetaRegion</h4> -<pre>private static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.141">isMetaRegion</a>(byte[] regionName)</pre> +<pre>private static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/MasterCallable.html#line.140">isMetaRegion</a>(byte[] regionName)</pre> </li> </ul> </li>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ec8bf761/devapidocs/org/apache/hadoop/hbase/client/class-use/MasterKeepAliveConnection.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/class-use/MasterKeepAliveConnection.html b/devapidocs/org/apache/hadoop/hbase/client/class-use/MasterKeepAliveConnection.html index 3107660..19b7907 100644 --- a/devapidocs/org/apache/hadoop/hbase/client/class-use/MasterKeepAliveConnection.html +++ b/devapidocs/org/apache/hadoop/hbase/client/class-use/MasterKeepAliveConnection.html @@ -134,20 +134,22 @@ </tr> <tbody> <tr class="altColor"> -<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/MasterKeepAliveConnection.html" title="interface in org.apache.hadoop.hbase.client">MasterKeepAliveConnection</a></code></td> +<td class="colFirst"><code>private <a href="../../../../../../org/apache/hadoop/hbase/client/MasterKeepAliveConnection.html" title="interface in org.apache.hadoop.hbase.client">MasterKeepAliveConnection</a></code></td> <td class="colLast"><span class="typeNameLabel">ConnectionImplementation.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/ConnectionImplementation.html#getKeepAliveMasterService--">getKeepAliveMasterService</a></span>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/MasterKeepAliveConnection.html" title="interface in org.apache.hadoop.hbase.client">MasterKeepAliveConnection</a></code></td> -<td class="colLast"><span class="typeNameLabel">ClusterConnection.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html#getKeepAliveMasterService--">getKeepAliveMasterService</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">Since 0.96.0</span></div> -</div> -</td> +<td class="colLast"><span class="typeNameLabel">ConnectionImplementation.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/ConnectionImplementation.html#getMaster--">getMaster</a></span>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/MasterKeepAliveConnection.html" title="interface in org.apache.hadoop.hbase.client">MasterKeepAliveConnection</a></code></td> -<td class="colLast"><span class="typeNameLabel">ConnectionUtils.ShortCircuitingClusterConnection.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/ConnectionUtils.ShortCircuitingClusterConnection.html#getKeepAliveMasterService--">getKeepAliveMasterService</a></span>()</code> </td> +<td class="colLast"><span class="typeNameLabel">ClusterConnection.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html#getMaster--">getMaster</a></span>()</code> +<div class="block">Returns a <a href="../../../../../../org/apache/hadoop/hbase/client/MasterKeepAliveConnection.html" title="interface in org.apache.hadoop.hbase.client"><code>MasterKeepAliveConnection</code></a> to the active master</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/MasterKeepAliveConnection.html" title="interface in org.apache.hadoop.hbase.client">MasterKeepAliveConnection</a></code></td> +<td class="colLast"><span class="typeNameLabel">ConnectionUtils.ShortCircuitingClusterConnection.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/client/ConnectionUtils.ShortCircuitingClusterConnection.html#getMaster--">getMaster</a></span>()</code> </td> </tr> </tbody> </table> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ec8bf761/devapidocs/org/apache/hadoop/hbase/client/package-tree.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/client/package-tree.html b/devapidocs/org/apache/hadoop/hbase/client/package-tree.html index d14bfcc..23dcc33 100644 --- a/devapidocs/org/apache/hadoop/hbase/client/package-tree.html +++ b/devapidocs/org/apache/hadoop/hbase/client/package-tree.html @@ -547,24 +547,24 @@ <ul> <li type="circle">java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang"><span class="typeNameLink">Enum</span></a><E> (implements java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><T>, java.io.<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>) <ul> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/MobCompactPartitionPolicy.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">MobCompactPartitionPolicy</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/RequestController.ReturnCode.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">RequestController.ReturnCode</span></a></li> <li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AsyncScanSingleRegionRpcRetryingCaller.ScanControllerState.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">AsyncScanSingleRegionRpcRetryingCaller.ScanControllerState</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/MobCompactPartitionPolicy.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">MobCompactPartitionPolicy</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">Durability</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/CompactType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">CompactType</span></a></li> <li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AsyncScanSingleRegionRpcRetryingCaller.ScanResumerState.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">AsyncScanSingleRegionRpcRetryingCaller.ScanResumerState</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/MasterSwitchType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">MasterSwitchType</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AsyncRequestFutureImpl.Retry.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">AsyncRequestFutureImpl.Retry</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/RegionLocateType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">RegionLocateType</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/CompactionState.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">CompactionState</span></a></li> <li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AbstractResponse.ResponseType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">AbstractResponse.ResponseType</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AsyncRequestFutureImpl.Retry.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">AsyncRequestFutureImpl.Retry</span></a></li> <li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/SnapshotType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">SnapshotType</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AsyncProcessTask.SubmittedRows.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">AsyncProcessTask.SubmittedRows</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/RequestController.ReturnCode.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">RequestController.ReturnCode</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">Scan.ReadType</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/Durability.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">Durability</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/Consistency.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">Consistency</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/MasterSwitchType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">MasterSwitchType</span></a></li> <li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/ScannerCallable.MoreResults.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">ScannerCallable.MoreResults</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/CompactType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">CompactType</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/Scan.ReadType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">Scan.ReadType</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/AsyncProcessTask.SubmittedRows.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">AsyncProcessTask.SubmittedRows</span></a></li> <li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/TableState.State.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">TableState.State</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/CompactionState.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">CompactionState</span></a></li> <li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/IsolationLevel.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">IsolationLevel</span></a></li> -<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/Consistency.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">Consistency</span></a></li> +<li type="circle">org.apache.hadoop.hbase.client.<a href="../../../../../org/apache/hadoop/hbase/client/RegionLocateType.html" title="enum in org.apache.hadoop.hbase.client"><span class="typeNameLink">RegionLocateType</span></a></li> </ul> </li> </ul> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ec8bf761/devapidocs/org/apache/hadoop/hbase/exceptions/class-use/DeserializationException.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/exceptions/class-use/DeserializationException.html b/devapidocs/org/apache/hadoop/hbase/exceptions/class-use/DeserializationException.html index a07a830..781ff42 100644 --- a/devapidocs/org/apache/hadoop/hbase/exceptions/class-use/DeserializationException.html +++ b/devapidocs/org/apache/hadoop/hbase/exceptions/class-use/DeserializationException.html @@ -442,10 +442,16 @@ <td class="colLast"><span class="typeNameLabel">SingleColumnValueFilter.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> <tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnValueFilter</a></code></td> +<td class="colLast"><span class="typeNameLabel">ColumnValueFilter.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> +<div class="block">Parse protobuf bytes to a ColumnValueFilter</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../../org/apache/hadoop/hbase/filter/QualifierFilter.html" title="class in org.apache.hadoop.hbase.filter">QualifierFilter</a></code></td> <td class="colLast"><span class="typeNameLabel">QualifierFilter.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/filter/QualifierFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> -<tr class="rowColor"> +<tr 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"><span class="typeNameLabel">FilterWrapper.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/filter/FilterWrapper.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> </td> </tr> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ec8bf761/devapidocs/org/apache/hadoop/hbase/executor/package-tree.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/executor/package-tree.html b/devapidocs/org/apache/hadoop/hbase/executor/package-tree.html index 49ed276..4b68db2 100644 --- a/devapidocs/org/apache/hadoop/hbase/executor/package-tree.html +++ b/devapidocs/org/apache/hadoop/hbase/executor/package-tree.html @@ -104,8 +104,8 @@ <ul> <li type="circle">java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang"><span class="typeNameLink">Enum</span></a><E> (implements java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><T>, java.io.<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>) <ul> -<li type="circle">org.apache.hadoop.hbase.executor.<a href="../../../../../org/apache/hadoop/hbase/executor/ExecutorType.html" title="enum in org.apache.hadoop.hbase.executor"><span class="typeNameLink">ExecutorType</span></a></li> <li type="circle">org.apache.hadoop.hbase.executor.<a href="../../../../../org/apache/hadoop/hbase/executor/EventType.html" title="enum in org.apache.hadoop.hbase.executor"><span class="typeNameLink">EventType</span></a></li> +<li type="circle">org.apache.hadoop.hbase.executor.<a href="../../../../../org/apache/hadoop/hbase/executor/ExecutorType.html" title="enum in org.apache.hadoop.hbase.executor"><span class="typeNameLink">ExecutorType</span></a></li> </ul> </li> </ul> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ec8bf761/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 4322e36..2edcbb7 100644 --- a/devapidocs/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html +++ b/devapidocs/org/apache/hadoop/hbase/filter/ColumnRangeFilter.html @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/hadoop/hbase/filter/ColumnRangeFilter.html" target="_top">Frames</a></li> @@ -724,7 +724,7 @@ public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.Return <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnPrefixFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/hadoop/hbase/filter/ColumnRangeFilter.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/ec8bf761/devapidocs/org/apache/hadoop/hbase/filter/ColumnValueFilter.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/filter/ColumnValueFilter.html b/devapidocs/org/apache/hadoop/hbase/filter/ColumnValueFilter.html new file mode 100644 index 0000000..97f1685 --- /dev/null +++ b/devapidocs/org/apache/hadoop/hbase/filter/ColumnValueFilter.html @@ -0,0 +1,796 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ColumnValueFilter (Apache HBase 3.0.0-SNAPSHOT API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ColumnValueFilter (Apache HBase 3.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"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 altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ColumnValueFilter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/filter/ColumnValueFilter.html" target="_top">Frames</a></li> +<li><a href="ColumnValueFilter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.classes.inherited.from.class.org.apache.hadoop.hbase.filter.Filter">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hadoop.hbase.filter</div> +<h2 title="Class ColumnValueFilter" class="title">Class ColumnValueFilter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">org.apache.hadoop.hbase.filter.Filter</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">org.apache.hadoop.hbase.filter.FilterBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.filter.ColumnValueFilter</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@InterfaceAudience.Public +public class <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.50">ColumnValueFilter</a> +extends <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></pre> +<div class="block">Different from <a href="../../../../../org/apache/hadoop/hbase/filter/SingleColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter"><code>SingleColumnValueFilter</code></a> which returns an <b>entire</b> row + when specified condition is matched, <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter"><code>ColumnValueFilter</code></a> return the matched cell only. + <p> + This filter is used to filter cells based on column and value. + It takes a <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase"><code>CompareOperator</code></a> operator (<, <=, =, !=, >, >=), and + and a <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter"><code>ByteArrayComparable</code></a> comparator.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.hbase.filter.Filter"> +<!-- --> +</a> +<h3>Nested classes/interfaces 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.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#columnFound">columnFound</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#comparator">comparator</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#family">family</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#op">op</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#qualifier">qualifier</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.filter.Filter"> +<!-- --> +</a> +<h3>Fields 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#reversed">reversed</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#ColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-byte:A-">ColumnValueFilter</a></span>(byte[] family, + byte[] qualifier, + <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, + byte[] value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#ColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-">ColumnValueFilter</a></span>(byte[] family, + byte[] qualifier, + <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, + <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> comparator)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</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> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>(package private) boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-">areSerializedFieldsEqual</a></span>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> o)</code> +<div class="block">Default implementation so that writers of custom filters aren't forced to implement.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>private boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#compareValue-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-org.apache.hadoop.hbase.Cell-">compareValue</a></span>(<a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, + <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> comparator, + <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> +<div class="block">This method is used to determine a cell should be included or filtered out.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos.ColumnValueFilter</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#convert--">convert</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#createFilterFromArguments-java.util.ArrayList-">createFilterFromArguments</a></span>(<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)</code> +<div class="block">Creating this filter by reflection, it is used by <a href="../../../../../org/apache/hadoop/hbase/filter/ParseFilter.html" title="class in org.apache.hadoop.hbase.filter"><code>ParseFilter</code></a>,</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#filterRowKey-org.apache.hadoop.hbase.Cell-">filterRowKey</a></span>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> +<div class="block">Filters a row based on the row key.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#getComparator--">getComparator</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#getCompareOperator--">getCompareOperator</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#getFamily--">getFamily</a></span>()</code> </td> +</tr> +<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/ColumnValueFilter.html#getQualifier--">getQualifier</a></span>()</code> </td> +</tr> +<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/ColumnValueFilter.html#isFamilyEssential-byte:A-">isFamilyEssential</a></span>(byte[] name)</code> +<div class="block">By default, we require all scan's column families to be present.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnValueFilter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html#parseFrom-byte:A-">parseFrom</a></span>(byte[] pbBytes)</code> +<div class="block">Parse protobuf bytes to a ColumnValueFilter</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.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="i13" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.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="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/ColumnValueFilter.html#toString--">toString</a></span>()</code> +<div class="block">Return filter's info for debugging and logging purpose.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.filter.FilterBase"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.hadoop.hbase.filter.<a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html" title="class in org.apache.hadoop.hbase.filter">FilterBase</a></h3> +<code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterAllRemaining--">filterAllRemaining</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRow--">filterRow</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRowCells-java.util.List-">filterRowCells</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#filterRowKey-byte:A-int-int-">filterRowKey</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#getNextCellHint-org.apache.hadoop.hbase.Cell-">getNextCellHint</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#hasFilterRow--">hasFilterRow</a>, <a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#transformCell-org.apache.hadoop.hbase.Cell-">transformCell</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.filter.Filter"> +<!-- --> +</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#setReversed-boolean-">setReversed</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<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></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="family"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>family</h4> +<pre>private final byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.51">family</a></pre> +</li> +</ul> +<a name="qualifier"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>qualifier</h4> +<pre>private final byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.52">qualifier</a></pre> +</li> +</ul> +<a name="op"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>op</h4> +<pre>private final <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.53">op</a></pre> +</li> +</ul> +<a name="comparator"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>comparator</h4> +<pre>private final <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.54">comparator</a></pre> +</li> +</ul> +<a name="columnFound"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>columnFound</h4> +<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.58">columnFound</a></pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ColumnValueFilter</h4> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.60">ColumnValueFilter</a>(byte[] family, + byte[] qualifier, + <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, + byte[] value)</pre> +</li> +</ul> +<a name="ColumnValueFilter-byte:A-byte:A-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ColumnValueFilter</h4> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.65">ColumnValueFilter</a>(byte[] family, + byte[] qualifier, + <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, + <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> comparator)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getCompareOperator--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCompareOperator</h4> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.77">getCompareOperator</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>operator</dd> +</dl> +</li> +</ul> +<a name="getComparator--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getComparator</h4> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.84">getComparator</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the comparator</dd> +</dl> +</li> +</ul> +<a name="getFamily--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFamily</h4> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.91">getFamily</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the column family</dd> +</dl> +</li> +</ul> +<a name="getQualifier--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQualifier</h4> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.98">getQualifier</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the qualifier</dd> +</dl> +</li> +</ul> +<a name="reset--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.103">reset</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/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. + + Reset the state of the filter between rows. + + 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/FilterBase.html#reset--">reset</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="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> +</dl> +</li> +</ul> +<a name="filterRowKey-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>filterRowKey</h4> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.108">filterRowKey</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell) + 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#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. + + 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/FilterBase.html#filterRowKey-org.apache.hadoop.hbase.Cell-">filterRowKey</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>cell</code> - The first cell coming in the new row</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true, remove entire row, false, include the row (maybe).</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> +</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/ColumnValueFilter.html#line.113">filterCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div> +<div class="block">A way to filter based on the column family, column qualifier and/or the column value. Return + code is described below. This allows filters to filter only certain number of columns, then + terminate without matching ever column. + + If filterRowKey returns true, filterCell needs to be consistent with it. + + filterCell can assume that filterRowKey has already been called for the row. + + If your filter returns <code>ReturnCode.NEXT_ROW</code>, it should return + <code>ReturnCode.NEXT_ROW</code> until <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#reset--"><code>Filter.reset()</code></a> is called just in case the caller calls + for the next row. + + Concrete implementers can signal a failure condition in their code by throwing an + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io"><code>IOException</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterCell-org.apache.hadoop.hbase.Cell-">filterCell</a></code> in class <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>c</code> - the Cell in question</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>code as described below</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - in case an I/O or an filter specific failure needs to be signaled.</dd> +<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="compareValue-org.apache.hadoop.hbase.CompareOperator-org.apache.hadoop.hbase.filter.ByteArrayComparable-org.apache.hadoop.hbase.Cell-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareValue</h4> +<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.133">compareValue</a>(<a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase">CompareOperator</a> op, + <a href="../../../../../org/apache/hadoop/hbase/filter/ByteArrayComparable.html" title="class in org.apache.hadoop.hbase.filter">ByteArrayComparable</a> comparator, + <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> +<div class="block">This method is used to determine a cell should be included or filtered out.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>op</code> - one of operators <a href="../../../../../org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase"><code>CompareOperator</code></a></dd> +<dd><code>comparator</code> - comparator used to compare cells.</dd> +<dd><code>cell</code> - cell to be compared.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true means cell should be filtered out, included otherwise.</dd> +</dl> +</li> +</ul> +<a name="createFilterFromArguments-java.util.ArrayList-"> +<!-- --> +</a> +<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/ColumnValueFilter.html#line.147">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> +<div class="block">Creating this filter by reflection, it is used by <a href="../../../../../org/apache/hadoop/hbase/filter/ParseFilter.html" title="class in org.apache.hadoop.hbase.filter"><code>ParseFilter</code></a>,</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filterArguments</code> - arguments for creating a ColumnValueFilter</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a ColumnValueFilter</dd> +</dl> +</li> +</ul> +<a name="convert--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convert</h4> +<pre>org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos.ColumnValueFilter <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.171">convert</a>()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A pb instance to represent this instance.</dd> +</dl> +</li> +</ul> +<a name="parseFrom-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parseFrom</h4> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/ColumnValueFilter.html" title="class in org.apache.hadoop.hbase.filter">ColumnValueFilter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.189">parseFrom</a>(byte[] pbBytes) + throws <a href="../../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></pre> +<div class="block">Parse protobuf bytes to a ColumnValueFilter</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>pbBytes</code> - pbBytes</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a ColumnValueFilter</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code> - deserialization exception</dd> +</dl> +</li> +</ul> +<a name="toByteArray--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toByteArray</h4> +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.210">toByteArray</a>() + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toByteArray--">toByteArray</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="returnLabel">Returns:</span></dt> +<dd>The filter serialized using pb</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> +</dl> +</li> +</ul> +<a name="areSerializedFieldsEqual-org.apache.hadoop.hbase.filter.Filter-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>areSerializedFieldsEqual</h4> +<pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.215">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="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> +</dl> +</li> +</ul> +<a name="isFamilyEssential-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isFamilyEssential</h4> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/ColumnValueFilter.html#line.230">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/FilterBase.html#isFamilyEssential-byte:A-">FilterBase</a></code></span></div> +<div class="block">By default, we require all scan's column families to be present. Our + subclasses may be more precise. + + Check that given column family is essential for filter to check row. Most filters always return + true here. But some could have more sophisticated logic which could significantly reduce + scanning process by not even touching columns until we are 100% sure that it's data is needed + in result. + + 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/FilterBase.html#isFamilyEssential-byte:A-">isFamilyEssential</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="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> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<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/ColumnValueFilter.html#line.235">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> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/filter/FilterBase.html#toString--">toString</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> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ColumnValueFilter.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hadoop/hbase/filter/ColumnRangeFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/filter/CompareFilter.html" title="class in org.apache.hadoop.hbase.filter"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/filter/ColumnValueFilter.html" target="_top">Frames</a></li> +<li><a href="ColumnValueFilter.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.classes.inherited.from.class.org.apache.hadoop.hbase.filter.Filter">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
