org.apache.hadoop.hbase.filter

Class RowFilter

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.RowFilter

@InterfaceAudience.Public
@InterfaceStability.Stable
public class RowFilter
extends CompareFilter

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

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

Multiple filters can be combined using FilterList.

If an already known row range needs to be scanned, use Scan start and stop rows 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

Constructor Summary

Constructors

Constructor and Description
RowFilter(CompareFilter.CompareOp rowCompareOp, ByteArrayComparable rowComparator) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
Filter.ReturnCode	filterKeyValue(Cell v) Filters that dont filter by key value can inherit this implementation that includes all Cells.
boolean	filterRow() Filters that never filter by rows based on previously gathered state from FilterBase.filterKeyValue(Cell) can inherit this implementation that never filters a row.
boolean	filterRowKey(byte[] data, int offset, int length) Filters that do not filter by row key can inherit this implementation that never filters anything.
static RowFilter	parseFrom(byte[] pbBytes)
void	reset() Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.
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

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

filterAllRemaining, filterRow, filterRowCells, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, transform, transformCell

Methods inherited from class java.lang.Object

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

Constructor Detail

RowFilter

public RowFilter(CompareFilter.CompareOp rowCompareOp,
         ByteArrayComparable rowComparator)

Constructor.

Parameters:

rowCompareOp - the compare op for row matching

rowComparator - the comparator for row matching

Method Detail

reset

public void reset()

Description copied from class: FilterBase

Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.

Overrides:

reset in class FilterBase

filterKeyValue

public Filter.ReturnCode filterKeyValue(Cell v)

Description copied from class: FilterBase

Filters that dont filter by key value can inherit this implementation that includes all Cells.

Overrides:

filterKeyValue in class FilterBase

Parameters:

v - the Cell in question

Returns:

code as described below

See Also:

Filter.ReturnCode

filterRowKey

public boolean filterRowKey(byte[] data,
                   int offset,
                   int length)

Description copied from class: FilterBase

Filters that do not filter by row key can inherit this implementation that never filters anything. (ie: returns false).

Overrides:

filterRowKey in class FilterBase

Parameters:

data - buffer containing row key

offset - offset into buffer where row key starts

length - length of the row key

Returns:

true, remove entire row, false, include the row (maybe).

filterRow

public boolean filterRow()

Description copied from class: FilterBase

Filters that never filter by rows based on previously gathered state from FilterBase.filterKeyValue(Cell) can inherit this implementation that never filters a row.

Overrides:

filterRow in class FilterBase

Returns:

true to exclude row, false to include row.

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 RowFilter parseFrom(byte[] pbBytes)
                           throws DeserializationException

Parameters:

pbBytes - A pb serialized RowFilter instance

Returns:

An instance of RowFilter made from bytes

Throws:

DeserializationException

See Also:

toByteArray()