org.apache.hadoop.hbase.filter
Class FamilyFilter
java.lang.Object
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.CompareFilter
org.apache.hadoop.hbase.filter.FamilyFilter
- All Implemented Interfaces:
- Filter, org.apache.hadoop.io.Writable
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.
If an already known column family is looked for, use Get.addFamily(byte[])
directly rather than a filter.
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FamilyFilter
public FamilyFilter()
- Writable constructor, do not use.
FamilyFilter
public FamilyFilter(CompareFilter.CompareOp familyCompareOp,
WritableByteArrayComparable familyComparator)
- Constructor.
- Parameters:
familyCompareOp - the compare op for column family matchingfamilyComparator - the comparator for column family matching
filterKeyValue
public Filter.ReturnCode filterKeyValue(KeyValue v)
- Description copied from class:
FilterBase
- Filters that dont filter by key value can inherit this implementation that
includes all KeyValues.
- Specified by:
filterKeyValue in interface Filter- Overrides:
filterKeyValue in class FilterBase
- Parameters:
v - the KeyValue in question
- Returns:
- code as described below
- See Also:
Filter.ReturnCode
createFilterFromArguments
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
Copyright © 2011 The Apache Software Foundation. All Rights Reserved.