@InterfaceAudience.Public public abstract class CompareFilter extends org.apache.hadoop.hbase.filter.FilterBase
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
.
Filter.ReturnCode
Modifier and Type | Field and Description |
---|---|
protected ByteArrayComparable |
comparator |
protected CompareOperator |
op |
Constructor and Description |
---|
CompareFilter(CompareOperator op,
ByteArrayComparable comparator)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
compareFamily(CompareOperator op,
ByteArrayComparable comparator,
Cell cell) |
protected boolean |
compareQualifier(CompareOperator op,
ByteArrayComparable comparator,
Cell cell) |
protected boolean |
compareRow(CompareOperator op,
ByteArrayComparable comparator,
Cell cell) |
protected boolean |
compareValue(CompareOperator op,
ByteArrayComparable comparator,
Cell cell) |
boolean |
equals(Object obj) |
static ArrayList<Object> |
extractArguments(ArrayList<byte[]> filterArguments)
Returns an array of heterogeneous objects
|
boolean |
filterRowKey(Cell cell)
Filters a row based on the row key.
|
ByteArrayComparable |
getComparator()
Returns the comparator
|
CompareOperator |
getCompareOperator() |
int |
hashCode() |
String |
toString()
Return filter's info for debugging and logging purpose.
|
createFilterFromArguments, filterAllRemaining, filterRow, filterRowCells, getNextCellHint, hasFilterRow, isFamilyEssential, reset, toByteArray, transformCell
filterCell, isReversed, parseFrom, setReversed
protected CompareOperator op
protected ByteArrayComparable comparator
public CompareFilter(CompareOperator op, ByteArrayComparable comparator)
op
- the compare op for row matchingcomparator
- the comparator for row matchingpublic CompareOperator getCompareOperator()
public ByteArrayComparable getComparator()
public boolean filterRowKey(Cell cell) throws IOException
Filter
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
in class org.apache.hadoop.hbase.filter.FilterBase
cell
- The first cell coming in the new rowIOException
- in case an I/O or an filter specific failure needs to be signaled.protected boolean compareRow(CompareOperator op, ByteArrayComparable comparator, Cell cell)
protected boolean compareFamily(CompareOperator op, ByteArrayComparable comparator, Cell cell)
protected boolean compareQualifier(CompareOperator op, ByteArrayComparable comparator, Cell cell)
protected boolean compareValue(CompareOperator op, ByteArrayComparable comparator, Cell cell)
public static ArrayList<Object> extractArguments(ArrayList<byte[]> filterArguments)
public String toString()
org.apache.hadoop.hbase.filter.FilterBase
toString
in class org.apache.hadoop.hbase.filter.FilterBase
Copyright © 2007–2020 The Apache Software Foundation. All rights reserved.