org.apache.hadoop.hbase.filter
Class TimestampsFilter

java.lang.Object
  extended by org.apache.hadoop.hbase.filter.Filter
      extended by org.apache.hadoop.hbase.filter.FilterBase
          extended by 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
TimestampsFilter(List<Long> timestamps)
          Constructor for filter that retains only those cells whose timestamp (version) is in the specified list of timestamps.
 
Method Summary
static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
           
 Filter.ReturnCode filterKeyValue(Cell v)
          Filters that dont filter by key value can inherit this implementation that includes all Cells.
 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)
           
 
Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase
filterAllRemaining, filterRow, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, reset, transform, transformCell
 
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: 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

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)


Copyright © 2007–2015 The Apache Software Foundation. All rights reserved.