@InterfaceAudience.Public @InterfaceStability.Stable public class ValueFilter extends CompareFilter
This filter can be wrapped with WhileMatchFilter
and SkipFilter
to add more control.
Multiple filters can be combined using FilterList
.
To test the value of a single qualifier when scanning multiple qualifiers,
use SingleColumnValueFilter
.
CompareFilter.CompareOp
Filter.ReturnCode
comparator, compareOp
Constructor and Description |
---|
ValueFilter(CompareFilter.CompareOp valueCompareOp,
ByteArrayComparable valueComparator)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(java.util.ArrayList<byte[]> filterArguments) |
Filter.ReturnCode |
filterKeyValue(Cell v)
A way to filter based on the column family, column qualifier and/or the column value.
|
static ValueFilter |
parseFrom(byte[] pbBytes) |
byte[] |
toByteArray()
Return length 0 byte array for Filters that don't require special serialization
|
doCompare, extractArguments, getComparator, getOperator, toString, transformCell
filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, reset, transform
isReversed, setReversed
public ValueFilter(CompareFilter.CompareOp valueCompareOp, ByteArrayComparable valueComparator)
valueCompareOp
- the compare op for value matchingvalueComparator
- the comparator for value matchingpublic Filter.ReturnCode filterKeyValue(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
.filterKeyValue
in class Filter
v
- the Cell in questionFilter.ReturnCode
public static Filter createFilterFromArguments(java.util.ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
FilterBase
toByteArray
in class FilterBase
public static ValueFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes
- A pb serialized ValueFilter
instanceValueFilter
made from bytes
DeserializationException
toByteArray()