@InterfaceAudience.Public @InterfaceStability.Stable public class QualifierFilter extends CompareFilter
This filter can be wrapped with WhileMatchFilter
and SkipFilter
to add more control.
Multiple filters can be combined using FilterList
.
If an already known column qualifier is looked for, use
Get.addColumn(byte[], byte[])
directly rather than a filter.
CompareFilter.CompareOp
Filter.ReturnCode
comparator, compareOp
Constructor and Description |
---|
QualifierFilter(CompareFilter.CompareOp op,
ByteArrayComparable qualifierComparator)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
(package private) boolean |
areSerializedFieldsEqual(Filter o)
Default implementation so that writers of custom filters aren't forced to implement.
|
static Filter |
createFilterFromArguments(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 QualifierFilter |
parseFrom(byte[] pbBytes) |
byte[] |
toByteArray()
Return length 0 byte array for Filters that don't require special serialization
|
convert, doCompare, extractArguments, getComparator, getOperator, toString, transformCell
filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, reset, transform
isReversed, setReversed
public QualifierFilter(CompareFilter.CompareOp op, ByteArrayComparable qualifierComparator)
op
- the compare op for column qualifier matchingqualifierComparator
- the comparator for column qualifier 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(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
FilterBase
toByteArray
in class FilterBase
public static QualifierFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes
- A pb serialized QualifierFilter
instanceQualifierFilter
made from bytes
DeserializationException
toByteArray()
boolean areSerializedFieldsEqual(Filter o)
FilterBase
areSerializedFieldsEqual
in class CompareFilter
other
- Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.