|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.filter.CompareFilter
org.apache.hadoop.hbase.filter.RowFilter
public class RowFilter
This filter is used to filter based on the key. It takes an operator (equal, greater, not equal, etc) and a byte [] comparator for the row, and column qualifier portions of a key.
This filter can be wrapped with WhileMatchFilter
to add more control.
Multiple filters can be combined using FilterList
.
If an already known row range needs to be scanned, use Scan
start
and stop rows directly rather than a filter.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.CompareFilter |
---|
CompareFilter.CompareOp |
Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.filter.Filter |
---|
Filter.ReturnCode |
Field Summary |
---|
Fields inherited from class org.apache.hadoop.hbase.filter.CompareFilter |
---|
comparator, compareOp |
Constructor Summary | |
---|---|
RowFilter()
Writable constructor, do not use. |
|
RowFilter(CompareFilter.CompareOp rowCompareOp,
WritableByteArrayComparable rowComparator)
Constructor. |
Method Summary | |
---|---|
Filter.ReturnCode |
filterKeyValue(KeyValue v)
A way to filter based on the column family, column qualifier and/or the column value. |
boolean |
filterRow()
Last chance to veto row based on previous Filter.filterKeyValue(KeyValue)
calls. |
boolean |
filterRowKey(byte[] data,
int offset,
int length)
Filters a row based on the row key. |
void |
reset()
Reset the state of the filter between rows. |
Methods inherited from class org.apache.hadoop.hbase.filter.CompareFilter |
---|
doCompare, filterAllRemaining, getComparator, getOperator, readFields, write |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RowFilter()
public RowFilter(CompareFilter.CompareOp rowCompareOp, WritableByteArrayComparable rowComparator)
rowCompareOp
- the compare op for row matchingrowComparator
- the comparator for row matchingMethod Detail |
---|
public void reset()
Filter
reset
in interface Filter
reset
in class CompareFilter
public Filter.ReturnCode filterKeyValue(KeyValue v)
Filter
ReturnCode.NEXT_ROW
, it should return
ReturnCode.NEXT_ROW
until Filter.reset()
is called
just in case the caller calls for the next row.
filterKeyValue
in interface Filter
filterKeyValue
in class CompareFilter
v
- the KeyValue in question
Filter.ReturnCode
public boolean filterRowKey(byte[] data, int offset, int length)
Filter
Filter.filterKeyValue(KeyValue)
below.
filterRowKey
in interface Filter
filterRowKey
in class CompareFilter
data
- buffer containing row keyoffset
- offset into buffer where row key startslength
- length of the row key
public boolean filterRow()
Filter
Filter.filterKeyValue(KeyValue)
calls. The filter needs to retain state then return a particular value for
this call if they wish to exclude a row if a certain column is missing
(for example).
filterRow
in interface Filter
filterRow
in class CompareFilter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |