|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.ColumnPaginationFilter
@InterfaceAudience.Public @InterfaceStability.Stable public class ColumnPaginationFilter
A filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset. This filter can be used for row-based indexing, where references to other tables are stored across many columns, in order to efficient lookups and paginated results for end users. Only most recent versions are considered for pagination.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter |
---|
Filter.ReturnCode |
Field Summary |
---|
Fields inherited from class org.apache.hadoop.hbase.filter.Filter |
---|
reversed |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments)
|
Filter.ReturnCode |
filterKeyValue(Cell v)
Filters that dont filter by key value can inherit this implementation that includes all Cells. |
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 |
String |
toString()
Return filter's info for debugging and logging purpose. |
Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase |
---|
filterAllRemaining, filterRow, filterRow, filterRowCells, filterRowKey, getNextKeyHint, hasFilterRow, isFamilyEssential, transform, transformCell |
Methods inherited from class org.apache.hadoop.hbase.filter.Filter |
---|
isReversed, setReversed |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
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.Method Detail |
---|
public int getLimit()
public int getOffset()
public byte[] getColumnOffset()
public Filter.ReturnCode filterKeyValue(Cell v)
org.apache.hadoop.hbase.filter.FilterBase
filterKeyValue
in class org.apache.hadoop.hbase.filter.FilterBase
v
- the Cell in question
Filter.ReturnCode
public Cell getNextCellHint(Cell kv)
org.apache.hadoop.hbase.filter.FilterBase
getNextCellHint
in class org.apache.hadoop.hbase.filter.FilterBase
public void reset()
org.apache.hadoop.hbase.filter.FilterBase
reset
in class org.apache.hadoop.hbase.filter.FilterBase
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
org.apache.hadoop.hbase.filter.FilterBase
toByteArray
in class org.apache.hadoop.hbase.filter.FilterBase
public static ColumnPaginationFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException
pbBytes
- A pb serialized ColumnPaginationFilter
instance
ColumnPaginationFilter
made from bytes
org.apache.hadoop.hbase.exceptions.DeserializationException
toByteArray()
public String toString()
org.apache.hadoop.hbase.filter.FilterBase
toString
in class org.apache.hadoop.hbase.filter.FilterBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |