Package org.apache.hadoop.hbase.filter

Provides row-level filters applied to HRegion scan results during calls to ResultScanner.next().

See:
Description

Interface Summary

Filter	Interface for row and column filters directly applied within the regionserver.
RowFilterInterface	Deprecated. Use filters that are rooted on @{link Filter} instead
WritableByteArrayComparable	Interface for both Comparable and Writable.

Class Summary

BinaryComparator	A binary comparator which lexicographically compares against the specified byte array using Bytes.compareTo(byte[], byte[]).
ColumnCountGetFilter	Simple filter that returns first N columns on row only.
ColumnValueFilter	Deprecated. Use filters that are rooted on @{link Filter} instead.
CompareFilter	This is a generic filter to be used to filter by comparison.
FilterList	Implementation of Filter that represents an ordered List of Filters which will be evaluated with a specified boolean operator FilterList.Operator.MUST_PASS_ALL (!AND) or FilterList.Operator.MUST_PASS_ONE (!OR).
FirstKeyOnlyFilter	A filter that will only return the first KV from each row.
InclusiveStopFilter	A Filter that stops after the given row.
InclusiveStopRowFilter	Deprecated. Use filters that are rooted on @{link Filter} instead
PageFilter	Implementation of Filter interface that limits results to a specific page size.
PageRowFilter	Deprecated. Use filters that are rooted on @{link Filter} instead
PrefixFilter	Pass results that have same row prefix.
PrefixRowFilter	Deprecated. Use filters that are rooted on @{link Filter} instead
QualifierFilter	This filter is used to filter based on the column qualifier.
RegExpRowFilter	Deprecated. This interface doesn't work well in new KeyValue world.
RegexStringComparator	This comparator is for use with CompareFilter implementations, such as RowFilter, QualifierFilter, and ValueFilter, for filtering based on the value of a given column.
RowFilter	This filter is used to filter based on the key.
RowFilterSet	Deprecated. Use filters that are rooted on @{link Filter} instead
SingleColumnValueFilter	This filter is used to filter cells based on value.
SkipFilter	A wrapper filter that filters an entire row if any of the KeyValue checks do not pass.
StopRowFilter	Deprecated. Use filters that are rooted on @{link Filter} instead
SubstringComparator	This comparator is for use with ColumnValueFilter, for filtering based on the value of a given column.
ValueFilter	This filter is used to filter based on column value.
WhileMatchFilter	A wrapper filter that filters everything after the first filtered row.
WhileMatchRowFilter	Deprecated. Use filters that are rooted on @{link Filter} instead

Enum Summary

ColumnValueFilter.CompareOp	Comparison operators.
CompareFilter.CompareOp	Comparison operators.
Filter.ReturnCode	Return codes for filterValue().
FilterList.Operator	set operator
RowFilterSet.Operator	set operator

Exception Summary

InvalidRowFilterException

Used to indicate an invalid RowFilter.

Package org.apache.hadoop.hbase.filter Description

Provides row-level filters applied to HRegion scan results during calls to ResultScanner.next().

Since HBase 0.20.0, Filter is the new Interface used filtering. It replaces the deprecated RowFilterInterface. Filters run the extent of a table unless you wrap your filter in a WhileMatchFilter. The latter returns as soon as the filter stops matching.

Do not rely on filters carrying state across rows; its not reliable in current hbase as we have no handlers in place for when regions split, close or server crashes.