Package org.apache.hadoop.hbase.filter

Class RegexStringComparator

java.lang.Object

org.apache.hadoop.hbase.filter.ByteArrayComparable

org.apache.hadoop.hbase.filter.RegexStringComparator

All Implemented Interfaces:

Comparable<byte[]>

@Public
public class RegexStringComparator
extends ByteArrayComparable

This comparator is for use with CompareFilter implementations, such as RowFilter, QualifierFilter, and ValueFilter, for filtering based on the value of a given column. Use it to test if a given regular expression matches a cell value in the column.

Only EQUAL or NOT_EQUAL comparisons are valid with this comparator.

For example:

 ValueFilter vf = new ValueFilter(CompareOp.EQUAL, new RegexStringComparator(
   // v4 IP address
   "(((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}"
     + "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))(\\/[0-9]+)?" + "|" +
     // v6 IP address
     "((([\\dA-Fa-f]{1,4}:){7}[\\dA-Fa-f]{1,4})(:([\\d]{1,3}.)"
     + "{3}[\\d]{1,3})?)(\\/[0-9]+)?"));
 

Supports Pattern flags as well:

 ValueFilter vf = new ValueFilter(CompareOp.EQUAL,
   new RegexStringComparator("regex", Pattern.CASE_INSENSITIVE | Pattern.DOTALL));
 

See Also:

• Pattern

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	RegexStringComparator.Engine	This is an internal interface for abstracting access to different regular expression matching engines.
static enum	RegexStringComparator.EngineType	Engine implementation type (default=JAVA)
(package private) static class	RegexStringComparator.JavaRegexEngine	Implementation of the Engine interface using Java's Pattern.
(package private) static class	RegexStringComparator.JoniRegexEngine	Implementation of the Engine interface using Jruby's joni regex engine.

Field Summary

Fields

Modifier and Type	Field	Description
private RegexStringComparator.Engine	engine
private static final org.slf4j.Logger	LOG

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

value

Constructor Summary

Constructors

Constructor	Description
RegexStringComparator(String expr)	Constructor Adds Pattern.DOTALL to the underlying Pattern
RegexStringComparator(String expr, int flags)	Constructor
RegexStringComparator(String expr, int flags, RegexStringComparator.EngineType engine)	Constructor
RegexStringComparator(String expr, RegexStringComparator.EngineType engine)	Constructor Adds Pattern.DOTALL to the underlying Pattern

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.
(package private) RegexStringComparator.Engine	getEngine()
static RegexStringComparator	parseFrom(byte[] pbBytes)	Parse a serialized representation of RegexStringComparator
void	setCharset(Charset charset)	Specifies the Charset to use to convert the row key to a String.
byte[]	toByteArray()	Returns The comparator serialized using pb

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

compareTo, compareTo, getValue

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

engine

private RegexStringComparator.Engine engine

Constructor Details

RegexStringComparator

public RegexStringComparator(String expr)

Constructor Adds Pattern.DOTALL to the underlying Pattern

Parameters:

expr - a valid regular expression

RegexStringComparator

public RegexStringComparator(String expr,
 RegexStringComparator.EngineType engine)

Constructor Adds Pattern.DOTALL to the underlying Pattern

Parameters:

expr - a valid regular expression

engine - engine implementation type

RegexStringComparator

public RegexStringComparator(String expr,
 int flags)

Constructor

Parameters:

expr - a valid regular expression

flags - java.util.regex.Pattern flags

RegexStringComparator

public RegexStringComparator(String expr,
 int flags,
 RegexStringComparator.EngineType engine)

Constructor

Parameters:

expr - a valid regular expression

flags - java.util.regex.Pattern flags

engine - engine implementation type

Method Details

setCharset

public void setCharset(Charset charset)

Specifies the Charset to use to convert the row key to a String.

The row key needs to be converted to a String in order to be matched against the regular expression. This method controls which charset is used to do this conversion.

If the row key is made of arbitrary bytes, the charset ISO-8859-1 is recommended.

Parameters:

charset - The charset to use.

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 RegexStringComparator parseFrom(byte[] pbBytes)
                                       throws DeserializationException

Parse a serialized representation of RegexStringComparator

Parameters:

pbBytes - A pb serialized RegexStringComparator instance

Returns:

An instance of RegexStringComparator 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

getEngine

RegexStringComparator.Engine getEngine()