Constructor Detail

• KeyOnlyFilter

  public KeyOnlyFilter()

• KeyOnlyFilter

  public KeyOnlyFilter(boolean lenAsVal)

Method Detail

• transformCell

  public Cell transformCell(Cell cell)

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

  Parameters:

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

• filterKeyValue

  public Filter.ReturnCode filterKeyValue(Cell ignored)
                                   throws IOException

  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:

  ignored - the Cell in question

  Returns:

  code as described below

  Throws:

  IOException - in case an I/O or an filter specific failure needs to be signaled.

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

  Parameters:

  pbBytes - A pb serialized KeyOnlyFilter instance

  Returns:

  An instance of KeyOnlyFilter made from bytes

  Throws:

  DeserializationException

  See Also:

  toByteArray()

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object