@InterfaceAudience.Public @InterfaceStability.Stable public class FamilyFilter extends CompareFilter
This filter is used to filter based on the column family. It takes an operator (equal, greater, not equal, etc) and a byte [] comparator for the column family portion of a key.
This filter can be wrapped with WhileMatchFilter and SkipFilter
to add more control.
Multiple filters can be combined using FilterList.
Get.addFamily(byte[])
directly rather than a filter.CompareFilter.CompareOpFilter.ReturnCodecomparator, compareOp| Constructor and Description |
|---|
FamilyFilter(CompareFilter.CompareOp familyCompareOp,
ByteArrayComparable familyComparator)
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 FamilyFilter |
parseFrom(byte[] pbBytes) |
byte[] |
toByteArray()
Return length 0 byte array for Filters that don't require special serialization
|
convert, doCompare, extractArguments, getComparator, getOperator, toString, transformCellfilterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, reset, transformisReversed, setReversedpublic FamilyFilter(CompareFilter.CompareOp familyCompareOp, ByteArrayComparable familyComparator)
familyCompareOp - the compare op for column family matchingfamilyComparator - the comparator for column family matchingpublic Filter.ReturnCode filterKeyValue(Cell v)
FilterReturnCode.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 Filterv - the Cell in questionFilter.ReturnCodepublic static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
FilterBasetoByteArray in class FilterBasepublic static FamilyFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes - A pb serialized FamilyFilter instanceFamilyFilter made from bytesDeserializationExceptiontoByteArray()boolean areSerializedFieldsEqual(Filter o)
FilterBaseareSerializedFieldsEqual in class CompareFilterother - Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.