Package 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[]>

@Public
public class SubstringComparator
extends 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"));
 

Field Summary

Fields

Modifier and Type	Field	Description
private String	substr

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

value

Constructor Summary

Constructors

Constructor	Description
SubstringComparator(String substr)	Constructor

Method Summary

Modifier and Type	Method	Description
(package private) boolean	areSerializedFieldsEqual(ByteArrayComparable other)	Returns true if and only if the fields of the comparator that are serialized are equal to the corresponding fields in other.
int	compareTo(byte[] value, int offset, int length)	Special compareTo method for subclasses, to avoid copying byte[] unnecessarily.
byte[]	getValue()
static SubstringComparator	parseFrom(byte[] pbBytes)	Parse a serialized representation of SubstringComparator
byte[]	toByteArray()	Returns The comparator serialized using pb

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

Field Details

substr

private String substr

Constructor Details

SubstringComparator

public SubstringComparator(String substr)

Constructor

Parameters:

substr - the substring

Method Details

getValue

public byte[] getValue()

Overrides:

getValue in class ByteArrayComparable

compareTo

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

Description copied from class: ByteArrayComparable

Special compareTo method for subclasses, to avoid copying byte[] unnecessarily.

Specified by:

compareTo in class ByteArrayComparable

Parameters:

value - byte[] to compare

offset - offset into value

length - number of bytes to compare

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

toByteArray

public byte[] toByteArray()

Returns The comparator serialized using pb

Specified by:

toByteArray in class ByteArrayComparable

parseFrom

public static SubstringComparator parseFrom(byte[] pbBytes)
                                     throws DeserializationException

Parse a serialized representation of SubstringComparator

Parameters:

pbBytes - A pb serialized SubstringComparator instance

Returns:

An instance of SubstringComparator made from bytes

Throws:

DeserializationException - if an error occurred

See Also:

• toByteArray()

areSerializedFieldsEqual

boolean areSerializedFieldsEqual(ByteArrayComparable other)

Returns true if and only if the fields of the comparator that are serialized are equal to the corresponding fields in other. Used for testing.

Overrides:

areSerializedFieldsEqual in class ByteArrayComparable