org.apache.hadoop.hbase.filter
Class SubstringComparator

java.lang.Object
  extended by org.apache.hadoop.hbase.filter.ByteArrayComparable
      extended by org.apache.hadoop.hbase.filter.SubstringComparator
All Implemented Interfaces:
Comparable<byte[]>

@InterfaceAudience.Public
@InterfaceStability.Stable
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"));
 


Constructor Summary
SubstringComparator(String substr)
          Constructor
 
Method Summary
 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)
           
 byte[] toByteArray()
           
 
Methods inherited from class org.apache.hadoop.hbase.filter.ByteArrayComparable
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 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()
Specified by:
toByteArray in class ByteArrayComparable
Returns:
The comparator serialized using pb

parseFrom

public static SubstringComparator parseFrom(byte[] pbBytes)
                                     throws DeserializationException
Parameters:
pbBytes - A pb serialized SubstringComparator instance
Returns:
An instance of SubstringComparator made from bytes
Throws:
DeserializationException
See Also:
toByteArray()


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.