Constructor Detail

• MultiRowRangeFilter

  public MultiRowRangeFilter(List<MultiRowRangeFilter.RowRange> list)
                      throws IOException

  Parameters:

  list - A list of RowRange

  Throws:

  IOException - throw an exception if the range list is not in an natural order or any RowRange is invalid

Method Detail

• filterAllRemaining

  public boolean filterAllRemaining()

  Description copied from class: org.apache.hadoop.hbase.filter.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 org.apache.hadoop.hbase.filter.FilterBase

  Returns:

  true to end scan, false to continue.

• getRowRanges

  public List<MultiRowRangeFilter.RowRange> getRowRanges()

• filterRowKey

  public boolean filterRowKey(byte[] buffer,
                     int offset,
                     int length)

  Description copied from class: org.apache.hadoop.hbase.filter.FilterBase
  Filters that do not filter by row key can inherit this implementation that never filters anything. (ie: returns false). 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.filterKeyValue(Cell) below. Concrete implementers can signal a failure condition in their code by throwing an IOException.

  Overrides:

  filterRowKey in class org.apache.hadoop.hbase.filter.FilterBase

  Parameters:

  buffer - buffer containing row key

  offset - offset into buffer where row key starts

  length - length of the row key

  Returns:

  true, remove entire row, false, include the row (maybe).

• filterKeyValue

  public Filter.ReturnCode filterKeyValue(Cell ignored)

  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, filterKeyValue needs to be consistent with it. filterKeyValue 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.

  Specified by:

  filterKeyValue in class Filter

  Parameters:

  ignored - the Cell in question

  Returns:

  code as described below

  See Also:

  Filter.ReturnCode

• getNextCellHint

  public Cell getNextCellHint(Cell currentKV)

  Description copied from class: org.apache.hadoop.hbase.filter.FilterBase
  Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell. If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the QueryMatcher would call this function to find out which key it must next seek to. Concrete implementers can signal a failure condition in their code by throwing an IOException.

  Overrides:

  getNextCellHint in class org.apache.hadoop.hbase.filter.FilterBase

  Returns:

  KeyValue which must be next seeked. return null if the filter is not sure which key to seek to next.

• toByteArray

  public byte[] toByteArray()

  Description copied from class: org.apache.hadoop.hbase.filter.FilterBase
  Return length 0 byte array for Filters that don't require special serialization

  Overrides:

  toByteArray in class org.apache.hadoop.hbase.filter.FilterBase

  Returns:

  The filter serialized using pb

• parseFrom

  public static MultiRowRangeFilter parseFrom(byte[] pbBytes)
                                       throws org.apache.hadoop.hbase.exceptions.DeserializationException

  Parameters:

  pbBytes - A pb serialized instance

  Returns:

  An instance of MultiRowRangeFilter

  Throws:

  org.apache.hadoop.hbase.exceptions.DeserializationException

• sortAndMerge

  public static List<MultiRowRangeFilter.RowRange> sortAndMerge(List<MultiRowRangeFilter.RowRange> ranges)

  sort the ranges and if the ranges with overlap, then merge them.

  Parameters:

  ranges - the list of ranges to sort and merge.

  Returns:

  the ranges after sort and merge.