Constructor Detail

• FilterListWithAND

  public FilterListWithAND(List<Filter> filters)

Method Detail

• addFilterLists

  public void addFilterLists(List<Filter> filters)

  Specified by:

  addFilterLists in class FilterListBase

• formatLogFilters

  protected String formatLogFilters(List<Filter> logFilters)

  Specified by:

  formatLogFilters in class FilterListBase

• filterKeyValue

  public Filter.ReturnCode filterKeyValue(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, 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:

  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:

  Filter.ReturnCode

• 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.

• filterRowKey

  public boolean filterRowKey(byte[] rowKey,
                     int offset,
                     int length)
                       throws IOException

  Description copied from class: 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 FilterBase

  Parameters:

  rowKey - 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).

  Throws:

  IOException - in case an I/O or an filter specific failure needs to be signaled.

• 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.

• filterRow

  public boolean filterRow()
                    throws IOException

  Description copied from class: FilterBase
  Filters that never filter by rows based on previously gathered state from Filter.filterKeyValue(Cell) can inherit this implementation that never filters a row. Last chance to veto row based on previous Filter.filterKeyValue(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.

• getNextCellHint

  public Cell getNextCellHint(Cell currentCell)
                       throws IOException

  Description copied from class: 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 FilterBase

  Returns:

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

  Throws:

  IOException - in case an I/O or an filter specific failure needs to be signaled.

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object