org.apache.hadoop.hbase.filter
Class SingleColumnValueExcludeFilter

java.lang.Object
  extended by org.apache.hadoop.hbase.filter.FilterBase
      extended by org.apache.hadoop.hbase.filter.SingleColumnValueFilter
          extended by org.apache.hadoop.hbase.filter.SingleColumnValueExcludeFilter
All Implemented Interfaces:
Filter, org.apache.hadoop.io.Writable

public class SingleColumnValueExcludeFilter
extends SingleColumnValueFilter

A Filter that checks a single column value, but does not emit the tested column. This will enable a performance boost over SingleColumnValueFilter, if the tested column value is not actually needed as input (besides for the filtering itself).


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.filter.Filter
Filter.ReturnCode
 
Field Summary
 
Fields inherited from class org.apache.hadoop.hbase.filter.SingleColumnValueFilter
columnFamily, columnQualifier
 
Constructor Summary
SingleColumnValueExcludeFilter()
          Writable constructor, do not use.
SingleColumnValueExcludeFilter(byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value)
          Constructor for binary compare of the value of a single column.
SingleColumnValueExcludeFilter(byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, WritableByteArrayComparable comparator)
          Constructor for binary compare of the value of a single column.
 
Method Summary
 Filter.ReturnCode filterKeyValue(KeyValue keyValue)
          Filters that dont filter by key value can inherit this implementation that includes all KeyValues.
 
Methods inherited from class org.apache.hadoop.hbase.filter.SingleColumnValueFilter
filterRow, getComparator, getFamily, getFilterIfMissing, getLatestVersionOnly, getOperator, getQualifier, readFields, reset, setFilterIfMissing, setLatestVersionOnly, write
 
Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase
filterAllRemaining, filterRow, filterRowKey, getNextKeyHint, hasFilterRow
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SingleColumnValueExcludeFilter

public SingleColumnValueExcludeFilter()
Writable constructor, do not use.


SingleColumnValueExcludeFilter

public SingleColumnValueExcludeFilter(byte[] family,
                                      byte[] qualifier,
                                      CompareFilter.CompareOp compareOp,
                                      byte[] value)
Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted; except for the tested column value. If the column is not found or the condition fails, the row will not be emitted.

Parameters:
family - name of column family
qualifier - name of column qualifier
compareOp - operator
value - value to compare column values against

SingleColumnValueExcludeFilter

public SingleColumnValueExcludeFilter(byte[] family,
                                      byte[] qualifier,
                                      CompareFilter.CompareOp compareOp,
                                      WritableByteArrayComparable comparator)
Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted; except for the tested column value. If the condition fails, the row will not be emitted.

Use the filterIfColumnMissing flag to set whether the rest of the columns in a row will be emitted if the specified column to check is not found in the row.

Parameters:
family - name of column family
qualifier - name of column qualifier
compareOp - operator
comparator - Comparator to use.
Method Detail

filterKeyValue

public Filter.ReturnCode filterKeyValue(KeyValue keyValue)
Description copied from class: FilterBase
Filters that dont filter by key value can inherit this implementation that includes all KeyValues.

Specified by:
filterKeyValue in interface Filter
Overrides:
filterKeyValue in class SingleColumnValueFilter
Parameters:
keyValue - the KeyValue in question
Returns:
code as described below
See Also:
Filter.ReturnCode


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.