@InterfaceAudience.Public 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 CellScanner
start
and stop rows directly rather than a filter.
CompareFilter.CompareOp
Filter.ReturnCode
comparator, op
Constructor and Description |
---|
RowFilter(CompareFilter.CompareOp rowCompareOp,
ByteArrayComparable rowComparator)
Deprecated.
Since 2.0.0. Will remove in 3.0.0. Use
RowFilter(CompareOperator, ByteArrayComparable) } instead. |
RowFilter(CompareOperator op,
ByteArrayComparable rowComparator)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments) |
boolean |
equals(Object obj) |
Filter.ReturnCode |
filterCell(Cell v)
A way to filter based on the column family, column qualifier and/or the column value.
|
Filter.ReturnCode |
filterKeyValue(Cell c)
Deprecated.
|
boolean |
filterRow()
Filters that never filter by rows based on previously gathered state from
Filter.filterCell(Cell) can inherit this implementation that
never filters a row. |
boolean |
filterRowKey(Cell firstRowCell)
Filters a row based on the row key.
|
int |
hashCode() |
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
|
compareFamily, compareFamily, compareQualifier, compareQualifier, compareRow, compareRow, compareValue, compareValue, extractArguments, getComparator, getCompareOperator, getOperator, toString
filterAllRemaining, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, transformCell
isReversed, setReversed
@Deprecated public RowFilter(CompareFilter.CompareOp rowCompareOp, ByteArrayComparable rowComparator)
RowFilter(CompareOperator, ByteArrayComparable)
} instead.rowCompareOp
- the compare op for row matchingrowComparator
- the comparator for row matchingpublic RowFilter(CompareOperator op, ByteArrayComparable rowComparator)
op
- the compare op for row matchingrowComparator
- the comparator for row matchingpublic void reset()
org.apache.hadoop.hbase.filter.FilterBase
IOException
.reset
in class org.apache.hadoop.hbase.filter.FilterBase
@Deprecated public Filter.ReturnCode filterKeyValue(Cell c)
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.
Concrete implementers can signal a failure condition in their code by throwing an
IOException
.filterKeyValue
in class Filter
c
- the Cell in questionFilter.ReturnCode
public Filter.ReturnCode filterCell(Cell 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.
Concrete implementers can signal a failure condition in their code by throwing an
IOException
.filterCell
in class Filter
v
- the Cell in questionFilter.ReturnCode
public boolean filterRowKey(Cell firstRowCell)
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 CompareFilter
firstRowCell
- The first cell coming in the new rowpublic boolean filterRow()
org.apache.hadoop.hbase.filter.FilterBase
Filter.filterCell(Cell)
can inherit this implementation that
never filters a row.
Last chance to veto row based on previous Filter.filterCell(Cell)
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).
Concrete implementers can signal a failure condition in their code by throwing an
IOException
.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()
public boolean equals(Object obj)
equals
in class CompareFilter
public int hashCode()
hashCode
in class CompareFilter
Copyright © 2007–2020 The Apache Software Foundation. All rights reserved.