org.apache.hadoop.hbase.filter
Class QualifierFilter

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

public class QualifierFilter
extends CompareFilter

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

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

Multiple filters can be combined using FilterList.

If an already known column qualifier is looked for, use Get.addColumn(byte[], byte[]) directly rather than a filter.


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
QualifierFilter()
          Writable constructor, do not use.
QualifierFilter(CompareFilter.CompareOp qualifierCompareOp, WritableByteArrayComparable qualifierComparator)
          Constructor.
 
Method Summary
 Filter.ReturnCode filterKeyValue(KeyValue v)
          A way to filter based on the column family, column qualifier and/or the column value.
 
Methods inherited from class org.apache.hadoop.hbase.filter.CompareFilter
doCompare, filterAllRemaining, filterRow, filterRowKey, readFields, reset, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

QualifierFilter

public QualifierFilter()
Writable constructor, do not use.


QualifierFilter

public QualifierFilter(CompareFilter.CompareOp qualifierCompareOp,
                       WritableByteArrayComparable qualifierComparator)
Constructor.

Parameters:
qualifierCompareOp - the compare op for column qualifier matching
qualifierComparator - the comparator for column qualifier matching
Method Detail

filterKeyValue

public Filter.ReturnCode filterKeyValue(KeyValue v)
Description copied from interface: Filter
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 your filter returns ReturnCode.NEXT_ROW, it should return ReturnCode.NEXT_ROW until Filter.reset() is called just in case the caller calls for the next row.

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


Copyright © 2009 The Apache Software Foundation