org.apache.hadoop.hbase.filter
Class ColumnPaginationFilter
java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.ColumnPaginationFilter
@InterfaceAudience.Public
@InterfaceStability.Stable
public class ColumnPaginationFilter
- extends FilterBase
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.
ColumnPaginationFilter
public ColumnPaginationFilter(int limit,
int offset)
getLimit
public int getLimit()
- Returns:
- limit
getOffset
public int getOffset()
- Returns:
- offset
filterKeyValue
public Filter.ReturnCode filterKeyValue(KeyValue v)
- Description copied from class:
FilterBase
- Filters that dont filter by key value can inherit this implementation that
includes all KeyValues.
- Overrides:
filterKeyValue
in class FilterBase
- Parameters:
v
- the KeyValue in question
- Returns:
- code as described below
- See Also:
Filter.ReturnCode
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.
- 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
Copyright © 2013 The Apache Software Foundation. All Rights Reserved.