@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.CompareOp
Filter.ReturnCode
comparator, compareOp
Constructor and Description |
---|
FamilyFilter(CompareFilter.CompareOp familyCompareOp,
ByteArrayComparable familyComparator)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments) |
boolean |
equals(Object obj) |
Filter.ReturnCode |
filterKeyValue(Cell v)
A way to filter based on the column family, column qualifier and/or the column value.
|
int |
hashCode() |
static FamilyFilter |
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 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)
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 FamilyFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes
- A pb serialized FamilyFilter
instanceFamilyFilter
made from bytes
DeserializationException
toByteArray()
public boolean equals(Object obj)
equals
in class CompareFilter
public int hashCode()
hashCode
in class CompareFilter
Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.