org.apache.hadoop.hbase.filter

类 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 CellScanner start and stop rows directly rather than a filter.

嵌套类概要

从类继承的嵌套类/接口 org.apache.hadoop.hbase.filter.CompareFilter

CompareFilter.CompareOp

从类继承的嵌套类/接口 org.apache.hadoop.hbase.filter.Filter

Filter.ReturnCode

字段概要

从类继承的字段 org.apache.hadoop.hbase.filter.CompareFilter

comparator, compareOp

从类继承的字段 org.apache.hadoop.hbase.filter.Filter

reversed

构造器概要

构造器

构造器和说明
RowFilter(CompareFilter.CompareOp rowCompareOp, ByteArrayComparable rowComparator) Constructor.

方法概要

方法

限定符和类型	方法和说明
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
boolean	equals(Object obj)
Filter.ReturnCode	filterKeyValue(Cell v) A way to filter based on the column family, column qualifier and/or the column value.
boolean	filterRow() Filters that never filter by rows based on previously gathered state from Filter.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.
int	hashCode()
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

从类继承的方法 org.apache.hadoop.hbase.filter.CompareFilter

doCompare, extractArguments, getComparator, getOperator, toString, transformCell

从类继承的方法 org.apache.hadoop.hbase.filter.FilterBase

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

从类继承的方法 org.apache.hadoop.hbase.filter.Filter

isReversed, setReversed

从类继承的方法 java.lang.Object

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

构造器详细资料

RowFilter

public RowFilter(CompareFilter.CompareOp rowCompareOp,
         ByteArrayComparable rowComparator)

Constructor.

参数:

rowCompareOp - the compare op for row matching

rowComparator - the comparator for row matching

方法详细资料

reset

public void reset()

从类复制的说明: 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.

覆盖:

reset 在类中 FilterBase

filterKeyValue

public Filter.ReturnCode filterKeyValue(Cell v)

从类复制的说明: 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.

指定者:

filterKeyValue 在类中 Filter

参数:

v - the Cell in question

返回:

code as described below

另请参阅:

Filter.ReturnCode

filterRowKey

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

从类复制的说明: FilterBase

Filters that do not filter by row key can inherit this implementation that never filters anything. (ie: returns false). 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.filterKeyValue(Cell) below. Concrete implementers can signal a failure condition in their code by throwing an IOException.

覆盖:

filterRowKey 在类中 FilterBase

参数:

data - buffer containing row key

offset - offset into buffer where row key starts

length - length of the row key

返回:

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

filterRow

public boolean filterRow()

从类复制的说明: FilterBase

Filters that never filter by rows based on previously gathered state from Filter.filterKeyValue(Cell) can inherit this implementation that never filters a row. Last chance to veto row based on previous Filter.filterKeyValue(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.

覆盖:

filterRow 在类中 FilterBase

返回:

true to exclude row, false to include row.

createFilterFromArguments

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

toByteArray

public byte[] toByteArray()

从类复制的说明: FilterBase

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

覆盖:

toByteArray 在类中 FilterBase

返回:

The filter serialized using pb

parseFrom

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

参数:

pbBytes - A pb serialized RowFilter instance

返回:

An instance of RowFilter made from bytes

抛出:

DeserializationException

另请参阅:

toByteArray()

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 CompareFilter

hashCode

public int hashCode()

覆盖:

hashCode 在类中 CompareFilter