org.apache.hadoop.hbase.filter

Class DependentColumnFilter

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

@InterfaceAudience.Public
public class DependentColumnFilter
extends CompareFilter

A filter for adding inter-column timestamp matching Only cells with a correspondingly timestamped entry in the target column will be retained Not compatible with Scan.setBatch as operations need full rows for correct filtering

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

Modifier and Type	Field and Description
protected byte[]	columnFamily
protected byte[]	columnQualifier
protected boolean	dropDependentColumn
protected Set<Long>	stampSet

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
DependentColumnFilter(byte[] family, byte[] qualifier) Constructor for DependentColumn filter.
DependentColumnFilter(byte[] family, byte[] qualifier, boolean dropDependentColumn) Constructor for DependentColumn filter.
DependentColumnFilter(byte[] family, byte[] qualifier, boolean dropDependentColumn, CompareFilter.CompareOp valueCompareOp, ByteArrayComparable valueComparator) Deprecated. Since 2.0.0. Will be removed in 3.0.0. Use DependentColumnFilter(byte[], byte[], boolean, CompareOperator, ByteArrayComparable) instead.
DependentColumnFilter(byte[] family, byte[] qualifier, boolean dropDependentColumn, CompareOperator op, ByteArrayComparable valueComparator) Build a dependent column filter with value checking dependent column varies will be compared using the supplied compareOp and comparator, for usage of which refer to CompareFilter

Method Summary

Modifier and Type	Method and Description
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
boolean	dropDependentColumn() Returns true if we should drop the dependent column, false otherwise
boolean	equals(Object obj)
boolean	filterAllRemaining() Filters that never filter all remaining can inherit this implementation that never stops the filter early.
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.
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.
void	filterRowCells(List<Cell> kvs) Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.
boolean	filterRowKey(byte[] buffer, int offset, int length) Filters that do not filter by row key can inherit this implementation that never filters anything.
boolean	getDropDependentColumn()
byte[]	getFamily() Returns the column family
byte[]	getQualifier() Returns the column qualifier
boolean	hasFilterRow() Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.
int	hashCode()
static DependentColumnFilter	parseFrom(byte[] pbBytes) Parse a seralized representation of DependentColumnFilter
void	reset() Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.
byte[]	toByteArray() Returns The filter serialized using pb
String	toString() Return filter's info for debugging and logging purpose.

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

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

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

getNextCellHint, isFamilyEssential, 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

dropDependentColumn

protected boolean dropDependentColumn

stampSet

protected Set<Long> stampSet

Constructor Detail

DependentColumnFilter

@Deprecated
public DependentColumnFilter(byte[] family,
                                         byte[] qualifier,
                                         boolean dropDependentColumn,
                                         CompareFilter.CompareOp valueCompareOp,
                                         ByteArrayComparable valueComparator)

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

Build a dependent column filter with value checking dependent column varies will be compared using the supplied compareOp and comparator, for usage of which refer to CompareFilter

Parameters:

family - dependent column family

qualifier - dependent column qualifier

dropDependentColumn - whether the column should be discarded after

valueCompareOp - comparison op

valueComparator - comparator

DependentColumnFilter

public DependentColumnFilter(byte[] family,
                             byte[] qualifier,
                             boolean dropDependentColumn,
                             CompareOperator op,
                             ByteArrayComparable valueComparator)

Build a dependent column filter with value checking dependent column varies will be compared using the supplied compareOp and comparator, for usage of which refer to CompareFilter

Parameters:

family - dependent column family

qualifier - dependent column qualifier

dropDependentColumn - whether the column should be discarded after

op - Value comparison op

valueComparator - comparator

DependentColumnFilter

public DependentColumnFilter(byte[] family,
                             byte[] qualifier)

Constructor for DependentColumn filter. Cells where a Cell from target column with the same timestamp do not exist will be dropped.

Parameters:

family - name of target column family

qualifier - name of column qualifier

DependentColumnFilter

public DependentColumnFilter(byte[] family,
                             byte[] qualifier,
                             boolean dropDependentColumn)

Constructor for DependentColumn filter. Cells where a Cell from target column with the same timestamp do not exist will be dropped.

Parameters:

family - name of dependent column family

qualifier - name of dependent qualifier

dropDependentColumn - whether the dependent columns Cells should be discarded

Method Detail

getFamily

public byte[] getFamily()

Returns the column family

getQualifier

public byte[] getQualifier()

Returns the column qualifier

dropDependentColumn

public boolean dropDependentColumn()

Returns true if we should drop the dependent column, false otherwise

getDropDependentColumn

public boolean getDropDependentColumn()

filterAllRemaining

public boolean filterAllRemaining()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Filters that never filter all remaining can inherit this implementation that never stops the filter early. If this returns true, the scan will terminate. Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

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

Returns:

true to end scan, false to continue.

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

filterRowCells

public void filterRowCells(List<Cell> kvs)

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. Chance to alter the list of Cells to be submitted. Modifications to the list will carry on Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

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

Parameters:

kvs - the list of Cells to be filtered

hasFilterRow

public boolean hasFilterRow()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Filters 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 org.apache.hadoop.hbase.filter.FilterBase

Returns:

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

filterRow

public boolean filterRow()

Description copied from class: org.apache.hadoop.hbase.filter.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 org.apache.hadoop.hbase.filter.FilterBase

Returns:

true to exclude row, false to include row.

filterRowKey

public boolean filterRowKey(byte[] buffer,
                            int offset,
                            int length)

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Filters that do not filter by row key can inherit this implementation that never filters anything. (ie: returns false). 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. Concrete implementers can signal a failure condition in their code by throwing an IOException.

Overrides:

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

Parameters:

buffer - buffer containing row key

offset - offset into buffer where row key starts

length - length of the row key

Returns:

true, remove entire row, false, include the row (maybe).

reset

public void reset()

Description copied from class: org.apache.hadoop.hbase.filter.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 org.apache.hadoop.hbase.filter.FilterBase

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 DependentColumnFilter parseFrom(byte[] pbBytes)
                                       throws org.apache.hadoop.hbase.exceptions.DeserializationException

Parse a seralized representation of DependentColumnFilter

Parameters:

pbBytes - A pb serialized DependentColumnFilter instance

Returns:

An instance of DependentColumnFilter made from bytes

Throws:

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

See Also:

toByteArray()

toString

public String toString()

Description copied from class: org.apache.hadoop.hbase.filter.FilterBase

Return filter's info for debugging and logging purpose.

Overrides:

toString in class CompareFilter

equals

public boolean equals(Object obj)

Overrides:

equals in class CompareFilter

hashCode

public int hashCode()

Overrides:

hashCode in class CompareFilter