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
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, op

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

reversed

Constructor Summary

Constructors

Constructor and Description
FamilyFilter(CompareFilter.CompareOp familyCompareOp, ByteArrayComparable familyComparator) Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use FamilyFilter(CompareOperator, ByteArrayComparable)
FamilyFilter(CompareOperator op, ByteArrayComparable familyComparator) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	areSerializedFieldsEqual(Filter o) Default implementation so that writers of custom filters aren't forced to implement.
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
boolean	equals(Object obj)
Filter.ReturnCode	filterCell(Cell c) A way to filter based on the column family, column qualifier and/or the column value.
Filter.ReturnCode	filterKeyValue(Cell c) Deprecated.
int	hashCode()
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

compare, compare, compareFamily, compareFamily, compareQualifier, compareQualifier, compareRow, compareRow, compareValue, compareValue, convert, extractArguments, filterRowKey, getComparator, getCompareOperator, getOperator, toString

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

filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, reset, transformCell

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

isReversed, setReversed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FamilyFilter

@Deprecated
public FamilyFilter(CompareFilter.CompareOp familyCompareOp,
                                ByteArrayComparable familyComparator)

Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use FamilyFilter(CompareOperator, ByteArrayComparable)

Constructor.

Parameters:

familyCompareOp - the compare op for column family matching

familyComparator - the comparator for column family matching

FamilyFilter

public FamilyFilter(CompareOperator op,
                    ByteArrayComparable familyComparator)

Constructor.

Parameters:

op - the compare op for column family matching

familyComparator - the comparator for column family matching

Method Detail

filterKeyValue

@Deprecated
public Filter.ReturnCode filterKeyValue(Cell c)

Deprecated.

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.

Overrides:

filterKeyValue in class Filter

Parameters:

c - the Cell in question

Returns:

code as described below, Filter.ReturnCode.INCLUDE by default

See Also:

Filter.ReturnCode

filterCell

public Filter.ReturnCode filterCell(Cell c)

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, filterCell needs to be consistent with it. filterCell 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.

Overrides:

filterCell in class Filter

Parameters:

c - 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()

areSerializedFieldsEqual

boolean areSerializedFieldsEqual(Filter o)

Description copied from class: FilterBase

Default implementation so that writers of custom filters aren't forced to implement.

Overrides:

areSerializedFieldsEqual in class CompareFilter

Returns:

true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.

equals

public boolean equals(Object obj)

Overrides:

equals in class CompareFilter

hashCode

public int hashCode()

Overrides:

hashCode in class CompareFilter