|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.filter.FilterBase
org.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)
Filters that dont filter by key value can inherit this implementation that includes all KeyValues. |
boolean |
filterRow()
Filters that never filter by rows based on previously gathered state from FilterBase.filterKeyValue(KeyValue) can inherit this implementation that
never filters a row. |
boolean |
filterRowKey(byte[] data,
int offset,
int length)
Filters that do not filter by row key can inherit this implementation that never filters anything. |
void |
reset()
Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. |
Methods inherited from class org.apache.hadoop.hbase.filter.CompareFilter |
---|
doCompare, getComparator, getOperator, readFields, write |
Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase |
---|
filterAllRemaining, filterRow, getNextKeyHint, hasFilterRow |
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()
FilterBase
reset
in interface Filter
reset
in class FilterBase
public Filter.ReturnCode filterKeyValue(KeyValue v)
FilterBase
filterKeyValue
in interface Filter
filterKeyValue
in class FilterBase
v
- the KeyValue in question
Filter.ReturnCode
public boolean filterRowKey(byte[] data, int offset, int length)
FilterBase
filterRowKey
in interface Filter
filterRowKey
in class FilterBase
data
- buffer containing row keyoffset
- offset into buffer where row key startslength
- length of the row key
public boolean filterRow()
FilterBase
FilterBase.filterKeyValue(KeyValue)
can inherit this implementation that
never filters a row.
filterRow
in interface Filter
filterRow
in class FilterBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |