org.apache.hadoop.hbase.filter

类 FilterListWithOR

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.FilterListBase

org.apache.hadoop.hbase.filter.FilterListWithOR

@InterfaceAudience.Private
public class FilterListWithOR
extends FilterListBase

FilterListWithOR represents an ordered list of filters which will be evaluated with an OR operator.

嵌套类概要

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

Filter.ReturnCode

字段概要

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

filters, subFiltersIncludedCell

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

reversed

构造器概要

构造器

构造器和说明
FilterListWithOR(List<Filter> filters)

方法概要

方法

限定符和类型	方法和说明
void	addFilterLists(List<Filter> filters)
boolean	equals(Object obj)
boolean	filterAllRemaining() Filters that never filter all remaining can inherit this implementation that never stops the filter early.
Filter.ReturnCode	filterKeyValue(Cell c) A way to filter based on the column family, column qualifier and/or the column value.
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.
boolean	filterRowKey(byte[] rowKey, int offset, int length) Filters that do not filter by row key can inherit this implementation that never filters anything.
protected String	formatLogFilters(List<Filter> logFilters)
Cell	getNextCellHint(Cell currentCell) Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell.
int	hashCode()
void	reset() Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.

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

checkAndGetReversed, compareCell, filterRowCells, getFilters, hasFilterRow, isEmpty, isFamilyEssential, isInReturnCodes, setReversed, size, toString, transformCell

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

createFilterFromArguments, getNextKeyHint, toByteArray, transform

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

isReversed, parseFrom

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

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

构造器详细资料

FilterListWithOR

public FilterListWithOR(List<Filter> filters)

方法详细资料

addFilterLists

public void addFilterLists(List<Filter> filters)

指定者:

addFilterLists 在类中 FilterListBase

formatLogFilters

protected String formatLogFilters(List<Filter> logFilters)

指定者:

formatLogFilters 在类中 FilterListBase

filterKeyValue

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

抛出:

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

另请参阅:

Filter.ReturnCode

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(byte[] rowKey,
                   int offset,
                   int length)
                     throws IOException

从类复制的说明: FilterBase

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

参数:

rowKey - 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

从类复制的说明: FilterBase

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

返回:

true to end scan, false to continue.

抛出:

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

filterRow

public boolean filterRow()
                  throws IOException

从类复制的说明: FilterBase

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

返回:

true to exclude row, false to include row.

抛出:

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

getNextCellHint

public Cell getNextCellHint(Cell currentCell)
                     throws IOException

从类复制的说明: FilterBase

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

返回:

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.

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object