@InterfaceAudience.Public @InterfaceStability.Stable public class TimestampsFilter extends org.apache.hadoop.hbase.filter.FilterBase
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)
.
Filter.ReturnCode
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.
|
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.
|
boolean |
filterRowKey(Cell cell)
Filters a row based on the row key.
|
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) |
filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, reset, transformCell
isReversed, setReversed
public TimestampsFilter(List<Long> timestamps)
timestamps
- public List<Long> getTimestamps()
public long getMin()
public boolean filterRowKey(Cell cell) throws IOException
Filter
Filter.filterKeyValue(Cell)
below.
Concrete implementers can signal a failure condition in their code by throwing an
IOException
.filterRowKey
in class org.apache.hadoop.hbase.filter.FilterBase
cell
- The first cell coming in the new rowIOException
- in case an I/O or an filter specific failure needs to be signaled.public Filter.ReturnCode filterKeyValue(Cell v)
Filter
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
in class Filter
v
- the Cell in questionFilter.ReturnCode
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
org.apache.hadoop.hbase.filter.FilterBase
toByteArray
in class org.apache.hadoop.hbase.filter.FilterBase
public static TimestampsFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException
pbBytes
- A pb serialized TimestampsFilter
instanceTimestampsFilter
made from bytes
org.apache.hadoop.hbase.exceptions.DeserializationException
toByteArray()
public String toString()
org.apache.hadoop.hbase.filter.FilterBase
toString
in class org.apache.hadoop.hbase.filter.FilterBase
Copyright © 2007–2015 The Apache Software Foundation. All rights reserved.