org.apache.hadoop.hbase.filter

Class FilterWrapper

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterWrapper

@InterfaceAudience.Private
public final class FilterWrapper
extends org.apache.hadoop.hbase.filter.Filter

This is a Filter wrapper class which is used in the server side. Some filter related hooks can be defined in this wrapper. The only way to create a FilterWrapper instance is passing a client side Filter instance through Scan.getFilter().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterWrapper.FilterRowRetCode

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.Filter.ReturnCode

Field Summary

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

reversed

Constructor Summary

Constructors

Constructor and Description
FilterWrapper(org.apache.hadoop.hbase.filter.Filter filter)

Method Summary

Modifier and Type	Method and Description
boolean	filterAllRemaining()
org.apache.hadoop.hbase.filter.Filter.ReturnCode	filterCell(org.apache.hadoop.hbase.Cell c)
org.apache.hadoop.hbase.filter.Filter.ReturnCode	filterKeyValue(org.apache.hadoop.hbase.Cell c) Deprecated.
boolean	filterRow()
void	filterRowCells(List<org.apache.hadoop.hbase.Cell> kvs)
FilterWrapper.FilterRowRetCode	filterRowCellsWithRet(List<org.apache.hadoop.hbase.Cell> kvs)
boolean	filterRowKey(byte[] buffer, int offset, int length)
boolean	filterRowKey(org.apache.hadoop.hbase.Cell cell)
org.apache.hadoop.hbase.Cell	getNextCellHint(org.apache.hadoop.hbase.Cell currentCell)
boolean	hasFilterRow()
boolean	isFamilyEssential(byte[] name)
static FilterWrapper	parseFrom(byte[] pbBytes)
void	reset()
byte[]	toByteArray()
org.apache.hadoop.hbase.Cell	transformCell(org.apache.hadoop.hbase.Cell v)

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

isReversed, setReversed

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterWrapper

public FilterWrapper(org.apache.hadoop.hbase.filter.Filter filter)

Method Detail

toByteArray

public byte[] toByteArray()
                   throws IOException

Specified by:

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

Returns:

The filter serialized using pb

Throws:

IOException

parseFrom

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

Parameters:

pbBytes - A pb serialized FilterWrapper instance

Returns:

An instance of FilterWrapper made from bytes

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException

See Also:

toByteArray()

reset

public void reset()
           throws IOException

Specified by:

reset in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

filterAllRemaining

public boolean filterAllRemaining()
                           throws IOException

Specified by:

filterAllRemaining in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

filterRow

public boolean filterRow()
                  throws IOException

Specified by:

filterRow in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

getNextCellHint

public org.apache.hadoop.hbase.Cell getNextCellHint(org.apache.hadoop.hbase.Cell currentCell)
                                             throws IOException

Specified by:

getNextCellHint in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

filterRowKey

public boolean filterRowKey(byte[] buffer,
                            int offset,
                            int length)
                     throws IOException

Specified by:

filterRowKey in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

filterRowKey

public boolean filterRowKey(org.apache.hadoop.hbase.Cell cell)
                     throws IOException

Specified by:

filterRowKey in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

filterKeyValue

@Deprecated
public org.apache.hadoop.hbase.filter.Filter.ReturnCode filterKeyValue(org.apache.hadoop.hbase.Cell c)
                                                                            throws IOException

Deprecated.

Overrides:

filterKeyValue in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

filterCell

public org.apache.hadoop.hbase.filter.Filter.ReturnCode filterCell(org.apache.hadoop.hbase.Cell c)
                                                            throws IOException

Overrides:

filterCell in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

transformCell

public org.apache.hadoop.hbase.Cell transformCell(org.apache.hadoop.hbase.Cell v)
                                           throws IOException

Specified by:

transformCell in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

hasFilterRow

public boolean hasFilterRow()

Specified by:

hasFilterRow in class org.apache.hadoop.hbase.filter.Filter

filterRowCells

public void filterRowCells(List<org.apache.hadoop.hbase.Cell> kvs)
                    throws IOException

Specified by:

filterRowCells in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException

filterRowCellsWithRet

public FilterWrapper.FilterRowRetCode filterRowCellsWithRet(List<org.apache.hadoop.hbase.Cell> kvs)
                                                     throws IOException

Throws:

IOException

isFamilyEssential

public boolean isFamilyEssential(byte[] name)
                          throws IOException

Specified by:

isFamilyEssential in class org.apache.hadoop.hbase.filter.Filter

Throws:

IOException