|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.CompareFilter
org.apache.hadoop.hbase.filter.RowFilter
@InterfaceAudience.Public @InterfaceStability.Stable 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 class 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(CompareFilter.CompareOp rowCompareOp,
ByteArrayComparable rowComparator)
Constructor. |
|
| Method Summary | |
|---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments)
|
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. |
static RowFilter |
parseFrom(byte[] pbBytes)
|
void |
reset()
Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. |
byte[] |
toByteArray()
Return length 0 byte array for Filters that don't require special serialization |
| Methods inherited from class org.apache.hadoop.hbase.filter.CompareFilter |
|---|
doCompare, extractArguments, getComparator, getOperator, toString |
| Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase |
|---|
filterAllRemaining, filterRow, getNextKeyHint, hasFilterRow, isFamilyEssential, transform |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public RowFilter(CompareFilter.CompareOp rowCompareOp,
ByteArrayComparable rowComparator)
rowCompareOp - the compare op for row matchingrowComparator - the comparator for row matching| Method Detail |
|---|
public void reset()
FilterBase
reset in class FilterBasepublic Filter.ReturnCode filterKeyValue(KeyValue v)
FilterBase
filterKeyValue in class FilterBasev - the KeyValue in question
Filter.ReturnCode
public boolean filterRowKey(byte[] data,
int offset,
int length)
FilterBase
filterRowKey in class FilterBasedata - buffer containing row keyoffset - offset into buffer where row key startslength - length of the row key
public boolean filterRow()
FilterBaseFilterBase.filterKeyValue(KeyValue) can inherit this implementation that
never filters a row.
filterRow in class FilterBasepublic static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
FilterBase
toByteArray in class FilterBase
public static RowFilter parseFrom(byte[] pbBytes)
throws DeserializationException
pbBytes - A pb serialized RowFilter instance
RowFilter made from bytes
DeserializationExceptiontoByteArray()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||