Package org.apache.hadoop.hbase.filter

Class FamilyFilter

java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.CompareFilter
org.apache.hadoop.hbase.filter.FamilyFilter
@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.

If an already known column family is looked for, use Get.addFamily(byte[]) directly rather than a filter.

  • Constructor Details

  • Method Details

    • filterCell

      public Filter.ReturnCode filterCell(Cell c)
      Description copied from class: Filter
      A way to filter based on the column family, column qualifier and/or the column value. Return code is described below. This allows filters to filter only certain number of columns, then terminate without matching ever column. If filterRowKey returns true, filterCell needs to be consistent with it. filterCell can assume that filterRowKey has already been called for the row. If your filter returns 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.
      Overrides:
      filterCell in class Filter
      Parameters:
      c - the Cell in question
      Returns:
      code as described below
      See Also:

    • createFilterFromArguments

      public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)

    • toByteArray

      public byte[] toByteArray()
      Returns The filter serialized using pb
      Overrides:
      toByteArray in class FilterBase
      Returns:
      The filter serialized using pb

    • parseFrom

      public static FamilyFilter parseFrom(byte[] pbBytes) throws DeserializationException
      Parse the serialized representation of FamilyFilter
      Parameters:
      pbBytes - A pb serialized FamilyFilter instance
      Returns:
      An instance of FamilyFilter made from bytes
      Throws:
      DeserializationException - if an error occurred
      See Also:

    • areSerializedFieldsEqual

      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. Used for testing.
      Overrides:
      areSerializedFieldsEqual in class CompareFilter
      Returns:
      true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class CompareFilter

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class CompareFilter