org.apache.hadoop.hbase.filter

Class TimestampsFilter

java.lang.Object

org.apache.hadoop.hbase.filter.Filter

org.apache.hadoop.hbase.filter.FilterBase

org.apache.hadoop.hbase.filter.TimestampsFilter

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

Filter that returns only cells whose timestamp (version) is in the specified list of timestamps (versions).

Note: Use of this filter overrides any time range/time stamp options specified using Get.setTimeRange(long, long), Scan.setTimeRange(long, long), Get.setTimeStamp(long), or Scan.setTimeStamp(long).

Nested Class Summary

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

Filter.ReturnCode

Field Summary

Fields inherited from class org.apache.hadoop.hbase.filter.Filter

reversed

Constructor Summary

Constructors

Constructor and Description
TimestampsFilter(List<Long> timestamps) Constructor for filter that retains only those cells whose timestamp (version) is in the specified list of timestamps.

Method Summary

Methods

Modifier and Type	Method and Description
static Filter	createFilterFromArguments(ArrayList<byte[]> filterArguments)
Filter.ReturnCode	filterKeyValue(Cell v) A way to filter based on the column family, column qualifier and/or the column value.
long	getMin() Gets the minimum timestamp requested by filter.
List<Long>	getTimestamps()
static TimestampsFilter	parseFrom(byte[] pbBytes)
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.
protected String	toString(int maxTimestamps)
Cell	transformCell(Cell v) By default no transformation takes place

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

filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, reset, transform

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

isReversed, setReversed

Methods inherited from class java.lang.Object

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

Constructor Detail

TimestampsFilter

public TimestampsFilter(List<Long> timestamps)

Constructor for filter that retains only those cells whose timestamp (version) is in the specified list of timestamps.

Parameters:

timestamps -

Method Detail

getTimestamps

public List<Long> getTimestamps()

Returns:

the list of timestamps

getMin

public long getMin()

Gets the minimum timestamp requested by filter.

Returns:

minimum timestamp requested by filter.

filterKeyValue

public Filter.ReturnCode filterKeyValue(Cell v)

Description copied from class: 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.

Specified by:

filterKeyValue in class Filter

Parameters:

v - the Cell in question

Returns:

code as described below

See Also:

Filter.ReturnCode

transformCell

public Cell transformCell(Cell v)

Description copied from class: FilterBase

By default no transformation takes place

Overrides:

transformCell in class FilterBase

Parameters:

v - the KeyValue in question

Returns:

the changed KeyValue

See Also:

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

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 TimestampsFilter parseFrom(byte[] pbBytes)
                                  throws DeserializationException

Parameters:

pbBytes - A pb serialized TimestampsFilter instance

Returns:

An instance of TimestampsFilter 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

toString

protected String toString(int maxTimestamps)