@InterfaceAudience.Public @InterfaceStability.Stable public class PageFilter extends FilterBase
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.
Filter.ReturnCode
Constructor and Description |
---|
PageFilter(long pageSize)
Constructor that takes a maximum page size.
|
Modifier and Type | Method and Description |
---|---|
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(Cell) can inherit this implementation that
never filters a row. |
long |
getPageSize() |
boolean |
hasFilterRow()
Fitlers that never filter by modifying the returned List of Cells 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.
|
filterKeyValue, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, isFamilyEssential, reset, transform, transformCell
isReversed, setReversed
public PageFilter(long pageSize)
pageSize
- Maximum result size.public long getPageSize()
public boolean filterAllRemaining()
FilterBase
filterAllRemaining
in class FilterBase
public boolean filterRow()
FilterBase
FilterBase.filterKeyValue(Cell)
can inherit this implementation that
never filters a row.filterRow
in class FilterBase
public boolean hasFilterRow()
FilterBase
hasFilterRow
in class FilterBase
public 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
instancePageFilter
made from bytes
DeserializationException
toByteArray()
public String toString()
FilterBase
toString
in class FilterBase
Copyright © 2014 The Apache Software Foundation. All rights reserved.