@InterfaceAudience.Public @InterfaceStability.Stable public class RowFilter extends CompareFilter
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.
CompareFilter.CompareOp
Filter.ReturnCode
comparator, compareOp
Constructor and Description |
---|
RowFilter(CompareFilter.CompareOp rowCompareOp,
ByteArrayComparable rowComparator)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments) |
Filter.ReturnCode |
filterKeyValue(Cell v)
Filters that dont filter by key value can inherit this implementation that
includes all Cells.
|
boolean |
filterRow()
Filters that never filter by rows based on previously gathered state from
FilterBase.filterKeyValue(Cell) 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
|
doCompare, extractArguments, getComparator, getOperator, toString
filterAllRemaining, filterRow, filterRowCells, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, transform, transformCell
isReversed, setReversed
public RowFilter(CompareFilter.CompareOp rowCompareOp, ByteArrayComparable rowComparator)
rowCompareOp
- the compare op for row matchingrowComparator
- the comparator for row matchingpublic void reset()
org.apache.hadoop.hbase.filter.FilterBase
reset
in class org.apache.hadoop.hbase.filter.FilterBase
public Filter.ReturnCode filterKeyValue(Cell v)
org.apache.hadoop.hbase.filter.FilterBase
filterKeyValue
in class org.apache.hadoop.hbase.filter.FilterBase
v
- the Cell in questionFilter.ReturnCode
public boolean filterRowKey(byte[] data, int offset, int length)
org.apache.hadoop.hbase.filter.FilterBase
filterRowKey
in class org.apache.hadoop.hbase.filter.FilterBase
data
- buffer containing row keyoffset
- offset into buffer where row key startslength
- length of the row keypublic boolean filterRow()
org.apache.hadoop.hbase.filter.FilterBase
FilterBase.filterKeyValue(Cell)
can inherit this implementation that
never filters a row.filterRow
in class org.apache.hadoop.hbase.filter.FilterBase
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
org.apache.hadoop.hbase.filter.FilterBase
toByteArray
in class org.apache.hadoop.hbase.filter.FilterBase
public static RowFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException
pbBytes
- A pb serialized RowFilter
instanceRowFilter
made from bytes
org.apache.hadoop.hbase.exceptions.DeserializationException
toByteArray()
Copyright © 2014 The Apache Software Foundation. All rights reserved.