Class DependentColumnFilter

src/DependentColumnFilter.java:43–215

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

 * @since 1.6
 */
public final class DependentColumnFilter extends CompareFilter {

  private static final byte[] NAME =
      Bytes.UTF8("org.apache.hadoop.hbase.filter.DependentColumnFilter");

  private final byte[] family;
  private final byte[] qualifier;
  private final boolean drop_dependent_column;

  /**
   * Creates a DependentColumnFilter with the provided dependent column,
   * additional value filter, and specification of whether the dependent
   * column should be included in the results.
   *
   * @param family of dependent column.
   * @param qualifier of dependent column.
   * @param drop_dependent_column whether to include or exclude the dependent
   *            column in the results.
   * @param value_compare_op of dependent-column value filter.
   * @param value_comparator of dependent-column value filter.
   */
  public DependentColumnFilter(final byte[] family,
                               final byte[] qualifier,
                               final boolean drop_dependent_column,
                               final CompareOp value_compare_op,
                               final FilterComparator value_comparator) {
    super(value_compare_op, value_comparator);
    this.family = family;
    this.qualifier = qualifier;
    this.drop_dependent_column = drop_dependent_column;
  }

  /**
   * Creates a DependentColumnFilter with the provided dependent column, and
   * specify whether the dependent column should be included in the results.
   *
   * @param family of dependent column.
   * @param qualifier of dependent column.
   * @param drop_dependent_column whether to include or exclude the dependent
   *            column in the results.
   */
  public DependentColumnFilter(final byte[] family,
                               final byte[] qualifier,
                               final boolean drop_dependent_column) {
    this(family, qualifier, drop_dependent_column, CompareOp.NO_OP, NO_COMPARATOR);
  }

  /**
   * Creates a DependentColumnFilter with the provided dependent column, and
   * dependent-column value comparison filter.
   *
   * @param family of dependent column.
   * @param qualifier of dependent column.
   * @param value_compare_op of value filter.
   * @param value_comparator of value filter.
   */
  public DependentColumnFilter(final byte[] family,
                               final byte[] qualifier,