Constructor Detail

• FirstKeyOnlyFilter

  public FirstKeyOnlyFilter()

Method Detail

• reset

  public void reset()

  Description copied from class: org.apache.hadoop.hbase.filter.FilterBase
  Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. Reset the state of the filter between rows. Concrete implementers can signal a failure condition in their code by throwing an IOException.

  Overrides:

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

• 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: 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)

• hasFoundKV

  protected boolean hasFoundKV()

  Returns:

  true if first KV has been found.

• setFoundKV

  protected void setFoundKV(boolean value)

  Parameters:

  value - update foundKV flag with value.

• 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 FirstKeyOnlyFilter parseFrom(byte[] pbBytes)
                                      throws org.apache.hadoop.hbase.exceptions.DeserializationException

  Parameters:

  pbBytes - A pb serialized FirstKeyOnlyFilter instance

  Returns:

  An instance of FirstKeyOnlyFilter made from bytes

  Throws:

  org.apache.hadoop.hbase.exceptions.DeserializationException

  See Also:

  toByteArray()