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
@InterfaceStability.Stable
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 qualifier, use QualifierFilter.

To filter by value, use SingleColumnValueFilter.

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 Comparison operators.

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 CompareFilter.CompareOp	compareOp

Constructor Summary

Constructors

Constructor and Description
CompareFilter(CompareFilter.CompareOp compareOp, ByteArrayComparable comparator) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	doCompare(CompareFilter.CompareOp compareOp, ByteArrayComparable comparator, byte[] data, int offset, int length)
static ArrayList<Object>	extractArguments(ArrayList<byte[]> filterArguments)
ByteArrayComparable	getComparator()
CompareFilter.CompareOp	getOperator()
String	toString() Return filter's info for debugging and logging purpose.

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

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

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

parseFrom

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

compareOp

protected CompareFilter.CompareOp compareOp

comparator

protected ByteArrayComparable comparator

Constructor Detail

CompareFilter

public CompareFilter(CompareFilter.CompareOp compareOp,
             ByteArrayComparable comparator)

Constructor.

Parameters:

compareOp - the compare op for row matching

comparator - the comparator for row matching

Method Detail

getOperator

public CompareFilter.CompareOp getOperator()

Returns:

operator

getComparator

public ByteArrayComparable getComparator()

Returns:

the comparator

doCompare

protected boolean doCompare(CompareFilter.CompareOp compareOp,
                ByteArrayComparable comparator,
                byte[] data,
                int offset,
                int length)

extractArguments

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

toString

public String toString()

Description copied from class: FilterBase

Return filter's info for debugging and logging purpose.

Overrides:

toString in class FilterBase