org.apache.hadoop.hbase.filter
Class FamilyFilter

java.lang.Object
  org.apache.hadoop.hbase.filter.FilterBase
      org.apache.hadoop.hbase.filter.CompareFilter
          org.apache.hadoop.hbase.filter.FamilyFilter

All Implemented Interfaces:

Filter, org.apache.hadoop.io.Writable

public class FamilyFilter
extends CompareFilter

This filter is used to filter based on the column family. It takes an operator (equal, greater, not equal, etc) and a byte [] comparator for the column family 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 family is looked for, use Get.addFamily(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

FamilyFilter()
Writable constructor, do not use.

FamilyFilter(CompareFilter.CompareOp familyCompareOp, WritableByteArrayComparable familyComparator)
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

FamilyFilter

public FamilyFilter()

Writable constructor, do not use.

FamilyFilter

public FamilyFilter(CompareFilter.CompareOp familyCompareOp,
                    WritableByteArrayComparable familyComparator)

Constructor.

Parameters:

familyCompareOp - the compare op for column family matching

familyComparator - the comparator for column family 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