org.apache.hadoop.hbase.filter

类 FilterWrapper

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterWrapper

@InterfaceAudience.Private
public final class FilterWrapper
extends 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().

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	FilterWrapper.FilterRowRetCode

从类继承的嵌套类/接口 org.apache.hadoop.hbase.filter.Filter

Filter.ReturnCode

字段概要

从类继承的字段 org.apache.hadoop.hbase.filter.Filter

reversed

构造器概要

构造器

构造器和说明
FilterWrapper(Filter filter)

方法概要

限定符和类型	方法和说明
boolean	filterAllRemaining()
Filter.ReturnCode	filterCell(Cell c)
Filter.ReturnCode	filterKeyValue(Cell c) 已过时。
boolean	filterRow()
void	filterRowCells(List<Cell> kvs)
FilterWrapper.FilterRowRetCode	filterRowCellsWithRet(List<Cell> kvs)
boolean	filterRowKey(byte[] buffer, int offset, int length)
boolean	filterRowKey(Cell cell)
Cell	getNextCellHint(Cell currentCell)
boolean	hasFilterRow()
boolean	isFamilyEssential(byte[] name)
static FilterWrapper	parseFrom(byte[] pbBytes)
void	reset()
byte[]	toByteArray()
Cell	transformCell(Cell v)

从类继承的方法 org.apache.hadoop.hbase.filter.Filter

isReversed, setReversed

从类继承的方法 java.lang.Object

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

构造器详细资料

FilterWrapper

public FilterWrapper(Filter filter)

方法详细资料

toByteArray

public byte[] toByteArray()
                   throws IOException

指定者:

toByteArray 在类中 Filter

返回:

The filter serialized using pb

抛出:

IOException

parseFrom

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

参数:

pbBytes - A pb serialized FilterWrapper instance

返回:

An instance of FilterWrapper made from bytes

抛出:

DeserializationException

另请参阅:

toByteArray()

reset

public void reset()
           throws IOException

指定者:

reset 在类中 Filter

抛出:

IOException

filterAllRemaining

public boolean filterAllRemaining()
                           throws IOException

指定者:

filterAllRemaining 在类中 Filter

抛出:

IOException

filterRow

public boolean filterRow()
                  throws IOException

指定者:

filterRow 在类中 Filter

抛出:

IOException

getNextCellHint

public Cell getNextCellHint(Cell currentCell)
                     throws IOException

指定者:

getNextCellHint 在类中 Filter

抛出:

IOException

filterRowKey

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

指定者:

filterRowKey 在类中 Filter

抛出:

IOException

filterRowKey

public boolean filterRowKey(Cell cell)
                     throws IOException

指定者:

filterRowKey 在类中 Filter

抛出:

IOException

filterKeyValue

@Deprecated
public Filter.ReturnCode filterKeyValue(Cell c)
                                             throws IOException

已过时。

覆盖:

filterKeyValue 在类中 Filter

抛出:

IOException

filterCell

public Filter.ReturnCode filterCell(Cell c)
                             throws IOException

覆盖:

filterCell 在类中 Filter

抛出:

IOException

transformCell

public Cell transformCell(Cell v)
                   throws IOException

指定者:

transformCell 在类中 Filter

抛出:

IOException

hasFilterRow

public boolean hasFilterRow()

指定者:

hasFilterRow 在类中 Filter

filterRowCells

public void filterRowCells(List<Cell> kvs)
                    throws IOException

指定者:

filterRowCells 在类中 Filter

抛出:

IOException

filterRowCellsWithRet

public FilterWrapper.FilterRowRetCode filterRowCellsWithRet(List<Cell> kvs)
                                                     throws IOException

抛出:

IOException

isFamilyEssential

public boolean isFamilyEssential(byte[] name)
                          throws IOException

指定者:

isFamilyEssential 在类中 Filter

抛出:

IOException