org.apache.hadoop.hbase.filter

Class ValueFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.CompareFilter

org.apache.hadoop.hbase.filter.ValueFilter

@InterfaceAudience.Public
public class ValueFilter
extends CompareFilter

This filter is used to filter based on column value. It takes an operator (equal, greater, not equal, etc) and a byte [] comparator for the cell value.

This filter can be wrapped with WhileMatchFilter and SkipFilter to add more control.

Multiple filters can be combined using FilterList.

To test the value of a single qualifier when scanning multiple qualifiers, use SingleColumnValueFilter.

Nested Class Summary

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

CompareFilter.CompareOp

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

comparator, op

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

reversed

Constructor Summary

Constructors

Constructor and Description
ValueFilter(CompareFilter.CompareOp valueCompareOp, ByteArrayComparable valueComparator) Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use ValueFilter(CompareOperator, ByteArrayComparable)
ValueFilter(CompareOperator valueCompareOp, ByteArrayComparable valueComparator) Constructor.

Method Summary

Modifier and Type	Method and Description
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
boolean	equals(Object obj)
Filter.ReturnCode	filterCell(Cell c) A way to filter based on the column family, column qualifier and/or the column value.
Filter.ReturnCode	filterKeyValue(Cell c) Deprecated.
int	hashCode()
static ValueFilter	parseFrom(byte[] pbBytes) Parse a serialized representation of ValueFilter
byte[]	toByteArray() Returns The filter serialized using pb

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

compareFamily, compareFamily, compareQualifier, compareQualifier, compareRow, compareRow, compareValue, compareValue, extractArguments, filterRowKey, getComparator, getCompareOperator, getOperator, toString

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

filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, reset, transformCell

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

isReversed, setReversed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ValueFilter

public ValueFilter(CompareFilter.CompareOp valueCompareOp,
                   ByteArrayComparable valueComparator)

Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use ValueFilter(CompareOperator, ByteArrayComparable)

Constructor.

Parameters:

valueCompareOp - the compare op for value matching

valueComparator - the comparator for value matching

ValueFilter

public ValueFilter(CompareOperator valueCompareOp,
                   ByteArrayComparable valueComparator)

Constructor.

Parameters:

valueCompareOp - the compare op for value matching

valueComparator - the comparator for value matching

Method Detail

filterKeyValue

@Deprecated
public Filter.ReturnCode filterKeyValue(Cell c)

Deprecated.

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.

Overrides:

filterKeyValue in class Filter

Parameters:

c - the Cell in question

Returns:

code as described below, Filter.ReturnCode.INCLUDE by default

See Also:

Filter.ReturnCode

filterCell

public Filter.ReturnCode filterCell(Cell c)

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

See Also:

Filter.ReturnCode

createFilterFromArguments

public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)

toByteArray

public byte[] toByteArray()

Returns The filter serialized using pb

Overrides:

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

Returns:

The filter serialized using pb

parseFrom

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

Parse a serialized representation of ValueFilter

Parameters:

pbBytes - A pb serialized ValueFilter instance

Returns:

An instance of ValueFilter made from bytes

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException - if an error occurred

See Also:

toByteArray()

equals

public boolean equals(Object obj)

Overrides:

equals in class CompareFilter

hashCode

public int hashCode()

Overrides:

hashCode in class CompareFilter