@InterfaceAudience.Public @InterfaceStability.Stable public class ColumnPaginationFilter extends FilterBase
Filter.ReturnCode
Constructor and Description |
---|
ColumnPaginationFilter(int limit,
byte[] columnOffset)
Initializes filter with a string/bookmark based offset and limit.
|
ColumnPaginationFilter(int limit,
int offset)
Initializes filter with an integer offset and limit.
|
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(java.util.ArrayList<byte[]> filterArguments) |
Filter.ReturnCode |
filterKeyValue(Cell v)
A way to filter based on the column family, column qualifier and/or the column value.
|
byte[] |
getColumnOffset() |
int |
getLimit() |
Cell |
getNextCellHint(Cell kv)
Filters that are not sure which key must be next seeked to, can inherit
this implementation that, by default, returns a null Cell.
|
int |
getOffset() |
static ColumnPaginationFilter |
parseFrom(byte[] pbBytes) |
void |
reset()
Filters that are purely stateless and do nothing in their reset() methods can inherit
this null/empty implementation.
|
byte[] |
toByteArray()
Return length 0 byte array for Filters that don't require special serialization
|
java.lang.String |
toString()
Return filter's info for debugging and logging purpose.
|
Cell |
transformCell(Cell v)
By default no transformation takes place
|
filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextKeyHint, hasFilterRow, isFamilyEssential, transform
isReversed, setReversed
public ColumnPaginationFilter(int limit, int offset)
limit
- Max number of columns to return.offset
- The integer offset where to start pagination.public ColumnPaginationFilter(int limit, byte[] columnOffset)
limit
- Max number of columns to return.columnOffset
- The string/bookmark offset on where to start pagination.public int getLimit()
public int getOffset()
public byte[] getColumnOffset()
public Filter.ReturnCode filterKeyValue(Cell v)
Filter
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
.filterKeyValue
in class Filter
v
- the Cell in questionFilter.ReturnCode
public Cell transformCell(Cell v)
FilterBase
transformCell
in class FilterBase
v
- the KeyValue in questionThe 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}.
public Cell getNextCellHint(Cell kv)
FilterBase
getNextCellHint
in class FilterBase
public void reset()
FilterBase
reset
in class FilterBase
public static Filter createFilterFromArguments(java.util.ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
FilterBase
toByteArray
in class FilterBase
public static ColumnPaginationFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes
- A pb serialized ColumnPaginationFilter
instanceColumnPaginationFilter
made from bytes
DeserializationException
toByteArray()
public java.lang.String toString()
FilterBase
toString
in class FilterBase