org.apache.hadoop.hbase.filter

Class CompareFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.CompareFilter

Direct Known Subclasses:

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompareFilter.CompareOp Deprecated. since 2.0.0. Will be removed in 3.0.0. Use CompareOperator instead.

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter

Filter.ReturnCode

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteArrayComparable	comparator
protected CompareOperator	op

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

reversed

Constructor Summary

Constructors

Constructor and Description
CompareFilter(CompareFilter.CompareOp compareOp, ByteArrayComparable comparator) Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use other constructor.
CompareFilter(CompareOperator op, ByteArrayComparable comparator) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	areSerializedFieldsEqual(Filter o) Default implementation so that writers of custom filters aren't forced to implement.
(package private) static boolean	compare(CompareFilter.CompareOp op, int compareResult)
(package private) static boolean	compare(CompareOperator op, int compareResult)
protected boolean	compareFamily(CompareFilter.CompareOp compareOp, ByteArrayComparable comparator, Cell cell) Deprecated. 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) Deprecated. 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) Deprecated. 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) Deprecated. 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)
(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos.CompareFilter	convert()
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() Deprecated. 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.

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

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

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

filterCell, filterKeyValue, isReversed, parseFrom, setReversed

Methods inherited from class java.lang.Object

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

Field Detail

op

protected CompareOperator op

comparator

protected ByteArrayComparable comparator

Constructor Detail

CompareFilter

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

Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use other constructor.

Constructor.

Parameters:

compareOp - the compare op for row matching

comparator - the comparator for row matching

CompareFilter

public CompareFilter(CompareOperator op,
                     ByteArrayComparable comparator)

Constructor.

Parameters:

op - the compare op for row matching

comparator - the comparator for row matching

Method Detail

getOperator

@Deprecated
public CompareFilter.CompareOp getOperator()

Deprecated. since 2.0.0. Will be removed in 3.0.0. Use getCompareOperator() instead.

Returns:

operator

getCompareOperator

public CompareOperator getCompareOperator()

getComparator

public ByteArrayComparable getComparator()

Returns:

the comparator

filterRowKey

public boolean filterRowKey(Cell cell)
                     throws IOException

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 FilterBase

Parameters:

cell - The first cell coming in the new row

Returns:

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

Throws:

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)

Deprecated. 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)

Deprecated. 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)

Deprecated. 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)

Deprecated. 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)

compare

static boolean compare(CompareFilter.CompareOp op,
                       int compareResult)

compare

static boolean compare(CompareOperator op,
                       int compareResult)

extractArguments

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

convert

org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos.CompareFilter convert()

Returns:

A pb instance to represent this instance.

areSerializedFieldsEqual

boolean areSerializedFieldsEqual(Filter o)

Description copied from class: FilterBase

Default implementation so that writers of custom filters aren't forced to implement.

Overrides:

areSerializedFieldsEqual in class FilterBase

Parameters:

o -

Returns:

true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.

toString

public String toString()

Description copied from class: FilterBase

Return filter's info for debugging and logging purpose.

Overrides:

toString in class FilterBase

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object