|
||||||||||
| 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.PageFilter
@InterfaceAudience.Public @InterfaceStability.Stable public class PageFilter
Implementation of Filter interface that limits results to a specific page size. It terminates scanning once the number of filter-passed rows is > the given page size.
Note that this filter cannot guarantee that the number of results returned to a client are <= page size. This is because the filter is applied separately on different region servers. It does however optimize the scan of individual HRegions by making sure that the page size is never exceeded locally.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter |
|---|
Filter.ReturnCode |
| Constructor Summary | |
|---|---|
PageFilter(long pageSize)
Constructor that takes a maximum page size. |
|
| Method Summary | |
|---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments)
|
boolean |
filterAllRemaining()
Filters that never filter all remaining can inherit this implementation that never stops the filter early. |
boolean |
filterRow()
Filters that never filter by rows based on previously gathered state from FilterBase.filterKeyValue(KeyValue) can inherit this implementation that
never filters a row. |
long |
getPageSize()
|
boolean |
hasFilterRow()
Fitlers that never filter by modifying the returned List of KeyValues can inherit this implementation that does nothing. |
static PageFilter |
parseFrom(byte[] pbBytes)
|
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 |
|---|
filterKeyValue, filterRow, filterRowKey, getNextKeyHint, isFamilyEssential, reset, transform |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public PageFilter(long pageSize)
pageSize - Maximum result size.| Method Detail |
|---|
public long getPageSize()
public boolean filterAllRemaining()
FilterBase
filterAllRemaining in class FilterBasepublic boolean filterRow()
FilterBaseFilterBase.filterKeyValue(KeyValue) can inherit this implementation that
never filters a row.
filterRow in class FilterBasepublic boolean hasFilterRow()
FilterBase
hasFilterRow in class FilterBasepublic static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
FilterBase
toByteArray in class FilterBase
public static PageFilter parseFrom(byte[] pbBytes)
throws DeserializationException
pbBytes - A pb serialized PageFilter instance
PageFilter made from bytes
DeserializationExceptiontoByteArray()public String toString()
FilterBase
toString in class FilterBase
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||