Package org.apache.hadoop.hbase.filter

Class WhileMatchFilter

java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.WhileMatchFilter
@Public public class WhileMatchFilter extends FilterBase
A wrapper filter that returns true from filterAllRemaining() as soon as the wrapped filters Filter.filterRowKey(Cell), Filter.filterCell(org.apache.hadoop.hbase.Cell), Filter.filterRow() or Filter.filterAllRemaining() methods returns true.

  • Field Details

  • Constructor Details

  • Method Details

    • getFilter

      public Filter getFilter()

    • reset

      public void reset() throws IOException
      Description copied from class: FilterBase
      Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. Reset the state of the filter between rows. Concrete implementers can signal a failure condition in their code by throwing an IOException.
      Overrides:
      reset in class FilterBase
      Throws:
      IOException - in case an I/O or an filter specific failure needs to be signaled.

    • changeFAR

      private void changeFAR(boolean value)

    • filterAllRemaining

      public boolean filterAllRemaining() throws IOException
      Description copied from class: FilterBase
      Filters that never filter all remaining can inherit this implementation that never stops the filter early. If this returns true, the scan will terminate. Concrete implementers can signal a failure condition in their code by throwing an IOException.
      Overrides:
      filterAllRemaining in class FilterBase
      Returns:
      true to end scan, false to continue.
      Throws:
      IOException - in case an I/O or an filter specific failure needs to be signaled.

    • filterRowKey

      public boolean filterRowKey(Cell cell) throws IOException
      Description copied from class: Filter
      Filters a row based on the row key. If this returns true, the entire row will be excluded. If false, each KeyValue in the row will be passed to Filter.filterCell(Cell) below. If Filter.filterAllRemaining() returns true, then Filter.filterRowKey(Cell) should also return true. Concrete implementers can signal a failure condition in their code by throwing an IOException.
      Overrides:
      filterRowKey in class FilterBase
      Parameters:
      cell - The first cell coming in the new row
      Returns:
      true, remove entire row, false, include the row (maybe).
      Throws:
      IOException - in case an I/O or an filter specific failure needs to be signaled.

    • filterCell

      public Filter.ReturnCode filterCell(Cell c) throws IOException
      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
      Throws:
      IOException - in case an I/O or an filter specific failure needs to be signaled.
      See Also:

    • transformCell

      public Cell transformCell(Cell v) throws IOException
      Description copied from class: FilterBase
      By default no transformation takes place Give the filter a chance to transform the passed Cell. If the Cell is changed a new Cell object must be returned.

      NOTICE: Filter will be evaluate at server side so the returned Cell must be an ExtendedCell, although it is marked as IA.Private.

      Overrides:
      transformCell in class FilterBase
      Parameters:
      v - the Cell in question
      Returns:
      the changed Cell
      Throws:
      IOException - in case an I/O or an filter specific failure needs to be signaled.
      See Also:

    • filterRow

      public boolean filterRow() throws IOException
      Description copied from class: FilterBase
      Filters that never filter by rows based on previously gathered state from Filter.filterCell(Cell) can inherit this implementation that never filters a row. Last chance to veto row based on previous Filter.filterCell(Cell) calls. The filter needs to retain state then return a particular value for this call if they wish to exclude a row if a certain column is missing (for example). Concrete implementers can signal a failure condition in their code by throwing an IOException.
      Overrides:
      filterRow in class FilterBase
      Returns:
      true to exclude row, false to include row.
      Throws:
      IOException - in case an I/O or an filter specific failure needs to be signaled.

    • hasFilterRow

      public boolean hasFilterRow()
      Description copied from class: FilterBase
      Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time).
      Overrides:
      hasFilterRow in class FilterBase
      Returns:
      True if this filter actively uses filterRowCells(List) or filterRow().

    • toByteArray

      public byte[] toByteArray() throws IOException
      Returns The filter serialized using pb
      Overrides:
      toByteArray in class FilterBase
      Returns:
      The filter serialized using pb
      Throws:
      IOException - in case an I/O or an filter specific failure needs to be signaled.

    • parseFrom

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

    • areSerializedFieldsEqual

      boolean areSerializedFieldsEqual(Filter o)
      Return 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 FilterBase
      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.

    • isFamilyEssential

      public boolean isFamilyEssential(byte[] name) throws IOException
      Description copied from class: FilterBase
      By default, we require all scan's column families to be present. Our subclasses may be more precise. Check that given column family is essential for filter to check row. Most filters always return true here. But some could have more sophisticated logic which could significantly reduce scanning process by not even touching columns until we are 100% sure that it's data is needed in result. Concrete implementers can signal a failure condition in their code by throwing an IOException.
      Overrides:
      isFamilyEssential in class FilterBase
      Throws:
      IOException - in case an I/O or an filter specific failure needs to be signaled.

    • toString

      public String toString()
      Description copied from class: FilterBase
      Return filter's info for debugging and logging purpose.
      Overrides:
      toString in class FilterBase

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object