org.hbase.async

Class ColumnPaginationFilter

java.lang.Object

org.hbase.async.ScanFilter

org.hbase.async.ColumnPaginationFilter

public final class ColumnPaginationFilter
extends ScanFilter

A filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset. This filter can be used for row-based indexing, where references to other tables are stored across many columns, in order to efficient lookups and paginated results for end users. Only most recent versions are considered for pagination.

Field Summary

Fields

Modifier and Type	Field and Description
static int	kColumnPaginationFilter

Constructor Summary

Constructors

Constructor and Description
ColumnPaginationFilter(int limit, byte[] columnOffset) Initializes filter with a string/bookmark based offset and limit.
ColumnPaginationFilter(int limit, int offset) Initializes filter with an integer offset and limit.
ColumnPaginationFilter(int limit, String columnOffset)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getId()
protected com.google.protobuf.ByteString	getState()
String	toString()

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

kColumnPaginationFilter

public static final int kColumnPaginationFilter

See Also:

Constant Field Values

Constructor Detail

ColumnPaginationFilter

public ColumnPaginationFilter(int limit,
                      int offset)

Initializes filter with an integer offset and limit. The offset is arrived at scanning sequentially and skipping entries. @limit number of columns are then retrieved. If multiple column families are involved, the columns may be spread across them.

Parameters:

limit - Max number of columns to return.

offset - The integer offset where to start pagination.

ColumnPaginationFilter

public ColumnPaginationFilter(int limit,
                      byte[] columnOffset)

Initializes filter with a string/bookmark based offset and limit. The offset is arrived at, by seeking to it using scanner hints. If multiple column families are involved, pagination starts at the first column family which contains @columnOffset. Columns are then retrieved sequentially upto @limit number of columns which maybe spread across multiple column families, depending on how the scan is setup. Only supported with HBase 0.96 and greater.

Parameters:

limit - Max number of columns to return.

columnOffset - The string/bookmark offset on where to start pagination.

ColumnPaginationFilter

public ColumnPaginationFilter(int limit,
                      String columnOffset)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getState

protected com.google.protobuf.ByteString getState()

Specified by:

getState in class ScanFilter

getId

protected String getId()

Specified by:

getId in class ScanFilter