org.apache.hadoop.hbase.filter

类 CompareFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.CompareFilter

直接已知子类:

DependentColumnFilter, FamilyFilter, QualifierFilter, RowFilter, ValueFilter

@InterfaceAudience.Public
public abstract class CompareFilter
extends FilterBase

This is a generic filter to be used to filter by comparison. It takes an operator (equal, greater, not equal, etc) and a byte [] comparator.

To filter by row key, use RowFilter.

To filter by column family, use FamilyFilter.

To filter by column qualifier, use QualifierFilter.

To filter by value, use ValueFilter.

These filters can be wrapped with SkipFilter and WhileMatchFilter to add more control.

Multiple filters can be combined using FilterList.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CompareFilter.CompareOp 已过时。 since 2.0.0. Will be removed in 3.0.0. Use CompareOperator instead.

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

Filter.ReturnCode

字段概要

字段

限定符和类型	字段和说明
protected ByteArrayComparable	comparator
protected CompareOperator	op

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

reversed

构造器概要

构造器

构造器和说明
CompareFilter(CompareFilter.CompareOp compareOp, ByteArrayComparable comparator) 已过时。 Since 2.0.0. Will be removed in 3.0.0. Use other constructor.
CompareFilter(CompareOperator op, ByteArrayComparable comparator) Constructor.

方法概要

限定符和类型	方法和说明
protected boolean	compareFamily(CompareFilter.CompareOp compareOp, ByteArrayComparable comparator, Cell cell) 已过时。 Since 2.0.0. Will be removed in 3.0.0. Use compareFamily(CompareOperator, ByteArrayComparable, Cell)
protected boolean	compareFamily(CompareOperator op, ByteArrayComparable comparator, Cell cell)
protected boolean	compareQualifier(CompareFilter.CompareOp compareOp, ByteArrayComparable comparator, Cell cell) 已过时。 Since 2.0.0. Will be removed in 3.0.0. Use compareQualifier(CompareOperator, ByteArrayComparable, Cell)
protected boolean	compareQualifier(CompareOperator op, ByteArrayComparable comparator, Cell cell)
protected boolean	compareRow(CompareFilter.CompareOp compareOp, ByteArrayComparable comparator, Cell cell) 已过时。 Since 2.0.0. Will be removed in 3.0.0. Use compareRow(CompareOperator, ByteArrayComparable, Cell)
protected boolean	compareRow(CompareOperator op, ByteArrayComparable comparator, Cell cell)
protected boolean	compareValue(CompareFilter.CompareOp compareOp, ByteArrayComparable comparator, Cell cell) 已过时。 Since 2.0.0. Will be removed in 3.0.0. Use compareValue(CompareOperator, ByteArrayComparable, Cell)
protected boolean	compareValue(CompareOperator op, ByteArrayComparable comparator, Cell cell)
boolean	equals(Object obj)
static ArrayList<Object>	extractArguments(ArrayList<byte[]> filterArguments)
boolean	filterRowKey(Cell cell) Filters a row based on the row key.
ByteArrayComparable	getComparator()
CompareOperator	getCompareOperator()
CompareFilter.CompareOp	getOperator() 已过时。 since 2.0.0. Will be removed in 3.0.0. Use getCompareOperator() instead.
int	hashCode()
String	toString() Return filter's info for debugging and logging purpose.

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

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

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

filterCell, filterKeyValue, isReversed, parseFrom, setReversed

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

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

字段详细资料

op

protected CompareOperator op

comparator

protected ByteArrayComparable comparator

构造器详细资料

CompareFilter

@Deprecated
public CompareFilter(CompareFilter.CompareOp compareOp,
                                 ByteArrayComparable comparator)

已过时。 Since 2.0.0. Will be removed in 3.0.0. Use other constructor.

Constructor.

参数:

compareOp - the compare op for row matching

comparator - the comparator for row matching

CompareFilter

public CompareFilter(CompareOperator op,
                     ByteArrayComparable comparator)

Constructor.

参数:

op - the compare op for row matching

comparator - the comparator for row matching

方法详细资料

getOperator

@Deprecated
public CompareFilter.CompareOp getOperator()

已过时。 since 2.0.0. Will be removed in 3.0.0. Use getCompareOperator() instead.

返回:

operator

getCompareOperator

public CompareOperator getCompareOperator()

getComparator

public ByteArrayComparable getComparator()

返回:

the comparator

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.

compareRow

@Deprecated
protected boolean compareRow(CompareFilter.CompareOp compareOp,
                                         ByteArrayComparable comparator,
                                         Cell cell)

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

compareRow

protected boolean compareRow(CompareOperator op,
                             ByteArrayComparable comparator,
                             Cell cell)

compareFamily

@Deprecated
protected boolean compareFamily(CompareFilter.CompareOp compareOp,
                                            ByteArrayComparable comparator,
                                            Cell cell)

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

compareFamily

protected boolean compareFamily(CompareOperator op,
                                ByteArrayComparable comparator,
                                Cell cell)

compareQualifier

@Deprecated
protected boolean compareQualifier(CompareFilter.CompareOp compareOp,
                                               ByteArrayComparable comparator,
                                               Cell cell)

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

compareQualifier

protected boolean compareQualifier(CompareOperator op,
                                   ByteArrayComparable comparator,
                                   Cell cell)

compareValue

@Deprecated
protected boolean compareValue(CompareFilter.CompareOp compareOp,
                                           ByteArrayComparable comparator,
                                           Cell cell)

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

compareValue

protected boolean compareValue(CompareOperator op,
                               ByteArrayComparable comparator,
                               Cell cell)

extractArguments

public static ArrayList<Object> extractArguments(ArrayList<byte[]> filterArguments)

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