org.apache.hadoop.hbase.coprocessor

Class TestRegionObserverScannerOpenHook.NoDataFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.coprocessor.TestRegionObserverScannerOpenHook.NoDataFilter

Enclosing class:

TestRegionObserverScannerOpenHook

public static class TestRegionObserverScannerOpenHook.NoDataFilter
extends FilterBase

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter

Filter.ReturnCode

Field Summary

Fields inherited from class org.apache.hadoop.hbase.filter.Filter

reversed

Constructor Summary

Constructors

Constructor and Description
NoDataFilter()

Method Summary

Modifier and Type	Method and Description
boolean	filterAllRemaining() Filters that never filter all remaining can inherit this implementation that never stops the filter early.
Filter.ReturnCode	filterKeyValue(Cell ignored) A way to filter based on the column family, column qualifier and/or the column value.
boolean	filterRow() Filters that never filter by rows based on previously gathered state from Filter.filterKeyValue(Cell) can inherit this implementation that never filters a row.

Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase

createFilterFromArguments, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, reset, toByteArray, toString, transform, transformCell

Methods inherited from class org.apache.hadoop.hbase.filter.Filter

isReversed, parseFrom, setReversed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NoDataFilter

public NoDataFilter()

Method Detail

filterKeyValue

public Filter.ReturnCode filterKeyValue(Cell ignored)
                                 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:

ignored - 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

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.

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.

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.