org.apache.hadoop.hbase.filter

类 FilterBase

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

直接已知子类:

ColumnCountGetFilter, ColumnPaginationFilter, ColumnPrefixFilter, ColumnRangeFilter, CompareFilter, FilterListBase, FirstKeyOnlyFilter, FuzzyRowFilter, InclusiveStopFilter, KeyOnlyFilter, MultipleColumnPrefixFilter, MultiRowRangeFilter, PageFilter, PrefixFilter, RandomRowFilter, SingleColumnValueFilter, SkipFilter, TimestampsFilter, WhileMatchFilter

@InterfaceAudience.Private
public abstract class FilterBase
extends Filter

Abstract base class to help you implement new Filters. Common "ignore" or NOOP type methods can go here, helping to reduce boiler plate in an ever-expanding filter library. If you could instantiate FilterBase, it would end up being a "null" filter - that is one that never filters anything.

嵌套类概要

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

Filter.ReturnCode

字段概要

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

reversed

构造器概要

构造器

构造器和说明
FilterBase()

方法概要

方法

限定符和类型	方法和说明
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments) Given the filter's arguments it constructs the filter
boolean	filterAllRemaining() Filters that never filter all remaining can inherit this implementation that never stops the filter early.
boolean	filterRow() Filters that never filter by rows based on previously gathered state from Filter.filterKeyValue(Cell) can inherit this implementation that never filters a row.
void	filterRowCells(List<Cell> ignored) Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.
boolean	filterRowKey(byte[] buffer, int offset, int length) Filters that do not filter by row key can inherit this implementation that never filters anything.
Cell	getNextCellHint(Cell currentKV) Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell.
KeyValue	getNextKeyHint(KeyValue currentKV) 已过时。
boolean	hasFilterRow() Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.
boolean	isFamilyEssential(byte[] name) By default, we require all scan's column families to be present.
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.
KeyValue	transform(KeyValue currentKV) 已过时。
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.Filter

filterKeyValue, isReversed, parseFrom, setReversed

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

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

构造器详细资料

FilterBase

public FilterBase()

方法详细资料

reset

public void reset()
           throws IOException

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 在类中 Filter

抛出:

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

filterRowKey

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

Filters that do not filter by row key can inherit this implementation that never filters anything. (ie: returns false). 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.filterKeyValue(Cell) below. Concrete implementers can signal a failure condition in their code by throwing an IOException.

指定者:

filterRowKey 在类中 Filter

参数:

buffer - buffer containing row key

offset - offset into buffer where row key starts

length - length of the row key

返回:

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

抛出:

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

filterAllRemaining

public boolean filterAllRemaining()
                           throws IOException

Filters that never filter all remaining can inherit this implementation that never stops the filter early. If this returns true, the scan will terminate. Concrete implementers can signal a failure condition in their code by throwing an IOException.

指定者:

filterAllRemaining 在类中 Filter

返回:

true to end scan, false to continue.

抛出:

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

transformCell

public Cell transformCell(Cell v)
                   throws IOException

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 在类中 Filter

参数:

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}.

transform

@Deprecated
public KeyValue transform(KeyValue currentKV)
                   throws IOException

已过时。

WARNING: please to not override this method. Instead override transformCell(Cell). This is for transition from 0.94 -> 0.96

指定者:

transform 在类中 Filter

抛出:

IOException

filterRowCells

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

Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. Chance to alter the list of Cells to be submitted. Modifications to the list will carry on Concrete implementers can signal a failure condition in their code by throwing an IOException.

指定者:

filterRowCells 在类中 Filter

参数:

ignored - the list of Cells to be filtered

抛出:

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

hasFilterRow

public boolean hasFilterRow()

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 在类中 Filter

返回:

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

filterRow

public boolean filterRow()
                  throws IOException

Filters that never filter by rows based on previously gathered state from Filter.filterKeyValue(Cell) can inherit this implementation that never filters a row. Last chance to veto row based on previous Filter.filterKeyValue(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 在类中 Filter

返回:

true to exclude row, false to include row.

抛出:

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

getNextKeyHint

@Deprecated
public KeyValue getNextKeyHint(KeyValue currentKV)
                        throws IOException

已过时。

This method is deprecated and you should override Cell getNextKeyHint(Cell) instead.

指定者:

getNextKeyHint 在类中 Filter

返回:

KeyValue which must be next seeked. return null if the filter is not sure which key to seek to next.

抛出:

IOException - Function is Deprecated. Use Filter.getNextCellHint(Cell) instead.

getNextCellHint

public Cell getNextCellHint(Cell currentKV)
                     throws IOException

Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell. If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the QueryMatcher would call this function to find out which key it must next seek to. Concrete implementers can signal a failure condition in their code by throwing an IOException.

指定者:

getNextCellHint 在类中 Filter

返回:

KeyValue which must be next seeked. return null if the filter is not sure which key to seek to next.

抛出:

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

isFamilyEssential

public boolean isFamilyEssential(byte[] name)
                          throws IOException

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 在类中 Filter

抛出:

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

createFilterFromArguments

public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)

Given the filter's arguments it constructs the filter

参数:

filterArguments - the filter's arguments

返回:

constructed filter object

toString

public String toString()

Return filter's info for debugging and logging purpose.

覆盖:

toString 在类中 Object

toByteArray

public byte[] toByteArray()
                   throws IOException

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

指定者:

toByteArray 在类中 Filter

返回:

The filter serialized using pb

抛出:

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