Class ColumnRangeFilter

src/ColumnRangeFilter.java:39–161

Filters based on a range of column qualifiers. This filter is only compatible with HBase 0.92 and newer. @since 1.5

 * @since 1.5
 */
public final class ColumnRangeFilter extends ScanFilter {

  private static final byte[] NAME = Bytes.ISO88591("org.apache.hadoop.hbase"
      + ".filter.ColumnRangeFilter");

  private final byte[] start_column;
  private final boolean start_inclusive;
  private final byte[] stop_column;
  private final boolean stop_inclusive;

  /**
   * Constructor for UTF-8 strings.
   * Equivalent to {@link #ColumnRangeFilter(byte[], boolean, byte[], boolean)
   * ColumnRangeFilter}{@code (start_column, true, stop_inclusive, true)}
   */
  public ColumnRangeFilter(final String start_column, final String stop_column) {
    this(Bytes.UTF8(start_column), true, Bytes.UTF8(stop_column), true);
  }

  /**
   * Constructor.
   * Equivalent to {@link #ColumnRangeFilter(byte[], boolean, byte[], boolean)
   * ColumnRangeFilter}{@code (start_column, true, stop_inclusive, true)}
   */
  public ColumnRangeFilter(final byte[] start_column, final byte[] stop_column) {
    this(start_column, true, stop_column, true);
  }

  /**
   * Constructor for UTF-8 strings.
   * @param start_column The column from which to start returning values.
   * If {@code null}, start scanning from the beginning of the row.
   * @param start_inclusive If {@code true}, the start column is inclusive.
   * @param stop_column The column up to which to return values.
   * If {@code null}, continue scanning until the end of the row.
   * @param stop_inclusive If {@code true}, the stop column is inclusive.
   */
  public ColumnRangeFilter(final String start_column, final boolean start_inclusive,
                           final String stop_column, final boolean stop_inclusive) {
    this(Bytes.UTF8(start_column), start_inclusive,
         Bytes.UTF8(stop_column), stop_inclusive);
  }

  /**
   * Constructor.
   * @param start_column The column from which to start returning values.
   * If {@code null}, start scanning from the beginning of the row.
   * @param start_inclusive If {@code true}, the start column is inclusive.
   * @param stop_column The column up to which to return values.
   * If {@code null}, continue scanning until the end of the row.
   * @param stop_inclusive If {@code true}, the stop column is inclusive.
   */
  public ColumnRangeFilter(final byte[] start_column, final boolean start_inclusive,
                           final byte[] stop_column, final boolean stop_inclusive) {
    this.start_column = start_column;
    this.start_inclusive = start_inclusive;
    this.stop_column = stop_column;
    this.stop_inclusive = stop_inclusive;