org.apache.hadoop.hbase.filter

Class ColumnCountGetFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.ColumnCountGetFilter

@InterfaceAudience.Public
@InterfaceStability.Stable
public class ColumnCountGetFilter
extends FilterBase

Simple filter that returns first N columns on row only. This filter was written to test filters in Get and as soon as it gets its quota of columns, filterAllRemaining() returns true. This makes this filter unsuitable as a Scan filter.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter

Filter.ReturnCode

Constructor Summary

Constructors

Constructor and Description
ColumnCountGetFilter(int n)

Method Summary

Methods

Modifier and Type	Method and Description
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
boolean	filterAllRemaining() Filters that never filter all remaining can inherit this implementation that never stops the filter early.
Filter.ReturnCode	filterKeyValue(Cell v) Filters that dont filter by key value can inherit this implementation that includes all Cells.
int	getLimit()
static ColumnCountGetFilter	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.

Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase

filterRow, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, transform, transformCell

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnCountGetFilter

public ColumnCountGetFilter(int n)

Method Detail

getLimit

public int getLimit()

filterAllRemaining

public boolean filterAllRemaining()

Description copied from class: FilterBase

Filters that never filter all remaining can inherit this implementation that never stops the filter early.

Overrides:

filterAllRemaining in class FilterBase

Returns:

true to end scan, false to continue.

filterKeyValue

public Filter.ReturnCode filterKeyValue(Cell v)

Description copied from class: FilterBase

Filters that dont filter by key value can inherit this implementation that includes all Cells.

Overrides:

filterKeyValue in class FilterBase

Parameters:

v - the Cell in question

Returns:

code as described below

See Also:

Filter.ReturnCode

reset

public void reset()

Description copied from class: FilterBase

Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.

Overrides:

reset in class FilterBase

createFilterFromArguments

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

toByteArray

public byte[] toByteArray()

Description copied from class: FilterBase

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

Overrides:

toByteArray in class FilterBase

Returns:

The filter serialized using pb

parseFrom

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

Parameters:

pbBytes - A pb serialized ColumnCountGetFilter instance

Returns:

An instance of ColumnCountGetFilter made from bytes

Throws:

DeserializationException

See Also:

toByteArray()

toString

public String toString()

Description copied from class: FilterBase

Return filter's info for debugging and logging purpose.

Overrides:

toString in class FilterBase