org.apache.hadoop.hbase.filter

Class FilterWrapper

java.lang.Object

Filter

org.apache.hadoop.hbase.filter.FilterWrapper

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 org.apache.hadoop.hbase.client.Scan#getFilter().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FilterWrapper.FilterRowRetCode

Constructor Summary

Constructors

Constructor and Description
FilterWrapper(Filter filter)

Method Summary

Modifier and Type	Method and Description
boolean	filterAllRemaining()
ReturnCode	filterCell(Cell c)
ReturnCode	filterKeyValue(Cell c) Deprecated.
boolean	filterRow()
void	filterRowCells(java.util.List<Cell> kvs)
FilterWrapper.FilterRowRetCode	filterRowCellsWithRet(java.util.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)

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterWrapper

public FilterWrapper(Filter filter)

Method Detail

toByteArray

public byte[] toByteArray()
                   throws java.io.IOException

Returns:

The filter serialized using pb

Throws:

java.io.IOException

parseFrom

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

Parameters:

pbBytes - A pb serialized FilterWrapper instance

Returns:

An instance of FilterWrapper made from bytes

Throws:

org.apache.hadoop.hbase.exceptions.DeserializationException

DeserializationException

See Also:

toByteArray()

reset

public void reset()
           throws java.io.IOException

Throws:

java.io.IOException

filterAllRemaining

public boolean filterAllRemaining()
                           throws java.io.IOException

Throws:

java.io.IOException

filterRow

public boolean filterRow()
                  throws java.io.IOException

Throws:

java.io.IOException

getNextCellHint

public Cell getNextCellHint(Cell currentCell)
                     throws java.io.IOException

Throws:

java.io.IOException

filterRowKey

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

Throws:

java.io.IOException

filterRowKey

public boolean filterRowKey(Cell cell)
                     throws java.io.IOException

Throws:

java.io.IOException

filterKeyValue

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

Deprecated.

Throws:

java.io.IOException

filterCell

public ReturnCode filterCell(Cell c)
                      throws java.io.IOException

Throws:

java.io.IOException

transformCell

public Cell transformCell(Cell v)
                   throws java.io.IOException

Throws:

java.io.IOException

hasFilterRow

public boolean hasFilterRow()

filterRowCells

public void filterRowCells(java.util.List<Cell> kvs)
                    throws java.io.IOException

Throws:

java.io.IOException

filterRowCellsWithRet

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

Throws:

java.io.IOException

isFamilyEssential

public boolean isFamilyEssential(byte[] name)
                          throws java.io.IOException

Throws:

java.io.IOException