@InterfaceAudience.Public public class ColumnPaginationFilter extends org.apache.hadoop.hbase.filter.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(ArrayList<byte[]> filterArguments) |
boolean |
equals(Object obj) |
Filter.ReturnCode |
filterCell(Cell c)
A way to filter based on the column family, column qualifier and/or the column value.
|
boolean |
filterRowKey(Cell cell)
Filters a row based on the row key.
|
byte[] |
getColumnOffset() |
int |
getLimit() |
Cell |
getNextCellHint(Cell cell)
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() |
int |
hashCode() |
static ColumnPaginationFilter |
parseFrom(byte[] pbBytes)
Parse a serialized representation of
ColumnPaginationFilter |
void |
reset()
Filters that are purely stateless and do nothing in their reset() methods can inherit this
null/empty implementation.
|
byte[] |
toByteArray()
Returns The filter serialized using pb
|
String |
toString()
Return filter's info for debugging and logging purpose.
|
filterAllRemaining, filterRow, filterRowCells, hasFilterRow, isFamilyEssential, transformCell
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 boolean filterRowKey(Cell cell) throws IOException
Filter
Filter.filterCell(Cell)
below. If
Filter.filterAllRemaining()
returns true, then Filter.filterRowKey(Cell)
should also return
true. Concrete implementers can signal a failure condition in their code by throwing an
IOException
.filterRowKey
in class org.apache.hadoop.hbase.filter.FilterBase
cell
- The first cell coming in the new rowIOException
- in case an I/O or an filter specific failure needs to be signaled.public Filter.ReturnCode filterCell(Cell c)
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
.filterCell
in class Filter
c
- the Cell in questionFilter.ReturnCode
public Cell getNextCellHint(Cell cell)
org.apache.hadoop.hbase.filter.FilterBase
IOException
.getNextCellHint
in class org.apache.hadoop.hbase.filter.FilterBase
public void reset()
org.apache.hadoop.hbase.filter.FilterBase
IOException
.reset
in class org.apache.hadoop.hbase.filter.FilterBase
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
toByteArray
in class org.apache.hadoop.hbase.filter.FilterBase
public static ColumnPaginationFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException
ColumnPaginationFilter
pbBytes
- A pb serialized ColumnPaginationFilter
instanceColumnPaginationFilter
made from bytes
org.apache.hadoop.hbase.exceptions.DeserializationException
- if an error occurredtoByteArray()
public String toString()
org.apache.hadoop.hbase.filter.FilterBase
toString
in class org.apache.hadoop.hbase.filter.FilterBase
Copyright © 2007–2020 The Apache Software Foundation. All rights reserved.