Constructor Detail

• TimestampsFilter

  public TimestampsFilter(List<Long> timestamps)

  Constructor for filter that retains only the specified timestamps in the list.

  Parameters:

  timestamps -

• TimestampsFilter

  public TimestampsFilter(List<Long> timestamps,
                  boolean canHint)

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

  Parameters:

  timestamps - list of timestamps that are wanted.

  canHint - should the filter provide a seek hint? This can skip past delete tombstones, so it should only be used when that is not an issue ( no deletes, or don't care if data becomes visible)

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

• getNextCellHint

  public Cell getNextCellHint(Cell currentCell)
                       throws IOException

  Pick the next cell that the scanner should seek to. Since this can skip any number of cells any of which can be a delete this can resurect old data. The method will only be used if canHint was set to true while creating the filter.

  Overrides:

  getNextCellHint in class org.apache.hadoop.hbase.filter.FilterBase

  Returns:

  KeyValue which must be next seeked. return null if the filter is not sure which key to seek to next.

  Throws:

  IOException - This will never happen.

• transformCell

  public Cell transformCell(Cell v)

  Description copied from class: org.apache.hadoop.hbase.filter.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.

  Overrides:

  transformCell in class org.apache.hadoop.hbase.filter.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: org.apache.hadoop.hbase.filter.FilterBase
  Return length 0 byte array for Filters that don't require special serialization

  Overrides:

  toByteArray in class org.apache.hadoop.hbase.filter.FilterBase

  Returns:

  The filter serialized using pb

• parseFrom

  public static TimestampsFilter parseFrom(byte[] pbBytes)
                                    throws org.apache.hadoop.hbase.exceptions.DeserializationException

  Parameters:

  pbBytes - A pb serialized TimestampsFilter instance

  Returns:

  An instance of TimestampsFilter made from bytes

  Throws:

  org.apache.hadoop.hbase.exceptions.DeserializationException

  See Also:

  toByteArray()

• toString

  public String toString()

  Description copied from class: org.apache.hadoop.hbase.filter.FilterBase
  Return filter's info for debugging and logging purpose.

  Overrides:

  toString in class org.apache.hadoop.hbase.filter.FilterBase

• toString

  protected String toString(int maxTimestamps)

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object