org.apache.hadoop.hbase.filter

Class FirstKeyValueMatchingQualifiersFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.FirstKeyOnlyFilter

org.apache.hadoop.hbase.filter.FirstKeyValueMatchingQualifiersFilter

Deprecated.

Deprecated in 2.0.0 and will be removed in 3.0.0.

@InterfaceAudience.Public
 @Deprecated
public class FirstKeyValueMatchingQualifiersFilter
extends FirstKeyOnlyFilter

The filter looks for the given columns in KeyValue. Once there is a match for any one of the columns, it returns ReturnCode.NEXT_ROW for remaining KeyValues in the row.

Note : It may emit KVs which do not have the given columns in them, if these KVs happen to occur before a KV which does have a match. Given this caveat, this filter is only useful for special cases like org.apache.hadoop.hbase.mapreduce.RowCounter.

See Also:

HBASE-13347

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
FirstKeyValueMatchingQualifiersFilter(Set<byte[]> qualifiers) Deprecated. Constructor which takes a set of columns.

Method Summary

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

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

createFilterFromArguments, filterRowKey, hasFoundKV, reset, setFoundKV

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

filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, toString, 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

FirstKeyValueMatchingQualifiersFilter

public FirstKeyValueMatchingQualifiersFilter(Set<byte[]> qualifiers)

Deprecated.

Constructor which takes a set of columns. As soon as first KeyValue matching any of these columns is found, filter moves to next row.

Parameters:

qualifiers - the set of columns to me matched.

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 FirstKeyOnlyFilter

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)

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, 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 FirstKeyOnlyFilter

Parameters:

c - the Cell in question

Returns:

code as described below

See Also:

Filter.ReturnCode

toByteArray

public byte[] toByteArray()

Deprecated.

Returns The filter serialized using pb

Overrides:

toByteArray in class FirstKeyOnlyFilter

Returns:

The filter serialized using pb

parseFrom

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

Deprecated.

Parses a serialized representation of FirstKeyValueMatchingQualifiersFilter

Parameters:

pbBytes - A pb serialized FirstKeyValueMatchingQualifiersFilter instance

Returns:

An instance of FirstKeyValueMatchingQualifiersFilter made from bytes

Throws:

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

See Also:

toByteArray()

equals

public boolean equals(Object obj)

Deprecated.

Overrides:

equals in class FirstKeyOnlyFilter

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class FirstKeyOnlyFilter