org.hbase.async

Class ColumnPrefixFilter

java.lang.Object

org.hbase.async.ScanFilter

org.hbase.async.ColumnPrefixFilter

public final class ColumnPrefixFilter
extends ScanFilter

Sets a binary prefix to filter results based on the column qualifier.

Efficiently compares the column qualifier bytes up to the length of the prefix to see if it matches.

Only setting this filter will return all rows that match the criteria but at the same will cost a full table scan.

Since:

1.5

Constructor Summary

Constructors

Constructor and Description
ColumnPrefixFilter(byte[] prefix) Constructor.
ColumnPrefixFilter(String prefix) Constructor for a UTF-8 prefix string.

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

Constructor Detail

ColumnPrefixFilter

public ColumnPrefixFilter(String prefix)

Constructor for a UTF-8 prefix string.

ColumnPrefixFilter

public ColumnPrefixFilter(byte[] prefix)

Constructor.

Throws:

IllegalArgumentException - if the prefix is an empty byte array.

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