org.apache.hadoop.hbase.filter
Class ValueFilter

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

public class ValueFilter
extends CompareFilter

This filter is used to filter based on column value. It takes an operator (equal, greater, not equal, etc) and a byte [] comparator for the cell value.

This filter can be wrapped with WhileMatchFilter and SkipFilter to add more control.

Multiple filters can be combined using FilterList.

To test the value of a single qualifier when scanning multiple qualifiers, use SingleColumnValueFilter.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.CompareFilter
CompareFilter.CompareOp
 
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.CompareFilter
comparator, compareOp
 
Constructor Summary
ValueFilter()
          Writable constructor, do not use.
ValueFilter(CompareFilter.CompareOp valueCompareOp, WritableByteArrayComparable valueComparator)
          Constructor.
 
Method Summary
 Filter.ReturnCode filterKeyValue(KeyValue v)
          Filters that dont filter by key value can inherit this implementation that includes all KeyValues.
 
Methods inherited from class org.apache.hadoop.hbase.filter.CompareFilter
doCompare, getComparator, getOperator, readFields, write
 
Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase
filterAllRemaining, filterRow, filterRow, filterRowKey, getNextKeyHint, hasFilterRow, reset
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValueFilter

public ValueFilter()
Writable constructor, do not use.


ValueFilter

public ValueFilter(CompareFilter.CompareOp valueCompareOp,
                   WritableByteArrayComparable valueComparator)
Constructor.

Parameters:
valueCompareOp - the compare op for value matching
valueComparator - the comparator for value matching
Method Detail

filterKeyValue

public Filter.ReturnCode filterKeyValue(KeyValue v)
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 FilterBase
Parameters:
v - the KeyValue in question
Returns:
code as described below
See Also:
Filter.ReturnCode


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