org.apache.hadoop.hbase.filter

类 ColumnValueFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.ColumnValueFilter

@InterfaceAudience.Public
public class ColumnValueFilter
extends FilterBase

Different from SingleColumnValueFilter which returns an entire row when specified condition is matched, ColumnValueFilter return the matched cell only.

This filter is used to filter cells based on column and value. It takes a CompareOperator operator (<, <=, =, !=, >, >=), and and a ByteArrayComparable comparator.

嵌套类概要

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

Filter.ReturnCode

字段概要

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

reversed

构造器概要

构造器

构造器和说明
ColumnValueFilter(byte[] family, byte[] qualifier, CompareOperator op, byte[] value)
ColumnValueFilter(byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator)

方法概要

限定符和类型	方法和说明
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments) Creating this filter by reflection, it is used by ParseFilter,
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.
boolean	filterRowKey(Cell cell) Filters a row based on the row key.
ByteArrayComparable	getComparator()
CompareOperator	getCompareOperator()
byte[]	getFamily()
byte[]	getQualifier()
int	hashCode()
boolean	isFamilyEssential(byte[] name) By default, we require all scan's column families to be present.
static ColumnValueFilter	parseFrom(byte[] pbBytes) Parse protobuf bytes to a ColumnValueFilter
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
String	toString() Return filter's info for debugging and logging purpose.

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

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

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

filterKeyValue, isReversed, setReversed

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

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

构造器详细资料

ColumnValueFilter

public ColumnValueFilter(byte[] family,
                         byte[] qualifier,
                         CompareOperator op,
                         byte[] value)

ColumnValueFilter

public ColumnValueFilter(byte[] family,
                         byte[] qualifier,
                         CompareOperator op,
                         ByteArrayComparable comparator)

方法详细资料

getCompareOperator

public CompareOperator getCompareOperator()

返回:

operator

getComparator

public ByteArrayComparable getComparator()

返回:

the comparator

getFamily

public byte[] getFamily()

返回:

the column family

getQualifier

public byte[] getQualifier()

返回:

the qualifier

reset

public void reset()
           throws IOException

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

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

filterRowKey

public boolean filterRowKey(Cell cell)
                     throws IOException

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

覆盖:

filterRowKey 在类中 FilterBase

参数:

cell - The first cell coming in the new row

返回:

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

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

filterCell

public Filter.ReturnCode filterCell(Cell c)
                             throws IOException

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

覆盖:

filterCell 在类中 Filter

参数:

c - the Cell in question

返回:

code as described below

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

另请参阅:

Filter.ReturnCode

createFilterFromArguments

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

Creating this filter by reflection, it is used by ParseFilter,

参数:

filterArguments - arguments for creating a ColumnValueFilter

返回:

a ColumnValueFilter

parseFrom

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

Parse protobuf bytes to a ColumnValueFilter

参数:

pbBytes - pbBytes

返回:

a ColumnValueFilter

抛出:

DeserializationException - deserialization exception

toByteArray

public byte[] toByteArray()
                   throws IOException

从类复制的说明: FilterBase

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

覆盖:

toByteArray 在类中 FilterBase

返回:

The filter serialized using pb

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

isFamilyEssential

public boolean isFamilyEssential(byte[] name)
                          throws IOException

从类复制的说明: FilterBase

By default, we require all scan's column families to be present. Our subclasses may be more precise. Check that given column family is essential for filter to check row. Most filters always return true here. But some could have more sophisticated logic which could significantly reduce scanning process by not even touching columns until we are 100% sure that it's data is needed in result. Concrete implementers can signal a failure condition in their code by throwing an IOException.

覆盖:

isFamilyEssential 在类中 FilterBase

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

toString

public String toString()

从类复制的说明: FilterBase

Return filter's info for debugging and logging purpose.

覆盖:

toString 在类中 FilterBase

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object