org.apache.hadoop.hbase.filter

类 KeyOnlyFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.KeyOnlyFilter

@InterfaceAudience.Public
public class KeyOnlyFilter
extends FilterBase

A filter that will only return the key component of each KV (the value will be rewritten as empty).

This filter can be used to grab all of the keys without having to also grab the values.

嵌套类概要

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

Filter.ReturnCode

字段概要

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

reversed

构造器概要

构造器

构造器和说明
KeyOnlyFilter()
KeyOnlyFilter(boolean lenAsVal)

方法概要

限定符和类型	方法和说明
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
boolean	equals(Object obj)
Filter.ReturnCode	filterCell(Cell ignored) A way to filter based on the column family, column qualifier and/or the column value.
Filter.ReturnCode	filterKeyValue(Cell ignored) 已过时。
boolean	filterRowKey(Cell cell) Filters a row based on the row key.
int	hashCode()
static KeyOnlyFilter	parseFrom(byte[] pbBytes)
byte[]	toByteArray() Return length 0 byte array for Filters that don't require special serialization
Cell	transformCell(Cell cell) By default no transformation takes place Give the filter a chance to transform the passed KeyValue.

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

filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, reset, toString

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

isReversed, setReversed

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

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

构造器详细资料

KeyOnlyFilter

public KeyOnlyFilter()

KeyOnlyFilter

public KeyOnlyFilter(boolean lenAsVal)

方法详细资料

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.

transformCell

public Cell transformCell(Cell cell)

从类复制的说明: 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

参数:

cell - the KeyValue in question

返回:

the changed KeyValue

另请参阅:

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

filterKeyValue

@Deprecated
public Filter.ReturnCode filterKeyValue(Cell ignored)
                                             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

参数:

ignored - 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 ignored)
                             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

参数:

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

createFilterFromArguments

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

toByteArray

public byte[] toByteArray()

从类复制的说明: FilterBase

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

覆盖:

toByteArray 在类中 FilterBase

返回:

The filter serialized using pb

parseFrom

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

参数:

pbBytes - A pb serialized KeyOnlyFilter instance

返回:

An instance of KeyOnlyFilter made from bytes

抛出:

DeserializationException

另请参阅:

toByteArray()

equals

public boolean equals(Object obj)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object