@InterfaceAudience.Public 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.Filter.ReturnCode
comparator, op
Constructor and Description |
---|
FamilyFilter(CompareOperator op,
ByteArrayComparable familyComparator)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
(package private) boolean |
areSerializedFieldsEqual(Filter o)
Returns true if and only if the fields of the filter that are serialized are equal to the
corresponding fields in other.
|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments) |
boolean |
equals(Object obj) |
Filter.ReturnCode |
filterCell(Cell c)
A way to filter based on the column family, column qualifier and/or the column value.
|
int |
hashCode() |
static FamilyFilter |
parseFrom(byte[] pbBytes)
Parse the serialized representation of
FamilyFilter |
byte[] |
toByteArray()
Returns The filter serialized using pb
|
compare, compareFamily, compareQualifier, compareRow, compareValue, convert, extractArguments, filterRowKey, getComparator, getCompareOperator, toString
filterAllRemaining, filterRow, filterRowCells, getNextCellHint, hasFilterRow, isFamilyEssential, reset, transformCell
isReversed, setReversed
public FamilyFilter(CompareOperator op, ByteArrayComparable familyComparator)
op
- the compare op for column family matchingfamilyComparator
- the comparator for column family matchingpublic Filter.ReturnCode filterCell(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
.filterCell
in class Filter
c
- the Cell in questionFilter.ReturnCode
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
toByteArray
in class FilterBase
public static FamilyFilter parseFrom(byte[] pbBytes) throws DeserializationException
FamilyFilter
pbBytes
- A pb serialized FamilyFilter
instanceFamilyFilter
made from bytes
DeserializationException
- if an error occurredtoByteArray()
boolean areSerializedFieldsEqual(Filter o)
areSerializedFieldsEqual
in class CompareFilter
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.