org.apache.hadoop.hbase.filter

类 SkipFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.SkipFilter

@InterfaceAudience.Public
public class SkipFilter
extends FilterBase

A wrapper filter that filters an entire row if any of the Cell checks do not pass.

For example, if all columns in a row represent weights of different things, with the values being the actual weights, and we want to filter out the entire row if any of its weights are zero. In this case, we want to prevent rows from being emitted if a single key is filtered. Combine this filter with a ValueFilter:

scan.setFilter(new SkipFilter(new ValueFilter(CompareOp.NOT_EQUAL, new BinaryComparator(Bytes.toBytes(0)))); Any row which contained a column whose value was 0 will be filtered out (since ValueFilter will not pass that Cell). Without this filter, the other non-zero valued columns in the row would still be emitted.

嵌套类概要

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

Filter.ReturnCode

字段概要

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

reversed

构造器概要

构造器

构造器和说明
SkipFilter(Filter filter)

方法概要

限定符和类型	方法和说明
boolean	equals(Object obj)
Filter.ReturnCode	filterCell(Cell c) A way to filter based on the column family, column qualifier and/or the column value.
Filter.ReturnCode	filterKeyValue(Cell c) 已过时。
boolean	filterRow() Filters that never filter by rows based on previously gathered state from Filter.filterCell(Cell) can inherit this implementation that never filters a row.
boolean	filterRowKey(Cell cell) Filters a row based on the row key.
Filter	getFilter()
boolean	hasFilterRow() Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.
int	hashCode()
boolean	isFamilyEssential(byte[] name) By default, we require all scan's column families to be present.
static SkipFilter	parseFrom(byte[] pbBytes)
void	reset() Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.
byte[]	toByteArray() Return length 0 byte array for Filters that don't require special serialization
String	toString() Return filter's info for debugging and logging purpose.
Cell	transformCell(Cell v) By default no transformation takes place Give the filter a chance to transform the passed KeyValue.

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

createFilterFromArguments, filterAllRemaining, filterRowCells, filterRowKey, getNextCellHint

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

isReversed, setReversed

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

SkipFilter

public SkipFilter(Filter filter)

方法详细资料

getFilter

public Filter getFilter()

reset

public void reset()
           throws IOException

从类复制的说明: FilterBase

Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. Reset the state of the filter between rows. Concrete implementers can signal a failure condition in their code by throwing an IOException.

覆盖:

reset 在类中 FilterBase

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

filterRowKey

public boolean filterRowKey(Cell cell)
                     throws IOException

从类复制的说明: Filter

Filters a row based on the row key. If this returns true, the entire row will be excluded. If false, each KeyValue in the row will be passed to Filter.filterCell(Cell) below. If Filter.filterAllRemaining() returns true, then Filter.filterRowKey(Cell) should also return true. Concrete implementers can signal a failure condition in their code by throwing an IOException.

覆盖:

filterRowKey 在类中 FilterBase

参数:

cell - The first cell coming in the new row

返回:

true, remove entire row, false, include the row (maybe).

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

filterKeyValue

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

已过时。

从类复制的说明: Filter

A way to filter based on the column family, column qualifier and/or the column value. Return code is described below. This allows filters to filter only certain number of columns, then terminate without matching ever column. If filterRowKey returns true, filterKeyValue needs to be consistent with it. filterKeyValue can assume that filterRowKey has already been called for the row. If your filter returns ReturnCode.NEXT_ROW, it should return ReturnCode.NEXT_ROW until Filter.reset() is called just in case the caller calls for the next row. Concrete implementers can signal a failure condition in their code by throwing an IOException.

覆盖:

filterKeyValue 在类中 Filter

参数:

c - the Cell in question

返回:

code as described below, Filter.ReturnCode.INCLUDE by default

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

另请参阅:

Filter.ReturnCode

filterCell

public Filter.ReturnCode filterCell(Cell c)
                             throws IOException

从类复制的说明: Filter

A way to filter based on the column family, column qualifier and/or the column value. Return code is described below. This allows filters to filter only certain number of columns, then terminate without matching ever column. If filterRowKey returns true, filterCell needs to be consistent with it. filterCell can assume that filterRowKey has already been called for the row. If your filter returns ReturnCode.NEXT_ROW, it should return ReturnCode.NEXT_ROW until Filter.reset() is called just in case the caller calls for the next row. Concrete implementers can signal a failure condition in their code by throwing an IOException.

覆盖:

filterCell 在类中 Filter

参数:

c - the Cell in question

返回:

code as described below

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

另请参阅:

Filter.ReturnCode

transformCell

public Cell transformCell(Cell v)
                   throws IOException

从类复制的说明: FilterBase

By default no transformation takes place Give the filter a chance to transform the passed KeyValue. If the Cell is changed a new Cell object must be returned.

覆盖:

transformCell 在类中 FilterBase

参数:

v - the KeyValue in question

返回:

the changed KeyValue

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

另请参阅:

The transformed KeyValue is what is eventually returned to the client. Most filters will return the passed KeyValue unchanged., for an example of a transformation. Concrete implementers can signal a failure condition in their code by throwing an {@link IOException}.

filterRow

public boolean filterRow()

从类复制的说明: FilterBase

Filters that never filter by rows based on previously gathered state from Filter.filterCell(Cell) can inherit this implementation that never filters a row. Last chance to veto row based on previous Filter.filterCell(Cell) calls. The filter needs to retain state then return a particular value for this call if they wish to exclude a row if a certain column is missing (for example). Concrete implementers can signal a failure condition in their code by throwing an IOException.

覆盖:

filterRow 在类中 FilterBase

返回:

true to exclude row, false to include row.

hasFilterRow

public boolean hasFilterRow()

从类复制的说明: FilterBase

Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time).

覆盖:

hasFilterRow 在类中 FilterBase

返回:

True if this filter actively uses filterRowCells(List) or filterRow().

toByteArray

public byte[] toByteArray()
                   throws IOException

从类复制的说明: FilterBase

Return length 0 byte array for Filters that don't require special serialization

覆盖:

toByteArray 在类中 FilterBase

返回:

The filter serialized using pb

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

parseFrom

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

参数:

pbBytes - A pb serialized SkipFilter instance

返回:

An instance of SkipFilter made from bytes

抛出:

DeserializationException

另请参阅:

toByteArray()

isFamilyEssential

public boolean isFamilyEssential(byte[] name)
                          throws IOException

从类复制的说明: FilterBase

By default, we require all scan's column families to be present. Our subclasses may be more precise. Check that given column family is essential for filter to check row. Most filters always return true here. But some could have more sophisticated logic which could significantly reduce scanning process by not even touching columns until we are 100% sure that it's data is needed in result. Concrete implementers can signal a failure condition in their code by throwing an IOException.

覆盖:

isFamilyEssential 在类中 FilterBase

抛出:

IOException - in case an I/O or an filter specific failure needs to be signaled.

toString

public String toString()

从类复制的说明: FilterBase

Return filter's info for debugging and logging purpose.

覆盖:

toString 在类中 FilterBase

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object