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

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

reversed

Constructor Summary

Constructors

Constructor and Description
RowFilter(CompareFilter.CompareOp rowCompareOp, ByteArrayComparable rowComparator) Deprecated. Since 2.0.0. Will remove in 3.0.0. Use RowFilter(CompareOperator, ByteArrayComparable)} instead.
RowFilter(CompareOperator op, ByteArrayComparable rowComparator) Constructor.

Method Summary

Modifier and Type	Method and Description
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
boolean	equals(Object obj)
Filter.ReturnCode	filterCell(Cell v) A way to filter based on the column family, column qualifier and/or the column value.
Filter.ReturnCode	filterKeyValue(Cell c) Deprecated.
boolean	filterRow() Filters that never filter by rows based on previously gathered state from Filter.filterCell(Cell) can inherit this implementation that never filters a row.
boolean	filterRowKey(Cell firstRowCell) Filters a row based on the row key.
int	hashCode()
static RowFilter	parseFrom(byte[] pbBytes) Parse a serialized representation of RowFilter
void	reset() Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.
byte[]	toByteArray() Returns The filter serialized using pb

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

compareFamily, compareFamily, compareQualifier, compareQualifier, compareRow, compareRow, compareValue, compareValue, extractArguments, getComparator, getCompareOperator, getOperator, toString

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

filterAllRemaining, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, 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

RowFilter

@Deprecated
public RowFilter(CompareFilter.CompareOp rowCompareOp,
                             ByteArrayComparable rowComparator)

Deprecated. Since 2.0.0. Will remove in 3.0.0. Use RowFilter(CompareOperator, ByteArrayComparable)} instead.

Constructor.

Parameters:

rowCompareOp - the compare op for row matching

rowComparator - the comparator for row matching

RowFilter

public RowFilter(CompareOperator op,
                 ByteArrayComparable rowComparator)

Constructor.

Parameters:

op - the compare op for row matching

rowComparator - the comparator for row matching

Method Detail

reset

public void reset()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. Reset the state of the filter between rows. Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

reset in class org.apache.hadoop.hbase.filter.FilterBase

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

v - the Cell in question

Returns:

code as described below

See Also:

Filter.ReturnCode

filterRowKey

public boolean filterRowKey(Cell firstRowCell)

Description copied from class: Filter

Filters a row based on the row key. If this returns true, the entire row will be excluded. If false, each KeyValue in the row will be passed to Filter.filterCell(Cell) below. If Filter.filterAllRemaining() returns true, then Filter.filterRowKey(Cell) should also return true. Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

filterRowKey in class CompareFilter

Parameters:

firstRowCell - The first cell coming in the new row

Returns:

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

filterRow

public boolean filterRow()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Filters that never filter by rows based on previously gathered state from Filter.filterCell(Cell) can inherit this implementation that never filters a row. Last chance to veto row based on previous Filter.filterCell(Cell) calls. The filter needs to retain state then return a particular value for this call if they wish to exclude a row if a certain column is missing (for example). Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

filterRow in class org.apache.hadoop.hbase.filter.FilterBase

Returns:

true to exclude row, false to include row.

createFilterFromArguments

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

toByteArray

public byte[] toByteArray()

Returns The filter serialized using pb

Overrides:

toByteArray in class org.apache.hadoop.hbase.filter.FilterBase

Returns:

The filter serialized using pb

parseFrom

public static RowFilter parseFrom(byte[] pbBytes)
                           throws org.apache.hadoop.hbase.exceptions.DeserializationException

Parse a serialized representation of RowFilter

Parameters:

pbBytes - A pb serialized RowFilter instance

Returns:

An instance of RowFilter made from bytes

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException - if an error occurred

See Also:

toByteArray()

equals

public boolean equals(Object obj)

Overrides:

equals in class CompareFilter

hashCode

public int hashCode()

Overrides:

hashCode in class CompareFilter