org.apache.hadoop.hbase.filter

Class FamilyFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.CompareFilter

org.apache.hadoop.hbase.filter.FamilyFilter

@InterfaceAudience.Public
@InterfaceStability.Stable
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 class org.apache.hadoop.hbase.filter.Filter

Filter.ReturnCode

Field Summary

Fields inherited from class org.apache.hadoop.hbase.filter.CompareFilter

comparator, compareOp

Fields inherited from class org.apache.hadoop.hbase.filter.Filter

reversed

Constructor Summary

Constructors

Constructor and Description
FamilyFilter(CompareFilter.CompareOp familyCompareOp, ByteArrayComparable familyComparator) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
Filter.ReturnCode	filterKeyValue(Cell v) A way to filter based on the column family, column qualifier and/or the column value.
static FamilyFilter	parseFrom(byte[] pbBytes)
byte[]	toByteArray() Return length 0 byte array for Filters that don't require special serialization

Methods inherited from class org.apache.hadoop.hbase.filter.CompareFilter

doCompare, extractArguments, getComparator, getOperator, toString, transformCell

Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase

filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, reset, transform

Methods inherited from class org.apache.hadoop.hbase.filter.Filter

isReversed, setReversed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FamilyFilter

public FamilyFilter(CompareFilter.CompareOp familyCompareOp,
            ByteArrayComparable 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(Cell v)

Description copied from class: 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 filterRowKey returns true, filterKeyValue needs to be consistent with it. filterKeyValue can assume that filterRowKey has already been called for the row. 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. Concrete implementers can signal a failure condition in their code by throwing an IOException.

Specified by:

filterKeyValue in class Filter

Parameters:

v - the Cell in question

Returns:

code as described below

See Also:

Filter.ReturnCode

createFilterFromArguments

public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)

toByteArray

public byte[] toByteArray()

Description copied from class: FilterBase

Return length 0 byte array for Filters that don't require special serialization

Overrides:

toByteArray in class FilterBase

Returns:

The filter serialized using pb

parseFrom

public static FamilyFilter parseFrom(byte[] pbBytes)
                              throws DeserializationException

Parameters:

pbBytes - A pb serialized FamilyFilter instance

Returns:

An instance of FamilyFilter made from bytes

Throws:

DeserializationException

See Also:

toByteArray()