org.hbase.async

Class DependentColumnFilter

java.lang.Object

org.hbase.async.ScanFilter

org.hbase.async.CompareFilter

org.hbase.async.DependentColumnFilter

public final class DependentColumnFilter
extends CompareFilter

Filters key values based on the existence of a dependent, or reference, column. Column values in a row will be filtered unless the row contains a value in the dependent column with the same time stamp.

A comparison can optionally be provided to further filter based on the value of the dependent column.

Since:

1.6

Nested Class Summary

Nested classes/interfaces inherited from class org.hbase.async.CompareFilter

CompareFilter.CompareOp

Field Summary

Fields

Modifier and Type	Field and Description
static int	kDependentColumnFilter

Constructor Summary

Constructors

Constructor and Description
DependentColumnFilter(byte[] family, byte[] qualifier) Creates a DependentColumnFilter with the provided dependent column.
DependentColumnFilter(byte[] family, byte[] qualifier, boolean drop_dependent_column) Creates a DependentColumnFilter with the provided dependent column, and specify whether the dependent column should be included in the results.
DependentColumnFilter(byte[] family, byte[] qualifier, boolean drop_dependent_column, CompareFilter.CompareOp value_compare_op, FilterComparator value_comparator) Creates a DependentColumnFilter with the provided dependent column, additional value filter, and specification of whether the dependent column should be included in the results.
DependentColumnFilter(byte[] family, byte[] qualifier, CompareFilter.CompareOp value_compare_op, FilterComparator value_comparator) Creates a DependentColumnFilter with the provided dependent column, and dependent-column value comparison filter.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	dropDependentColumn() Returns whether the dependent column will be included in the results.
byte[]	family() Returns the column family of the dependent column.
protected String	getId()
com.google.protobuf.ByteString	getState()
byte[]	qualifier() Returns the qualifier of the dependent column.
String	toString()

Methods inherited from class org.hbase.async.CompareFilter

comparator, compareOperation, toFilterComparatorProto, toProtobuf

Methods inherited from class org.hbase.async.ScanFilter

getFilterId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

kDependentColumnFilter

public static final int kDependentColumnFilter

See Also:

Constant Field Values

Constructor Detail

DependentColumnFilter

public DependentColumnFilter(byte[] family,
                     byte[] qualifier,
                     boolean drop_dependent_column,
                     CompareFilter.CompareOp value_compare_op,
                     FilterComparator value_comparator)

Creates a DependentColumnFilter with the provided dependent column, additional value filter, and specification of whether the dependent column should be included in the results.

Parameters:

family - of dependent column.

qualifier - of dependent column.

drop_dependent_column - whether to include or exclude the dependent column in the results.

value_compare_op - of dependent-column value filter.

value_comparator - of dependent-column value filter.

DependentColumnFilter

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

Creates a DependentColumnFilter with the provided dependent column, and specify whether the dependent column should be included in the results.

Parameters:

family - of dependent column.

qualifier - of dependent column.

drop_dependent_column - whether to include or exclude the dependent column in the results.

DependentColumnFilter

public DependentColumnFilter(byte[] family,
                     byte[] qualifier,
                     CompareFilter.CompareOp value_compare_op,
                     FilterComparator value_comparator)

Creates a DependentColumnFilter with the provided dependent column, and dependent-column value comparison filter.

Parameters:

family - of dependent column.

qualifier - of dependent column.

value_compare_op - of value filter.

value_comparator - of value filter.

DependentColumnFilter

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

Creates a DependentColumnFilter with the provided dependent column.

Parameters:

family - of dependent column.

qualifier - of dependent column

Method Detail

family

public byte[] family()

Returns the column family of the dependent column.

Returns:

the dependent column's family.

qualifier

public byte[] qualifier()

Returns the qualifier of the dependent column.

Returns:

the dependent column's qualifier.

dropDependentColumn

public boolean dropDependentColumn()

Returns whether the dependent column will be included in the results.

toString

public String toString()

Overrides:

toString in class CompareFilter

getState

public com.google.protobuf.ByteString getState()

Specified by:

getState in class ScanFilter

getId

protected String getId()

Specified by:

getId in class ScanFilter