org.apache.hadoop.hbase.filter

Class SingleColumnValueFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.SingleColumnValueFilter

Direct Known Subclasses:

SingleColumnValueExcludeFilter

@InterfaceAudience.Public
public class SingleColumnValueFilter
extends FilterBase

This filter is used to filter cells based on value. It takes a CompareFilter.CompareOp operator (equal, greater, not equal, etc), and either a byte [] value or a ByteArrayComparable.

If we have a byte [] value then we just do a lexicographic compare. For example, if passed value is 'b' and cell has 'a' and the compare operator is LESS, then we will filter out this cell (return true). If this is not sufficient (eg you want to deserialize a long and then compare it to a fixed long value), then you can pass in your own comparator instead.

You must also specify a family and qualifier. Only the value of this column will be tested. When using this filter on a CellScanner with specified inputs, the column to be tested should also be added as input (otherwise the filter will regard the column as missing).

To prevent the entire row from being emitted if the column is not found on a row, use setFilterIfMissing(boolean). Otherwise, if the column is found, the entire row will be emitted only if the value passes. If the value fails, the row will be filtered out.

In order to test values of previous versions (timestamps), set setLatestVersionOnly(boolean) to false. The default is true, meaning that only the latest version's value is tested and all previous versions are ignored.

To filter based on the value of all scanned columns, use ValueFilter.

Nested Class Summary

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

Filter.ReturnCode

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	columnFamily
protected byte[]	columnQualifier
protected ByteArrayComparable	comparator
protected boolean	filterIfMissing
protected boolean	foundColumn
protected boolean	latestVersionOnly
protected boolean	matchedColumn
protected CompareOperator	op

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

reversed

Constructor Summary

Constructors

Modifier	Constructor and Description
	SingleColumnValueFilter(byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, byte[] value) Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use SingleColumnValueFilter(byte[], byte[], CompareOperator, byte[]) instead.
	SingleColumnValueFilter(byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, ByteArrayComparable comparator) Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable) instead.
protected	SingleColumnValueFilter(byte[] family, byte[] qualifier, CompareFilter.CompareOp compareOp, ByteArrayComparable comparator, boolean filterIfMissing, boolean latestVersionOnly) Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable, boolean, boolean) instead.
	SingleColumnValueFilter(byte[] family, byte[] qualifier, CompareOperator op, byte[] value) Constructor for binary compare of the value of a single column.
	SingleColumnValueFilter(byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator) Constructor for binary compare of the value of a single column.
protected	SingleColumnValueFilter(byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, boolean filterIfMissing, boolean latestVersionOnly) Constructor for protobuf deserialization only.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	areSerializedFieldsEqual(Filter o) Default implementation so that writers of custom filters aren't forced to implement.
(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos.SingleColumnValueFilter	convert()
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.
private boolean	filterColumnValue(Cell cell)
Filter.ReturnCode	filterKeyValue(Cell c) Deprecated.
boolean	filterRow() Filters that never filter by rows based on previously gathered state from Filter.filterCell(Cell) can inherit this implementation that never filters a row.
boolean	filterRowKey(Cell cell) Filters a row based on the row key.
ByteArrayComparable	getComparator()
CompareOperator	getCompareOperator()
byte[]	getFamily()
boolean	getFilterIfMissing() Get whether entire row should be filtered if column is not found.
boolean	getLatestVersionOnly() Get whether only the latest version of the column value should be compared.
CompareFilter.CompareOp	getOperator() Deprecated. since 2.0.0. Will be removed in 3.0.0. Use getCompareOperator() instead.
byte[]	getQualifier()
boolean	hasFilterRow() Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.
int	hashCode()
boolean	isFamilyEssential(byte[] name) The only CF this filter needs is given column family.
static SingleColumnValueFilter	parseFrom(byte[] pbBytes)
void	reset() Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.
void	setFilterIfMissing(boolean filterIfMissing) Set whether entire row should be filtered if column is not found.
void	setLatestVersionOnly(boolean latestVersionOnly) Set whether only the latest version of the column value should be compared.
byte[]	toByteArray() Return length 0 byte array for Filters that don't require special serialization
String	toString() Return filter's info for debugging and logging purpose.

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

filterAllRemaining, filterRowCells, filterRowKey, getNextCellHint, 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

Field Detail

columnFamily

protected byte[] columnFamily

columnQualifier

protected byte[] columnQualifier

op

protected CompareOperator op

comparator

protected ByteArrayComparable comparator

foundColumn

protected boolean foundColumn

matchedColumn

protected boolean matchedColumn

filterIfMissing

protected boolean filterIfMissing

latestVersionOnly

protected boolean latestVersionOnly

Constructor Detail

SingleColumnValueFilter

@Deprecated
public SingleColumnValueFilter(byte[] family,
                                           byte[] qualifier,
                                           CompareFilter.CompareOp compareOp,
                                           byte[] value)

Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use SingleColumnValueFilter(byte[], byte[], CompareOperator, byte[]) instead.

Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted.

Use the filterIfColumnMissing flag to set whether the rest of the columns in a row will be emitted if the specified column to check is not found in the row.

Parameters:

family - name of column family

qualifier - name of column qualifier

compareOp - operator

value - value to compare column values against

SingleColumnValueFilter

public SingleColumnValueFilter(byte[] family,
                               byte[] qualifier,
                               CompareOperator op,
                               byte[] value)

Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted.

Use the filterIfColumnMissing flag to set whether the rest of the columns in a row will be emitted if the specified column to check is not found in the row.

Parameters:

family - name of column family

qualifier - name of column qualifier

op - operator

value - value to compare column values against

SingleColumnValueFilter

@Deprecated
public SingleColumnValueFilter(byte[] family,
                                           byte[] qualifier,
                                           CompareFilter.CompareOp compareOp,
                                           ByteArrayComparable comparator)

Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable) instead.

Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted.

Use the filterIfColumnMissing flag to set whether the rest of the columns in a row will be emitted if the specified column to check is not found in the row.

Parameters:

family - name of column family

qualifier - name of column qualifier

compareOp - operator

comparator - Comparator to use.

SingleColumnValueFilter

public SingleColumnValueFilter(byte[] family,
                               byte[] qualifier,
                               CompareOperator op,
                               ByteArrayComparable comparator)

Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted.

Use the filterIfColumnMissing flag to set whether the rest of the columns in a row will be emitted if the specified column to check is not found in the row.

Parameters:

family - name of column family

qualifier - name of column qualifier

op - operator

comparator - Comparator to use.

SingleColumnValueFilter

@Deprecated
protected SingleColumnValueFilter(byte[] family,
                                              byte[] qualifier,
                                              CompareFilter.CompareOp compareOp,
                                              ByteArrayComparable comparator,
                                              boolean filterIfMissing,
                                              boolean latestVersionOnly)

Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use SingleColumnValueFilter(byte[], byte[], CompareOperator, ByteArrayComparable, boolean, boolean) instead.

Constructor for protobuf deserialization only.

Parameters:

family -

qualifier -

compareOp -

comparator -

filterIfMissing -

latestVersionOnly -

SingleColumnValueFilter

protected SingleColumnValueFilter(byte[] family,
                                  byte[] qualifier,
                                  CompareOperator op,
                                  ByteArrayComparable comparator,
                                  boolean filterIfMissing,
                                  boolean latestVersionOnly)

Constructor for protobuf deserialization only.

Parameters:

family -

qualifier -

op -

comparator -

filterIfMissing -

latestVersionOnly -

Method Detail

getOperator

@Deprecated
public CompareFilter.CompareOp getOperator()

Deprecated. since 2.0.0. Will be removed in 3.0.0. Use getCompareOperator() instead.

Returns:

operator

getCompareOperator

public CompareOperator getCompareOperator()

getComparator

public ByteArrayComparable getComparator()

Returns:

the comparator

getFamily

public byte[] getFamily()

Returns:

the family

getQualifier

public byte[] getQualifier()

Returns:

the qualifier

filterRowKey

public boolean filterRowKey(Cell cell)
                     throws IOException

Description copied from class: Filter

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.filterCell(Cell) below. If Filter.filterAllRemaining() returns true, then Filter.filterRowKey(Cell) should also return true. Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

filterRowKey in class FilterBase

Parameters:

cell - The first cell coming in the new row

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.

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

filterColumnValue

private boolean filterColumnValue(Cell cell)

filterRow

public boolean filterRow()

Description copied from class: FilterBase

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

hasFilterRow

public boolean hasFilterRow()

Description copied from class: FilterBase

Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time).

Overrides:

hasFilterRow in class FilterBase

Returns:

True if this filter actively uses filterRowCells(List) or filterRow().

reset

public void reset()

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

getFilterIfMissing

public boolean getFilterIfMissing()

Get whether entire row should be filtered if column is not found.

Returns:

true if row should be skipped if column not found, false if row should be let through anyways

setFilterIfMissing

public void setFilterIfMissing(boolean filterIfMissing)

Set whether entire row should be filtered if column is not found.

If true, the entire row will be skipped if the column is not found.

If false, the row will pass if the column is not found. This is default.

Parameters:

filterIfMissing - flag

getLatestVersionOnly

public boolean getLatestVersionOnly()

Get whether only the latest version of the column value should be compared. If true, the row will be returned if only the latest version of the column value matches. If false, the row will be returned if any version of the column value matches. The default is true.

Returns:

return value

setLatestVersionOnly

public void setLatestVersionOnly(boolean latestVersionOnly)

Set whether only the latest version of the column value should be compared. If true, the row will be returned if only the latest version of the column value matches. If false, the row will be returned if any version of the column value matches. The default is true.

Parameters:

latestVersionOnly - flag

createFilterFromArguments

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

convert

org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos.SingleColumnValueFilter convert()

toByteArray

public byte[] toByteArray()

Description copied from class: FilterBase

Return length 0 byte array for Filters that don't require special serialization

Overrides:

toByteArray in class FilterBase

Returns:

The filter serialized using pb

parseFrom

public static SingleColumnValueFilter parseFrom(byte[] pbBytes)
                                         throws DeserializationException

Parameters:

pbBytes - A pb serialized SingleColumnValueFilter instance

Returns:

An instance of SingleColumnValueFilter made from bytes

Throws:

DeserializationException

See Also:

toByteArray()

areSerializedFieldsEqual

boolean areSerializedFieldsEqual(Filter o)

Description copied from class: FilterBase

Default implementation so that writers of custom filters aren't forced to implement.

Overrides:

areSerializedFieldsEqual in class FilterBase

Returns:

true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.

isFamilyEssential

public boolean isFamilyEssential(byte[] name)

The only CF this filter needs is given column family. So, it's the only essential column in whole scan. If filterIfMissing == false, all families are essential, because of possibility of skipping the rows without any data in filtered CF.

Overrides:

isFamilyEssential in class FilterBase

toString

public String toString()

Description copied from class: FilterBase

Return filter's info for debugging and logging purpose.

Overrides:

toString in class FilterBase

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object