Constructor Detail

• ColumnPaginationFilter

  public ColumnPaginationFilter(int limit,
                        int offset)

  Initializes filter with an integer offset and limit. The offset is arrived at scanning sequentially and skipping entries. @limit number of columns are then retrieved. If multiple column families are involved, the columns may be spread across them.

  Parameters:

  limit - Max number of columns to return.

  offset - The integer offset where to start pagination.

• ColumnPaginationFilter

  public ColumnPaginationFilter(int limit,
                        byte[] columnOffset)

  Initializes filter with a string/bookmark based offset and limit. The offset is arrived at, by seeking to it using scanner hints. If multiple column families are involved, pagination starts at the first column family which contains @columnOffset. Columns are then retrieved sequentially upto @limit number of columns which maybe spread across multiple column families, depending on how the scan is setup.

  Parameters:

  limit - Max number of columns to return.

  columnOffset - The string/bookmark offset on where to start pagination.

Method Detail

• getLimit

  public int getLimit()

  Returns:

  limit

• getOffset

  public int getOffset()

  Returns:

  offset

• getColumnOffset

  public byte[] getColumnOffset()

  Returns:

  columnOffset

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

• getNextCellHint

  public Cell getNextCellHint(Cell kv)

  Description copied from class: FilterBase
  Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell. If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the QueryMatcher would call this function to find out which key it must next seek to. Concrete implementers can signal a failure condition in their code by throwing an IOException.

  Overrides:

  getNextCellHint in class FilterBase

  Returns:

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

• 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

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

  Parameters:

  pbBytes - A pb serialized ColumnPaginationFilter instance

  Returns:

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