Field Detail

• prefix

  protected byte[] prefix

• passedPrefix

  protected boolean passedPrefix

• filterRow

  protected boolean filterRow

Constructor Detail

• PrefixFilter

  public PrefixFilter(byte[] prefix)

Method Detail

• getPrefix

  public byte[] getPrefix()

• filterRowKey

  public boolean filterRowKey(byte[] buffer,
                     int offset,
                     int length)

  Description copied from class: FilterBase
  Filters that do not filter by row key can inherit this implementation that never filters anything. (ie: returns false). Filters a row based on the row key. If this returns true, the entire row will be excluded. If false, each KeyValue in the row will be passed to Filter.filterKeyValue(Cell) below. Concrete implementers can signal a failure condition in their code by throwing an IOException.

  Overrides:

  filterRowKey in class FilterBase

  Parameters:

  buffer - buffer containing row key

  offset - offset into buffer where row key starts

  length - length of the row key

  Returns:

  true, remove entire row, false, include the row (maybe).

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

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

• filterRow

  public boolean filterRow()

  Description copied from class: FilterBase
  Filters that never filter by rows based on previously gathered state from Filter.filterKeyValue(Cell) can inherit this implementation that never filters a row. Last chance to veto row based on previous Filter.filterKeyValue(Cell) calls. The filter needs to retain state then return a particular value for this call if they wish to exclude a row if a certain column is missing (for example). Concrete implementers can signal a failure condition in their code by throwing an IOException.

  Overrides:

  filterRow in class FilterBase

  Returns:

  true to exclude row, false to include row.

• reset

  public void reset()

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

• filterAllRemaining

  public boolean filterAllRemaining()

  Description copied from class: FilterBase
  Filters that never filter all remaining can inherit this implementation that never stops the filter early. If this returns true, the scan will terminate. Concrete implementers can signal a failure condition in their code by throwing an IOException.

  Overrides:

  filterAllRemaining in class FilterBase

  Returns:

  true to end scan, false to continue.

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

  Parameters:

  pbBytes - A pb serialized PrefixFilter instance

  Returns:

  An instance of PrefixFilter 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

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object