org.apache.hadoop.hbase.filter

Class SubstringComparator

java.lang.Object

org.apache.hadoop.hbase.filter.ByteArrayComparable

org.apache.hadoop.hbase.filter.SubstringComparator

All Implemented Interfaces:

Comparable<byte[]>

@InterfaceAudience.Public
public class SubstringComparator
extends org.apache.hadoop.hbase.filter.ByteArrayComparable

This comparator is for use with SingleColumnValueFilter, for filtering based on the value of a given column. Use it to test if a given substring appears in a cell value in the column. The comparison is case insensitive.

Only EQUAL or NOT_EQUAL tests are valid with this comparator.

For example:

 SingleColumnValueFilter scvf =
   new SingleColumnValueFilter("col", CompareOp.EQUAL,
     new SubstringComparator("substr"));
 

Constructor Summary

Constructors

Constructor and Description
SubstringComparator(String substr) Constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(byte[] value, int offset, int length)
byte[]	getValue()
static SubstringComparator	parseFrom(byte[] pbBytes)
byte[]	toByteArray()

Methods inherited from class org.apache.hadoop.hbase.filter.ByteArrayComparable

compareTo, compareTo

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstringComparator

public SubstringComparator(String substr)

Constructor

Parameters:

substr - the substring

Method Detail

getValue

public byte[] getValue()

Overrides:

getValue in class org.apache.hadoop.hbase.filter.ByteArrayComparable

compareTo

public int compareTo(byte[] value,
                     int offset,
                     int length)

Specified by:

compareTo in class org.apache.hadoop.hbase.filter.ByteArrayComparable

toByteArray

public byte[] toByteArray()

Specified by:

toByteArray in class org.apache.hadoop.hbase.filter.ByteArrayComparable

Returns:

The comparator serialized using pb

parseFrom

public static SubstringComparator parseFrom(byte[] pbBytes)
                                     throws org.apache.hadoop.hbase.exceptions.DeserializationException

Parameters:

pbBytes - A pb serialized SubstringComparator instance

Returns:

An instance of SubstringComparator made from bytes

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException

See Also:

toByteArray()