org.apache.hadoop.hbase.filter

类 ValueFilter

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

@InterfaceAudience.Public
public class ValueFilter
extends CompareFilter

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

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

Multiple filters can be combined using FilterList.

To test the value of a single qualifier when scanning multiple qualifiers, use SingleColumnValueFilter.

嵌套类概要

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

CompareFilter.CompareOp

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

Filter.ReturnCode

字段概要

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

comparator, op

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

reversed

构造器概要

构造器

构造器和说明
ValueFilter(CompareFilter.CompareOp valueCompareOp, ByteArrayComparable valueComparator) 已过时。 Since 2.0.0. Will be removed in 3.0.0. Use ValueFilter(CompareOperator, ByteArrayComparable)
ValueFilter(CompareOperator valueCompareOp, ByteArrayComparable valueComparator) Constructor.

方法概要

限定符和类型	方法和说明
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) 已过时。
int	hashCode()
static ValueFilter	parseFrom(byte[] pbBytes)
byte[]	toByteArray() Return length 0 byte array for Filters that don't require special serialization

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

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

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

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

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

isReversed, setReversed

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

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

构造器详细资料

ValueFilter

public ValueFilter(CompareFilter.CompareOp valueCompareOp,
                   ByteArrayComparable valueComparator)

已过时。 Since 2.0.0. Will be removed in 3.0.0. Use ValueFilter(CompareOperator, ByteArrayComparable)

Constructor.

参数:

valueCompareOp - the compare op for value matching

valueComparator - the comparator for value matching

ValueFilter

public ValueFilter(CompareOperator valueCompareOp,
                   ByteArrayComparable valueComparator)

Constructor.

参数:

valueCompareOp - the compare op for value matching

valueComparator - the comparator for value matching

方法详细资料

filterKeyValue

@Deprecated
public Filter.ReturnCode filterKeyValue(Cell c)

已过时。

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

参数:

c - the Cell in question

返回:

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

另请参阅:

Filter.ReturnCode

filterCell

public Filter.ReturnCode filterCell(Cell c)

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

另请参阅:

Filter.ReturnCode

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

参数:

pbBytes - A pb serialized ValueFilter instance

返回:

An instance of ValueFilter made from bytes

抛出:

DeserializationException

另请参阅:

toByteArray()

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 CompareFilter

hashCode

public int hashCode()

覆盖:

hashCode 在类中 CompareFilter